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

Сценарии

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

GET /v1/scenarios/{id} #

граф целиком + кто внутри

В пути: id

Параметры:

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

Запрос:

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

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

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

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

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

включить или остановить

В пути: id

Параметры:

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

Запрос:

curl -X POST 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C/status' \
  -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}/test #

проверить на человеке: userId, real?

В пути: id

Параметры:

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

Запрос:

curl -X POST 'https://school.example.com/api/v1/scenarios/scn_01HQZX8XKQWU7C/test' \
  -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 в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

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