Kaiten

[PMO] База знаний функциональности (интернет)

To Kaiten

Обработчики

Основные запросы

Получить список обработчиков

Запрос:

GET /api/v1/handlers

Ответ:

Массив всех обработчиков проекта

Получить информацию об одном обработчике

Запрос:

GET /api/v1/handlers/:id

Ответ:

Представление обработчика в формате JSON

Создать новый обработчик

В теле запроса на создание нового обработчика укажите его представление в формате JSON.

Обязательные поля:

  • name - имя нового обработчика;

  • userCode - код обработчика.

Запрос:

POST /api/v1/handlers

JSON
{ "name": "test-handler-01", "userCode": "function process(a, b) { return { sum: a + b } }"}

Ответ:

Представление обработчика в формате JSON

Изменить обработчик

В теле запроса на изменение существующего обработчика укажите поля, которые нужно обновить.

Запрос:

PATCH /api/v1/handlers/:id

JSON
{ "name": "test-handler-02", "description": "Handler for sensor"}

Ответ:

Представление обработчика в формате JSON с учетом измененных полей

Удалить обработчик

Запрос:

DELETE /api/v1/handlers/:id

Ответ:

Представление удаленного обработчика в формате JSON

Выполнение обработчиков на объектах

Важно: В запросах :id - идентификатор объекта, на котором нужно запустить обработчик, :handler - идентификатор запускаемого обработчика.

Запустить выполнение обработчика на объекте

Запрос:

POST /api/v1/objects/:id/handlers/:handler/start

Ответ:

Информация о статусе выполнения запроса

Остановить выполнение обработчика на объекте

Запрос:

POST /api/v1/objects/:id/handlers/:handler/stop

Ответ:

Информация о статусе выполнения запроса