API - Сигналы

Внимание

Для выполнения запроса к API необходима дополнительная авторизация.

---

Используйте в запросе заголовок Authorization: Bearer <персональный токен>.

---

Где получить персональный токен?

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

POST /api/public/sm/v2/signals

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

Тело запроса

{
  "name": "string",
  "description": "string",
  "createdBy": "User", #User, Automaton
  "createdByScenario": {
    "id": 0
  },
  "labels": [
  {
   "key": "",
   "value": {
    "key1": "prop1",
    "key2": "prop2"
   }
  }
 ],
  "ownerWorkGroup": {
    "id": 0
  },
  "severity": 0,
  "configItemIds": [
    0
  ],
  "tags": [
    {
      "name": "string",
      "colorName": "string"
    }
  ],
  "events": [
    {
      "startEventId": 0,
      "type": "Opening",
      "body": "string"
    }
  ]
}

Коды ответов

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

---

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

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

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

Тело запроса

{
  "status": "Open", #Open, Closed 
  "configItems": [
    {
      "id": 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
  }
}

Коды ответов

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

---

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

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

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

Коды ответов

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

---

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

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

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

Тело запроса

{
  "ids": [
    0
  ],
  "configItemIds": [
    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"
        }
    }
  ]
}

Коды ответов

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

---

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

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

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

Тело запроса

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

Коды ответов

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

---

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

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

Тело запроса

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

Коды ответов

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

---

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

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

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

Тело запроса

[
  0
]
 

Коды ответов

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

---

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

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

Тело запроса

[
  0
]
 

Коды ответов

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

---

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

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

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

Тело запроса

[
  {
    "startEventId": 0,
    "type": "Opening", #Opening, Closing, Confirming
    "body": "string"
  }
]
 

Коды ответов

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

---

Приложение

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

{
  "id": 0,
  "name": "string",
  "description": "string",
  "ownerWorkGroup": {
    "id": 0,
    "name": "string"
  },
  "createdBy": "User",
  "createdByScenario": {
    "id": 0,
    "name": "string"
  },
  "labels": [
  {
   "key": "",
   "value": {
    "key1": "prop1",
    "key2": "prop2"
   }
  }
 ],
  "configItems": [
    {
      "id": 0,
      "name": "string",
      "type": "string",
      "state": "Unknown"
    }
  ],
  "tags": [
    {
      "name": "string",
      "colorName": "string"
    }
  ],
  "status": "Open",
  "severity": 0,
  "linkedEventsCount": 0,
  "createdAt": "2022-09-06T11:53:37.586Z",
  "closedAt": "2022-09-06T11:53:37.586Z"
}