Создание дополнительного поля

Запрос

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

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

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

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

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

Параметр	Тип данных	Обязательность	Описание
field_key	string	Required	Уникальный ключ поля
title	string	Required	Наименование дополнительного поля
field_type	string	Required	Тип данных, указываемый в дополнительном поле, например: - boolean; - json; - string; - integer; - double; - date.
order_direction	integer	Required	Порядок отображения дополнительного поля в карточке инцидента

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

{
"field_key": "string",
"title": "string",
"field_type": "string",
"order_direction": 0
}

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

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

Формат: JSON.

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

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "field_key": "string",
  "title": "string",
  "field_type": "string",
  "order_direction": 0,
  "custom_field_values": [
    {
      "custom_field_id": "a0fa4fc5-cabd-4219-9751-6d126c809065",
      "service_asset_finding_id": "08a5c673-3c5c-48ab-bf6c-f2ee47d8df88",
      "string_value": "string",
      "integer_value": 0,
      "float_value": 0,
      "date_value": "2023-12-20T00:00:01.652259Z",
      "json_value": {},
      "boolean_value": true
    }
  ],
  "_relations": {
    "custom_field_values": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }
}

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

Код	Ответ	Описание
400	Bad Request	Неверный тип параметра запроса, либо отсутствует обязательный параметр
409	name_already_used	Попытка создать объект с существующим уникальным атрибутом
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
}