Получение дополнительного поля по ID

Запрос

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

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

Если не указан параметр relations то подгружаются все связи обьекта. Если параметр указан но не имеет значений - связи не подгружаются. Если параметр указан и содержит значения (поля модели хранящие связанные сущности) то они будут заполнены в ответе.

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

GET
http://127.0.0.1/cruddy/v2/custom_fields/{id}

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

Параметр	Описание
{id}	Идентификатор дополнительного поля

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

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

Формат: 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	id is empty	Не передан параметр “id”
404	not found	Объект не найден
500	Internal Server Error	Другие ошибки при получении объекта

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

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

   
Код 400
   

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



   
Код 404
   

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



   
Код 500
   

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