Одно определение — HTTP 200
Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.
| Поле | Тип | Обязательно | null | Ограничения и смысл |
|---|---|---|---|---|
data |
объект | да | нет | — |
data.id |
целое число | да | нет | — |
data.name |
строка | да | нет | — |
data.code |
строка | да | нет | — |
data.entity |
строка | да | нет | Допустимо: "act", "customer", "equipment", "visit", "maintenance_schedule" |
data.scenario_id |
целое число / null | да | да | — |
data.type |
строка | да | нет | Допустимо: "text", "textarea", "richtext", "number", "select", "multiselect", "date", "datetime", "toggle", "url", "email", "money", "phone", "radio", "checkbox_list" |
data.is_required |
логическое значение | да | нет | — |
data.is_active |
логическое значение | да | нет | — |
data.show_in_table |
логическое значение | да | нет | — |
data.is_searchable |
логическое значение | да | нет | — |
data.sort_order |
целое число | да | нет | — |
data.section |
строка / null | да | да | — |
data.settings |
объект | да | нет | — |
data.settings.min |
строка | нет | нет | — |
data.settings.max |
строка | нет | нет | — |
data.settings.step |
строка | нет | нет | — |
data.settings.rows |
целое число | нет | нет | — |
data.version |
строка | да | нет | — |
data.updated_at |
строка / null | да | да | — |
meta |
объект | да | нет | — |
Пример формы ответа
Все значения демонстрационные. Идентификаторы связей и доступные ссылки определяет организация.
{
"data": {
"id": 101,
"name": "Плановый осмотр",
"code": "demo_inspection",
"entity": "act",
"scenario_id": null,
"type": "text",
"is_required": true,
"is_active": true,
"show_in_table": true,
"is_searchable": true,
"sort_order": 1,
"section": null,
"settings": {},
"version": "1793782800",
"updated_at": null
},
"meta": {}
}