Получение инцидента по ID

Запрос

Тип	Метод
GET	/service_asset_findings/{id}

Описание: при выполнении запроса будет возвращён инцидент с указанным идентификатором.

С помощью параметра relations можно управлять загрузкой связанных сущностей:

• если параметр relations не указан, загружаются все связи объекта;
• если параметр relations указан, но не содержит значений, связанные сущности не загружаются;
• если параметр relations содержит значения, в ответе загружаются только указанные связанные сущности.

Пример запроса

GET

http://127.0.0.1/cruddy/v2/service_asset_findings/{id}

Path-параметры запроса:

Параметр	Тип данных	Обязательность	Описание
id	string	Required	Идентификатор инцидента

Query-параметры запроса:

Параметр	Тип данных	Обязательность	Описание
relations	Array<string>	Optional	Перечень связанных сущностей, которые необходимо загрузить в ответе

Возможные значения relations:

• service_asset;
• finding;
• last_occurrence_entity;
• user;
• group;
• incident_group;
• occurrences;
• custom_field_value;
• comments;
• documents;
• messages;
• service_asset_finding_status_changes;
• service_asset_groups.

Например, чтобы получить инцидент вместе со связанным активом и типом инцидента, в relations необходимо передать:

[
  "service_asset",
  "finding"
]

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Тело ответа: модель найденного инцидента.

Значения связанных сущностей в ответе зависят от параметра relations:

• если relations не указан, загружаются все связи;
• если передан пустой список, связанные сущности не загружаются;
• если передан список связей, загружаются только указанные связанные сущности.

Другие возможные ответы

Код	Ответ	Описание
400	Bad Request	Неверный тип параметра запроса, отсутствует обязательный параметр, отсутствует Pgr-User-ID или указан некорректный формат Pgr-User-ID
401	Unauthorized	Невозможно аутентифицировать пользователя
404	Not Found	Инцидент с указанным идентификатором не найден
500	Internal Server Error	Другие ошибки при получении объекта

Возможные ошибки:

• 400 — "missing uid header" — отсутствует заголовок Pgr-User-ID;
• 400 — "Pgr-User-Id should be uuid format" — неверный формат Pgr-User-ID;
• 400 — "Bad Request" — неверный тип параметра запроса либо отсутствует обязательный параметр;
• 400 — "id is empty" — не передан параметр id;
• 401 — "can't get user info:" — невозможно аутентифицировать пользователя;
• 404 — "not found" — объект не найден;
• 500 — "Internal Server Error" — другие ошибки при получении объекта.

Примечание: Текст ошибки не фиксированный и может изменяться в зависимости от фактического ответа на запрос.

Пример ответа с кодом 400

{
  "error": "Bad Request",
  "error_code": 400
}

Пример ответа с кодом 401

{
  "error": "can't get user info:",
  "error_code": 401
}

Пример ответа с кодом 404

{
  "error": "not found",
  "error_code": 404
}

Пример ответа с кодом 500

{
  "error": "Internal Server Error",
  "error_code": 500
}