Документация LMS версия 0.1.0

Документация/Проект API/Сценарии (автоматизации)

Это проектная спецификация, а не работающее API: реализации ещё нет, адреса могут измениться.

Собрано из кода — руками не правится · источник: openapi.draft.json

Сценарии (автоматизации)

Операций в разделе: 12.

у 4 описание выведено из имени операции, у 2 описания пока нет вовсе. Спецификация написана каталогом путей, прозы для них там не было; выдумывать поведение мы не стали. Подробнее — Чего в справочнике ещё нет.

GET /v1/scenario-runs #

текущие и завершённые запуски

Параметры:

  • limit — сколько вернуть, 1…1000, по умолчанию 50
  • cursor — позиция продолжения из next_cursor
  • sort — сортировка, минус для убывания
  • expand — развернуть связи
  • fields — вернуть только эти поля
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X GET 'https://school.example.com/api/v1/scenario-runs' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Accept: application/json'

Коды ответа: 200, 401, 403, 429, 500, 503.

Чего здесь нет: состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

POST /v1/scenario-runs/{id}/stop #

Назначение пока не описано: из имени операции оно не следует, а в спецификации его нет. Описание пишется отдельно.

В пути: id

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X POST 'https://school.example.com/api/v1/scenario-runs/{id}/stop' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Вместо {…} подставьте идентификатор объекта — про их формат в разделе Формат.

Коды ответа: 201, 400, 401, 403, 404, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

GET /v1/scenario-runs/{id}/trace #

полный путь конкретного человека по графу

В пути: id

Параметры:

  • limit — сколько вернуть, 1…1000, по умолчанию 50
  • cursor — позиция продолжения из next_cursor
  • sort — сортировка, минус для убывания
  • expand — развернуть связи
  • fields — вернуть только эти поля
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X GET 'https://school.example.com/api/v1/scenario-runs/{id}/trace' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Accept: application/json'

Вместо {…} подставьте идентификатор объекта — про их формат в разделе Формат.

Коды ответа: 200, 401, 403, 404, 429, 500, 503.

Чего здесь нет: состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

GET /v1/scenarios #

Список сценариев школы. Фраза выведена из имени операции: в спецификации описания нет.

Параметры:

  • limit — сколько вернуть, 1…1000, по умолчанию 50
  • cursor — позиция продолжения из next_cursor
  • sort — сортировка, минус для убывания
  • expand — развернуть связи
  • fields — вернуть только эти поля
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X GET 'https://school.example.com/api/v1/scenarios' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Accept: application/json'

Коды ответа: 200, 401, 403, 429, 500, 503.

Чего здесь нет: состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

POST /v1/scenarios #

Создать сценарий. Фраза выведена из имени операции: в спецификации описания нет.

⚠️ Адрес предположительный. В спецификации он не написан прямо — он выведен из сокращённой записи каталога («POST, PATCH, DELETE»). Когда API будет реализовано, адрес может оказаться другим. Не закладывайтесь на него в коде.

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X POST 'https://school.example.com/api/v1/scenarios' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Коды ответа: 201, 400, 401, 403, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

DELETE /v1/scenarios/{id} #

Удалить сценарий. Фраза выведена из имени операции: в спецификации описания нет.

⚠️ Адрес предположительный. В спецификации он не написан прямо — он выведен из сокращённой записи каталога («POST, PATCH, DELETE»). Когда API будет реализовано, адрес может оказаться другим. Не закладывайтесь на него в коде.

В пути: id

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X DELETE 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Коды ответа: 200, 400, 401, 403, 404, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

PATCH /v1/scenarios/{id} #

Изменить сценарий. Фраза выведена из имени операции: в спецификации описания нет.

⚠️ Адрес предположительный. В спецификации он не написан прямо — он выведен из сокращённой записи каталога («POST, PATCH, DELETE»). Когда API будет реализовано, адрес может оказаться другим. Не закладывайтесь на него в коде.

В пути: id

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X PATCH 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Коды ответа: 200, 400, 401, 403, 404, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

POST /v1/scenarios/{id}/dry-run #

прогон на тестовом пользователе без побочных эффектов

В пути: id

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X POST 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C/dry-run' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Коды ответа: 201, 400, 401, 403, 404, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

POST /v1/scenarios/{id}/pause #

Назначение пока не описано: из имени операции оно не следует, а в спецификации его нет. Описание пишется отдельно.

В пути: id

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X POST 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C/pause' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Коды ответа: 201, 400, 401, 403, 404, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

POST /v1/scenarios/{id}/publish #

опубликовать версию

В пути: id

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X POST 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C/publish' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Коды ответа: 201, 400, 401, 403, 404, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

POST /v1/scenarios/{id}/run #

запустить для конкретного пользователя

В пути: id

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X POST 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C/run' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Коды ответа: 201, 400, 401, 403, 404, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

GET /v1/scenarios/{id}/stats #

счётчики по узлам: вошло, ждёт, отвалилось

В пути: id

Параметры:

  • limit — сколько вернуть, 1…1000, по умолчанию 50
  • cursor — позиция продолжения из next_cursor
  • sort — сортировка, минус для убывания
  • expand — развернуть связи
  • fields — вернуть только эти поля
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X GET 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C/stats' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Accept: application/json'

Коды ответа: 200, 401, 403, 404, 429, 500, 503.

Чего здесь нет: состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

Эта страница в Markdown