Версия: 9.0

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
  },
  "typeKey": "string",
  "severity": 0,
  "assigneeId": 0,
  "configItemIds": [0],
  "configItemComponentIds": [0],
  "configItemComponentName": "string",
  "tags": [
    {
      "name": "string",
      "colorName": "string"
    }
  ],
  "events": [
    {
      "startEventId": 0,
      "type": "Opening",
      "body": {}
    }
  ],
  "attachments": [
    {
      "name": "string",
      "type": "Image",
      "data": {},
      "createdAt": "2025-01-19T21:55:07.517Z"
    }
  ],
  "customFields": [
    {
      "key": "string",
      "values": [{}]
    }
  ]
}

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
name	+	`string`	нет	Название сигнала
description	-	`string`	`null`	Описание сигнала
createdBy	+	`string`	нет	Указывает кто создал сигнал (`User` - сигнал создан пользователем, `Automaton` - сигнал создан при помощи сценария автоматизации)
createdByScenario.id	+ *если `createdBy` = `Automaton`	`integer`	нет	Идентификатор сценария автоматизации
labels	-	`object []`	`null`	Массив меток
typeKey	-	`string`	`null`	Ключ сигнала
ownerWorkGroup.id	+	`integer`	нет	Идентификатор рабочей группы владельца сигнала
severity	-	`integer`	6	Критичность сигнала
configItemIds	-	`integer []`	`null`	Список идентификаторов конфигурационных единиц
configItemComponentIds	-	`integer []`	`null`	Список идентификаторов компонентов конфигурационных единиц
configItemComponentName	-	`string`	`null`	Название компонента КЕ
tags	-	`object []`	`null`	Массив объектов тегов
events	-	`object []`	`null`	Массив объектов событий

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
201	Сигнал успешно создан
400	Пустое тело запроса
400	Неверная модель данных в теле запроса
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для создания сигнала в рамках выбранной рабочей группы
404	Рабочая группа с идентификатором `{id}` не найдена
415	Неправильный тип входных данных. Требуется указать тип: `application/json`
500	Непредвиденная ошибка при обработке запроса

Пакетное создание сигналов

POST /api/public/sm/v2/signals/batch

Запрос создает несколько сигналов одновременно и возвращает список моделей созданных сигналов.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
fieldMask	-	`string[]`	`null`	Маска полей в ответе

Тело запроса

Массив объектов с полями, аналогичными созданию одиночного сигнала.

Коды ответов

Код ответа	Описание
200	Сигналы успешно созданы
400	Пустое тело запроса
400	Неверная модель данных в теле запроса
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для создания сигналов
415	Неправильный тип входных данных. Требуется указать тип: `application/json`
500	Непредвиденная ошибка при обработке запроса

Пакетное закрытие сигналов

DELETE /api/public/sm/v2/signals/batch

Запрос закрывает несколько сигналов одновременно.

Тело запроса

[1, 2, 3]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
`[]`	+	`integer []`	нет	Список идентификаторов сигналов

Коды ответов

Код ответа	Описание
200	Сигналы успешно закрыты
400	Неверная модель данных в теле запроса
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для закрытия сигналов
415	Неправильный тип входных данных. Требуется указать тип: `application/json`
500	Непредвиденная ошибка при обработке запроса

Частичное обновление сигнала

PATCH /api/public/sm/v2/signals/{id}

Запрос возвращает модель обновленного сигнала.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

