Перейти к содержанию

Группировка инцидентов

Запрос

Тип Метод
POST /service_asset_findings/group

Описание: при выполнении запроса инциденты будут сгруппированы по заданному полю.

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

POST

http://127.0.0.1/cruddy/v2/service_asset_findings/group

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

Параметр Тип данных Обязательность Описание
group_field string Required Поле для группировки инцидентов
Пример тела запроса

{
  "group_field": "string"
}

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

Статус код: 200 — успешный ответ.

Формат: JSON.

Параметры ответа:

Параметр Тип данных Описание
items Array<object> Список объектов, сгруппированных по указанному полю
items[].value string Значение поля
items[].count integer Количество повторений значения
Пример ответа

{
  "items": [
    {
      "value": "string",
      "count": 1
    }
  ]
}

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

Код Ответ Описание
400 Bad Request Неверный тип параметра запроса, отсутствует обязательный параметр, отсутствует Pgr-User-ID или указан некорректный формат Pgr-User-ID
401 Unauthorized Невозможно аутентифицировать пользователя
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" — неверный тип параметра запроса либо отсутствует обязательный параметр;
  • 401"can't get user info:" — невозможно аутентифицировать пользователя;
  • 500"Internal Server Error" — ошибка сопоставления поля группировки с моделью группируемых объектов или другие ошибки сервера.

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

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

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

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

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

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

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