Создание маппинга

Запрос

Тип	Метод
POST	/mappings/create

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

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

POST
http://127.0.0.1/cruddy/v2/mappings/create

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

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

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

{
  "field_path": "string",
  "type": "keyword",
  "extra": "string",
  "is_error": true,
  "is_parsed": true,
  "is_normalized": true,
  "user_title": "string",
  "user_description": "string",
  "trace_id": "uuid"
}

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

Статус код: 201 - успешное создание маппинга.

Формат: JSON.

Тело ответа: модель созданного маппинга.

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

{
  "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	Неверный тип параметра запроса, либо отсутствует обязательный параметр
409	name_already_used	Попытка создать маппинг с существующим field_path
500	Internal Server Error	Другие ошибки при создании объекта

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

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

Код 400

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

Код 409

{
  "error": "name_already_used",
  "error_code": 409,
  "extra": {
    "fields": [
      "name"
    ]
  }
}

Код 500

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