{
  "status": "Open",
  "name": "string",
  "description": "string",
  "severity": 6,
  "configItems": [
    {
      "id": 0
    }
  ],
  "configItemComponents": [
    {
      "id": 0
    }
  ],
  "configItemComponentName": "string",
  "assigneeId": 0,
  "tags": [
    {
      "name": "string",
      "colorName": "string"
    }
  ],
  "labels": {
    "label_a_name": "label_value",
    "label_b_name": ["label_value_1", "label_value_2"],
    "label_c_name": null
  },
  "customFields": [
    {
      "key": "string",
      "values": [{}]
  }
  ]
}

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
status	-	`string`	`null`	Статус сигнала
configItems	-	`object []`	`null`	Список конфигурационных единиц
configItemComponents	-	`object []`	`null`	Список идентификаторов компонентов КЕ
configItemComponentName	-	`string`	`null`	Название компонента КЕ
tags	-	`object []`	`null`	Список тегов
labels	-	`object`	`null`	Метки сигнала
assigneeId	-	`integer`	`null`	Идентификатор ответственного
name	-	`string`	`null`	Название сигнала
description	-	`string`	`null`	Описание сигнала
severity	-	`integer`	`null`	Критичность сигнала
customFields	-	`object []`	`null`	Значения настраиваемых полей

В теле запроса должно быть передано хотя бы одно поле.

Коды ответов

Код ответа	Описание
400	Сигнал закрыт и не может быть обновлен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для обновления сигнала
404	Сигнал с идентификатором {id} не найден
500	Непредвиденная ошибка при обработке запроса

Пакетное частичное обновление сигналов

PATCH /api/public/sm/v2/signals/batch

Запрос обновляет несколько сигналов одновременно.

Тело запроса

Массив объектов, каждый из которых содержит id сигнала и поля для обновления (аналогично частичному обновлению сигнала).

Коды ответов

Код ответа	Описание
200	Сигналы успешно обновлены
400	Неверная модель данных в теле запроса
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для обновления сигналов
415	Неправильный тип входных данных. Требуется указать тип: `application/json`
500	Непредвиденная ошибка при обработке запроса

Получение информации о сигнале

GET /api/public/sm/v2/signals/{id}

Запрос возвращает модель запрашиваемого сигнала.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
400	Недопустимое значение идентификатора сигнала
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для просмотра сигнала
404	Сигнал с идентификатором `{id}` не найден
500	Непредвиденная ошибка при обработке запроса

Получение сигналов по фильтру

POST /api/public/sm/v2/signals/filter

Запрос возвращает список моделей найденных сигналов.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
SortCol	-	`string`	`null`	Поле сортировки
SortDir	-	`string`	`null`	Направление сортировки (asc/desc)
Page	-	`integer`	`null`	Номер страницы
Skip	-	`integer`	`null`	Количество записей, которое требуется пропустить
Search	-	`string`	`null`	Строка поиска
PerPage	-	`integer`	`null`	Количество записей на одну страницу. Если `-1` - все записи
Shared	-	`boolean`	`false`	Включение в поиск общих сигналов
fieldMask	-	`string[]`	`null`	Маска полей в ответе

Тело запроса

