Управление запуском сценария

Запускает сценарий пользователя по переданному идентификатору сценария.

Формат запроса

POST https://api.iot.yandex.net/v1.0/scenarios/{scenario_id}/actions

scenario_id

Идентификатор сценария пользователя.

Заголовки запроса

Заголовок

Описание

Обязательный

Authorization

Авторизационный токен oauth-приложения.

Да

Формат ответа

HTTP/1.1 200 OK

{
    "request_id": String,
    "status": "ok"
}

Параметр

Тип

Описание

Обязательный

request_id

String

Идентификатор запроса. Необходимо логировать для расследования инцидентов.

Да

status

String

Статус обработки запроса. Допустимые значения:

  • ok.

Да

HTTP/1.1 404 Not Found

{
    "request_id": String,
    "status": "error",
    "message": String
}

Параметр

Тип

Описание

Обязательный

request_id

String

Идентификатор запроса. Необходимо логировать для расследования инцидентов.

Да

status

String

Статус обработки запроса. Допустимые значения:

  • error.

Да

message

String

Сообщение об ошибке.

Нет

Коды ошибок

Пример

curl -i -X POST 'https://api.iot.yandex.net/v1.0/scenarios/scenario-id-1/actions' \
-H 'Authorization: Bearer 123qwe456a...'
HTTP/1.1 200 OK

{
    "request_id": "667b3e0f-47a8-4136-9211-b4ff59062315",
    "status": "ok"
}
HTTP/1.1 404 Not Found

{
    "request_id": "667b3e0f-47a8-4136-9211-b4ff59062315",
    "status": "error",
    "message": "Сценарий не найден"
}

Служба поддержки

Cтрока, выделяется кавычками, например "Hello world".

Идентификатор сценария пользователя.

Тип

String

Описание

Идентификатор запроса. Необходимо логировать для расследования инцидентов.

Обязательный

Да

Тип

String

Описание

Статус обработки запроса. Допустимые значения:

  • ok.

Обязательный

Да

Тип

String

Описание

Статус обработки запроса. Допустимые значения:

  • error.

Обязательный

Да

Тип

String

Описание

Сообщение об ошибке.

Обязательный

Нет