Обновление маппинга

Запрос

Тип	Метод
PUT	/mappings/update

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

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

PUT
http://127.0.0.1/cruddy/v2/mappings/update

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

Параметр	Тип данных	Обязательность	Описание
id	string	Required	Идентификатор маппинга
field	string	Optional	Название поля
field_path	string	Optional	Путь поля
path	string	Optional	Путь поля в древовидной структуре (значение поля ‘field_path’, конвертированное в формат ltree)
type	string	Optional	Тип поля.. Допустимые значения: keyword, date. Тип date поддерживает все форматы времени, согласно стандарту ISO 8601.
extra	string	Optional
is_error	boolean	Optional	Флаг: используется ли поле в шаблоне события со статусом “Ошибка”
is_parsed	boolean	Optional	Флаг: используется ли поле в шаблоне события со статусом  “Разобрано”
is_normalized	boolean	Optional	Флаг: используется ли поле в шаблоне события со статусом “Нормализовано”
user_title	string	Optional	Название маппинга
user_description	string	Optional	Описание маппинга
created_at	string time	Optional	Дата создания
updated_at	string time	Optional	Дата изменения
trace_id	string	Required	Идентификатор трассировки действия пользователя для аудита

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

{
  "id": "uuid",
  "trace_id": "uuid",
  "name": "string",
  "create_incident": true,
  "assign_to_customer": true,
  "risk_level": 5.35,
  "asset_ip": "string",
  "asset_hostname": "string",
  "asset_fqdn": "string",
  "asset_mac": "string",
  "first_and_last_logs": false,
  "trim_logs": 1,
  "template": "string"
}

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

Статус код: 200 – успешное обновление информации о маппинге.

Формат: JSON.

Тело ответа: модель TermiteMapping.

Пример ответа

{
  "id": "uuid",
  "field": "string",
  "field_path": "string",
  "path": "string",
  "type": "group",
  "extra": "string",
  "is_error": true,
  "is_parsed": true,
  "is_normalized": true,
  "user_title": "string",
  "user_description": "string",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "trace_id": "uuid"
}

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

Код	Ответ	Описание
400	Bad Request name_already_used	Неверный тип параметра запроса, либо отсутствует обязательный параметр Попытка присвоить объекту существующее уникальное значение атрибута
404	Not Found	Редактируемый объект не найден в БД
422	Not allowed for ‘group’ type	Попытка изменить поле path или type с типом group
500	Internal Server Error	Другие ошибки при редактировании объекта

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

Пример ответа

   
Код 400
   

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



   
Код 404
   

{
  "error": "Not Found",
  "error_code": 404
}



   
Код 422
   

{
  "error": "Unprocessable Entity",
  "error_code": 422
}



   
Код 500
   

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