API - Сигналы
Внимание
Для выполнения запроса к API необходима дополнительная авторизация.
Используйте в запросе заголовок Authorization: Bearer <персональный токен>
.
Создание сигнала
POST /api/public/sm/v2/signals
Запрос возвращает модель созданного сигнала.
Тело запроса
{
"name": "string",
"description": "string",
"createdBy": "User",
"createdByScenario": {
"id": 0
},
"labels": [
{
"key": "",
"value": {
"key1": "prop1",
"key2": "prop2"
}
}
],
"ownerWorkGroup": {
"id": 0
},
"severity": 0,
"configItemIds": [
0
],
"configItemComponentIds": [
0
],
"configItemComponentName": "string",
"tags": [
{
"name": "string",
"colorName": "string"
}
],
"events": [
{
"startEventId": 0,
"type": "Opening",
"body": {}
}
]
}
Поля тела запроса
Название поля | Обязательное поле | Тип поля | Значение по умолчанию | Описание |
---|---|---|---|---|
name | д а | string | нет | Название сигнала |
description | нет | string | null | Описание сигнала |
createdBy | да | string | нет | Указывает кто создал сигнал (User - сигнал создан пользователем, Automaton - сигнал создан при помощи сценария автоматизации) |
createdByScenario.id | да (если createdBy = Automaton ) | integer | нет | Идентификатор сценария автоматизации |
labels | нет | object [] | null | Массив меток |
ownerWorkGroup.id | да | integer | нет | Идентификатор рабочей группы владельца сигнала |
severity | нет | integer | 6 | Критичность сигнала |
configItemIds | нет | integer [] | null | Список идентификаторов конфигурационных единиц |
configItemComponentIds | нет | integer [] | null | Список идентификаторов компонентов конфигурационных единиц |
configItemComponentName | нет | string | null | Название компонента КЕ |
tags | нет | object [] | null | Массив объектов тэгов |
events | нет | object [] | null | Массив объектов событий |
Коды ответов
Код ответа | Описание |
---|---|
201 | Сигнал успешно создан |
400 | Пустое тело запроса |
400 | Неверная модель данных в теле запроса |
401 | Не удалось выполнить авторизацию пользователя |
403 | Недостаточно прав для создания сигнала в рамках выбранной рабочей группы |
404 | Рабочая группа с идентификатором {id} не найдена |
415 | Неправильный тип входных данных. Требуется указать тип: application/json |
500 | Непредвиденная ошибка при обработке запроса |
Частично обновить сигнал
PATCH /api/public/sm/v2/signals/{id}
Запрос возвращает модель обновленного сигнала.