{
  "ids": [
    0
  ],
  "configItemIds": [
    0
  ],
  "configItemComponentIds": [
    0
  ],
  "createdAt": {
    "moreThan": "2022-09-06T11:37:38.045Z",
    "lessThan": "2022-09-06T11:37:38.045Z",
    "equal": "2022-09-06T11:37:38.045Z",
    "lessThanOrEqual": "2022-09-06T11:37:38.045Z",
    "moreThanOrEqual": "2022-09-06T11:37:38.045Z",
    "range": {
      "start": "2022-09-06T11:37:38.045Z",
      "end": "2022-09-06T11:37:38.045Z"
    }
  },
  "closedAt": {
    "moreThan": "2022-09-06T11:37:38.045Z",
    "lessThan": "2022-09-06T11:37:38.045Z",
    "equal": "2022-09-06T11:37:38.045Z",
    "lessThanOrEqual": "2022-09-06T11:37:38.045Z",
    "moreThanOrEqual": "2022-09-06T11:37:38.045Z",
    "range": {
      "start": "2022-09-06T11:37:38.045Z",
      "end": "2022-09-06T11:37:38.045Z"
    }
  },
  "statuses": [
    "Open" #Open, Closed
  ],
  "severities": [
    0
  ],
  "durationMilliseconds": {
    "moreThan": 0,
    "lessThan": 0,
    "equal": 0,
    "lessThanOrEqual": 0,
    "moreThanOrEqual": 0,
    "range": {
      "start": 0,
      "end": 0
    }
  },
  "ownerWorkGroupIds": [
    0
  ],
  "tags": [
    {
      "name": "string",
      "colorName": "string"
    }
  ],
  "severityDurations": [
    {
      "severity": 0,
      "durationMilliseconds": {
        "moreThan": 0,
        "lessThan": 0,
        "equal": 0,
        "lessThanOrEqual": 0,
        "moreThanOrEqual": 0,
        "range": {
          "start": 0,
          "end": 0
        }
      }
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": {
           "key":"value"
        }
    }
  ],
  "lastEventLinkedAt": {
    "moreThan": "2025-01-20T09:18:55.757Z",
    "lessThan": "2025-01-20T09:18:55.757Z",
    "equal": "2025-01-20T09:18:55.757Z",
    "lessThanOrEqual": "2025-01-20T09:18:55.757Z",
    "moreThanOrEqual": "2025-01-20T09:18:55.757Z",
    "range": {
      "start": "2025-01-20T09:18:55.757Z",
      "end": "2025-01-20T09:18:55.757Z"
    }
  },
  "rsmMapIds": [
    0
  ],
  "lifeCycleStatus": {
    "ids": [
      0
    ],
    "names": [
      "string"
    ],
    "categories": [
      "Open"
    ]
  },
  "type": {
    "names": [
      "string"
    ],
    "keys": [
      "string"
    ]
  },
  "customFields": [
    {
      "key": "string",
      "values": [
        {}
      ],
      "filterType": "Unknown"
    }
  ],
  "assigneeIds": [
    0
  ],
  "mqlQuery": "string"
}

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
ids	-	`integer []`	`null`	Идентификаторы сигнала
configItemIds	-	`integer []`	`null`	Связанные конфигурационные единицы
configItemComponentIds	-	`integer []`	`null`	Идентификаторы компонентов КЕ
createdAt	-	`object`	`null`	Дата и время создания сигнала
closedAt	-	`object`	`null`	Дата и время закрытия сигнала
statuses	-	`string []`	`null`	Статусы сигнала
severities	-	`integer []`	`null`	Критичность сигнала
durationMilliseconds	-	`object`	`null`	Длительность сигнала
ownerWorkGroupIds	-	`integer []`	`null`	Идентификаторы рабочей группы которой принадлежит сигнал
tags	-	`object []`	`null`	Теги сигнала
severityDurations	-	`object []`	`null`	Список объектов - пар критичность:длительность
labels	-	`object []`	`null`	Метки сигнала
lastEventLinkedAt	-	`object`	`null`	Дата и время последнего прикрепленного события
rsmMapIds	-	`integer []`	`null`	Идентификаторы карт РСМ
lifeCycleStatus	-	`object`	`null`	Статус жизненного цикла сигнала
type	-	`object`	`null`	Тип сигнала
customFields	-	`object []`	`null`	Настраиваемые поля (атрибуты) сигнала
assigneeIds	-	`integer []`	`null`	Идентификаторы ответственных
mqlQuery	-	`string`	`null`	Запрос поиска в формате MQL

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
500	Непредвиденная ошибка при обработке запроса

Получение архивных сигналов по фильтру

POST /api/public/sm/v2/archive-signals/filter

Запрос возвращает список архивных сигналов, соответствующих условиям фильтра.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
page	-	`integer`	`null`	Номер страницы
perPage	-	`integer`	`null`	Количество записей на одну страницу. Если `-1` - все записи
search	-	`string`	`null`	Строка поиска
sortCol	-	`string`	`null`	Поле сортировки
sortDir	-	`string`	`null`	Направление сортировки (asc/desc)
skip	-	`integer`	`null`	Количество записей, которое требуется пропустить
fieldMask	-	`string[]`	`null`	Маска полей в ответе

Тело запроса

{
  "mqlQuery": "string"
}

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
mqlQuery	-	`string`	`null`	Запрос поиска в формате MQL

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
500	Непредвиденная ошибка при обработке запроса

Получение комментариев по фильтру

POST /api/public/sm/v2/signals/comments/filter

Запрос возвращает список комментариев сигналов, соответствующих условиям фильтра.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
page	-	`integer`	`null`	Номер страницы
perPage	-	`integer`	`null`	Количество записей на одну страницу
sortCol	-	`string`	`null`	Поле сортировки
sortDir	-	`string`	`null`	Направление сортировки (asc/desc)
fieldMask	-	`string[]`	`null`	Маска полей в ответе

Тело запроса

{
  "signalIds": [0]
}

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
signalIds	-	`integer []`	`null`	Список идентификаторов сигналов

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
500	Непредвиденная ошибка при обработке запроса

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

POST /api/public/sm/v2/signals/{id}/tags

Запрос возвращает список привязанных тегов.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

[
  {
    "name": "string",
    "colorName": "string"
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
name	+	`string`	нет	Наименование тега
colorName	+	`string`	нет	Цвет тега

Доступные цвета: pink, violet, indigo, blue, teal, green, orange, brown, slate

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для привязки тегов к сигналу
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

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

POST /api/public/sm/v2/signals/tags/batch

Привязывает список тегов к нескольким сигналам одновременно.

Тело запроса

[
  {
    "id": 0,
    "tags": [
      {
        "name": "string",
        "colorName": "string"
      }
    ]
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	-	`integer`	`null`	Идентификатор сигнала
tags	-	`object []`	`null`	Список тегов

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для привязки тегов к сигналам
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Отвязать список тегов от сигнала

DELETE /api/public/sm/v2/signals/{id}/tags

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

[
  {
    "name": "string",
    "colorName": "string"
  }
]

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для отвязки тегов от сигнала
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Пакетно отвязать список тегов от сигналов

DELETE /api/public/sm/v2/signals/tags/batch

Отвязывает список тегов от нескольких сигналов одновременно.

Тело запроса

[
  {
    "id": 0,
    "tags": [
      {
        "name": "string",
        "colorName": "string"
      }
    ]
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	-	`integer`	`null`	Идентификатор сигнала
tags	-	`object []`	`null`	Список тегов

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для отвязки тегов от сигналов
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Привязать список КЕ к сигналу

POST /api/public/sm/v2/signals/{id}/config-items

Запрос возвращает список привязанных КЕ к сигналу.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

[12345, 67890]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
`[]`	-	`integer []`	`[]`	Список идентификаторов КЕ

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для привязки КЕ к сигналу
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Пакетно привязать список КЕ к сигналам

POST /api/public/sm/v2/signals/config-items/batch

Привязывает список конфигурационных единиц к нескольким сигналам одновременно.

Тело запроса

[
  {
    "id": 0,
    "configItemIds": [0],
    "configItemComponentIds": [0],
    "configItemComponentName": "string"
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	-	`integer`	`null`	Идентификатор сигнала
configItemIds	-	`integer []`	`null`	Список идентификаторов КЕ
configItemComponentIds	-	`integer []`	`null`	Список идентификаторов компонентов КЕ
configItemComponentName	-	`string`	`null`	Имя компонента КЕ

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для привязки КЕ к сигналам
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Отвязать список КЕ от сигнала

DELETE /api/public/sm/v2/signals/{id}/config-items

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

[0]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
`[]`	-	`integer []`	`[]`	Список идентификаторов КЕ

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для привязки КЕ к сигналу
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Пакетно отвязать список КЕ от сигналов

DELETE /api/public/sm/v2/signals/config-items/batch

Отвязывает список конфигурационных единиц от нескольких сигналов одновременно.

Тело запроса

[
  {
    "id": 0,
    "configItemIds": [0],
    "configItemComponentIds": [0],
    "configItemComponentName": "string"
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	-	`integer`	`null`	Идентификатор сигнала
configItemIds	-	`integer []`	`null`	Список идентификаторов КЕ
configItemComponentIds	-	`integer []`	`null`	Список идентификаторов компонентов КЕ
configItemComponentName	-	`string`	`null`	Имя компонента КЕ

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для отвязки КЕ от сигналов
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

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

POST /api/public/sm/v2/signals/{id}/attachments

Запрос привязывает вложения к сигналу.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала
makeNameUnique	-	`boolean`	`false`	Сделать имя уникальным, добавив суффикс при совпадении имени

Тело запроса

[
  {
    "name": "string",
    "type": "Image",
    "data": {},
    "createdAt": "2025-12-25T00:00:00.000Z"
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
name	-	`string`	`null`	Название вложения
type	-	`string`	`null`	Тип вложения (`Image`, `ImageLink`, `Link`, `Bp`)
data	-	`object`	`null`	Данные вложения
createdAt	-	`datetime`	`null`	Дата создания вложения

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для привязки вложений к сигналу
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Отвязать вложения от сигнала

DELETE /api/public/sm/v2/signals/{id}/attachments

Запрос отвязывает вложения от сигнала.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

[
  {
    "name": "string",
    "type": "Image"
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
name	-	`string`	`null`	Название вложения
type	-	`string`	`null`	Тип вложения (`Image`, `ImageLink`, `Link`, `Bp`)

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для отвязки вложений от сигнала
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Привязать компоненты КЕ к сигналу

POST /api/public/sm/v2/signals/{id}/config-items/components

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

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

{
  "configItemIds": [0],
  "configItemComponentIds": [0],
  "configItemComponentName": "string"
}

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
configItemIds	-	`integer []`	`null`	Список идентификаторов КЕ
configItemComponentIds	-	`integer []`	`null`	Список идентификаторов компонентов КЕ
configItemComponentName	-	`string`	`null`	Имя компонента КЕ

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для привязки компонентов к сигналу
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Отвязать компоненты КЕ от сигнала

DELETE /api/public/sm/v2/signals/{id}/config-items/components

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

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

{
  "configItemIds": [0],
  "configItemComponentIds": [0],
  "configItemComponentName": "string"
}

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
configItemIds	-	`integer []`	`null`	Список идентификаторов КЕ
configItemComponentIds	-	`integer []`	`null`	Список идентификаторов компонентов КЕ
configItemComponentName	-	`string`	`null`	Имя компонента КЕ

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для отвязки компонентов от сигнала
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Привязать список событий к сигналу

POST /api/public/sm/v2/signals/{id}/events

Запрос привязывает события к сигналу.

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	+	`integer`	нет	Идентификатор сигнала

Тело запроса

[
  {
    "startEventId": 0,
    "type": "Opening",
    "body": {}
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
startEventId	+	`integer`	нет	Идентификатор стартового события
type	+	`string`	нет	Тип события
body	+	`object`	нет	Объект события в формате JSON

Типы событий:

Opening - открывающее событие
Closing - закрывающее событие
Confirming - подтверждающее событие

Коды ответов

Код ответа	Описание
200	Запрос успешно исполнен
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для привязки событий к сигналу
404	Сигнал с идентификатором {id} не найден
415	Неправильный тип входных данных. Требуется указать тип: application/json
500	Непредвиденная ошибка при обработке запроса

Модель сигнала

{
  "Id": 28203,
  "Name": "Тестовый сигнал через API",
  "Description": null,
  "OwnerWorkGroup": {
    "Id": 23,
    "Name": "General"
  },
  "CreatedBy": "User",
  "CreatedByScenario": null,
  "Labels": {},
  "ConfigItems": [],
  "Tags": [],
  "Status": "Open",
  "Severity": 6,
  "LastEvent": null,
  "LinkedEventsCount": 0,
  "CreatedAt": "2024-12-10T15:22:06.338296+00:00",
  "ClosedAt": "0001-01-01T00:00:00+00:00",
  "CustomFields": [],
  "AssigneeId": 90206,
  "Type": {
    "Name": "Signal",
    "Key": "signal"
  }
}

Создание сигнала​

Тело запроса​

Поля тела запроса​

Коды ответов​

Пакетное создание сигналов​

Параметры запроса​

Тело запроса​

Коды ответов​

Пакетное закрытие сигналов​

Тело запроса​

Поля тела запроса​

Коды ответов​

Частичное обновление сигнала​

Параметры запроса​

Тело запроса​

Поля тела запроса​

Коды ответов​

Пакетное частичное обновление сигналов​

Тело запроса​

Коды ответов​

Получение информации о сигнале​

Параметры запроса​

Коды ответов​

Получение сигналов по фильтру​

Параметры запроса​

Тело запроса​

Поля тела запроса​

Коды ответов​

Получение архивных сигналов по фильтру​

Параметры запроса​

Тело запроса​

Поля тела запроса​

Коды ответов​

Получение комментариев по фильтру​

Параметры запроса​

Тело запроса​

Поля тела запроса​

Коды ответов​

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

Параметры запроса​

Тело запроса​

Поля тела запроса​

Коды ответов​

Пакетно привязать список тегов к сигналам​

Тело запроса​

Поля тела запроса​

Коды ответов​

Отвязать список тегов от сигнала​

Параметры запроса​

Тело запроса​

Коды ответов​

Пакетно отвязать список тегов от сигналов​

Тело запроса​

Поля тела запроса​

Коды ответов​

Привязать список КЕ к сигналу​

Параметры запроса​

Тело запроса​

Поля тела запроса​

Коды ответов​

Пакетно привязать список КЕ к сигналам​

Тело запроса​

Поля тела запроса​

Коды ответов​

Отвязать список КЕ от сигнала​

Параметры запроса​

Тело запроса​

Поля тела запроса​

Коды ответов​

Пакетно отвязать список КЕ от сигналов​

Тело запроса​

Поля тела запроса​

Коды ответов​

Привязать вложения к сигналу​

Параметры запроса​

Тело запроса​

Поля тела запроса​

Коды ответов​

Отвязать вложения от сигнала​

Параметры запроса​

Создание сигнала

Тело запроса

Поля тела запроса

Коды ответов

Пакетное создание сигналов

Параметры запроса

Тело запроса

Коды ответов

Пакетное закрытие сигналов

Тело запроса

Поля тела запроса

Коды ответов

Частичное обновление сигнала

Параметры запроса

Тело запроса

Поля тела запроса

Коды ответов

Пакетное частичное обновление сигналов

Тело запроса

Коды ответов

Получение информации о сигнале

Параметры запроса

Коды ответов

Получение сигналов по фильтру

Параметры запроса

Тело запроса

Поля тела запроса

Коды ответов

Получение архивных сигналов по фильтру

Параметры запроса

Тело запроса

Поля тела запроса

Коды ответов

Получение комментариев по фильтру

Параметры запроса

Тело запроса

Поля тела запроса

Коды ответов

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

Параметры запроса

Тело запроса

Поля тела запроса

Коды ответов

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

Тело запроса

Поля тела запроса

Коды ответов

Отвязать список тегов от сигнала

Параметры запроса

Тело запроса

Коды ответов

Пакетно отвязать список тегов от сигналов

Тело запроса

Поля тела запроса

Коды ответов

Привязать список КЕ к сигналу

Параметры запроса

Тело запроса

Поля тела запроса

Коды ответов

Пакетно привязать список КЕ к сигналам

Тело запроса

Поля тела запроса

Коды ответов

Отвязать список КЕ от сигнала

Параметры запроса

Тело запроса

Поля тела запроса

Коды ответов

Пакетно отвязать список КЕ от сигналов

Тело запроса

Поля тела запроса

Коды ответов

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

Параметры запроса

Тело запроса

Поля тела запроса

Коды ответов

Отвязать вложения от сигнала

Параметры запроса