Карточка — HTTP 200
Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.
| Поле | Тип | Обязательно | null | Ограничения и смысл |
|---|---|---|---|---|
data |
объект | да | нет | — |
data.id |
целое число | да | нет | — |
data.equipment_id |
целое число | да | нет | — |
data.title |
строка | да | нет | — |
data.description |
строка / null | да | да | — |
data.type |
строка | да | нет | — |
data.priority |
строка | да | нет | — |
data.trigger_type |
строка | да | нет | — |
data.schedule_mode |
строка / null | да | да | — |
data.calendar_interval_value |
целое число / null | да | да | — |
data.calendar_interval_unit |
строка / null | да | да | — |
data.usage_interval |
целое число / null | да | да | — |
data.usage_lead |
целое число | да | нет | — |
data.anchor_date |
строка / null | да | да | — |
data.calendar_pattern |
строка | да | нет | — |
data.week_days |
массив | да | нет | — |
data.week_days[] |
целое число | да | нет | — |
data.month_days |
массив | да | нет | — |
data.month_days[] |
целое число | да | нет | — |
data.workshop_id |
целое число / null | да | да | — |
data.scenario_defaults |
объект | да | нет | — |
data.scenario_defaults.{ключ} |
строка / логическое значение / массив / объект / null | нет | да | — |
data.scenario_defaults.{ключ} (вариант 3) |
массив | нет | нет | — |
data.scenario_defaults.{ключ} (вариант 3)[] |
строка | да | нет | — |
data.scenario_defaults.{ключ} (вариант 4) |
объект | нет | нет | — |
data.scenario_defaults.{ключ} (вариант 4).amount |
строка | да | нет | — |
data.scenario_defaults.{ключ} (вариант 4).currency |
строка | да | нет | — |
data.completion_window_value |
целое число / null | да | да | — |
data.completion_window_unit |
строка | да | нет | — |
data.assigned_user_id |
целое число / null | да | да | — |
data.scenario_id |
целое число / null | да | да | — |
data.service_contract_id |
целое число / null | да | да | — |
data.starts_on |
строка | да | нет | — |
data.ends_on |
строка / null | да | да | — |
data.generation_time |
строка / null | да | да | — |
data.lead_time_days |
целое число | да | нет | — |
data.next_due_date |
строка / null | да | да | — |
data.next_due_usage |
целое число / null | да | да | — |
data.next_cycle_number |
целое число | да | нет | — |
data.maintenance_regulation_id |
целое число / null | да | да | — |
data.regulation_overridden |
логическое значение | да | нет | — |
data.revision |
целое число | да | нет | — |
data.status |
строка | да | нет | — |
data.equipment_date_field |
строка / null | да | да | — |
data.links |
объект | да | нет | — |
data.links.edit |
строка / null | да | да | — |
data.links.portal |
строка / null | да | да | — |
data.links.public |
строка / null | да | да | — |
data.version |
строка | да | нет | — |
data.updated_at |
строка / null | да | да | — |
meta |
объект | да | нет | — |
Пример формы ответа
Все значения демонстрационные. Идентификаторы связей и доступные ссылки определяет организация.
{
"data": {
"id": 101,
"equipment_id": 101,
"title": "Плановый осмотр",
"description": null,
"type": "preventive",
"priority": "пример",
"trigger_type": "пример",
"schedule_mode": null,
"calendar_interval_value": null,
"calendar_interval_unit": null,
"usage_interval": null,
"usage_lead": 1,
"anchor_date": null,
"calendar_pattern": "пример",
"week_days": [],
"month_days": [],
"workshop_id": null,
"scenario_defaults": {},
"completion_window_value": null,
"completion_window_unit": "пример",
"assigned_user_id": null,
"scenario_id": null,
"service_contract_id": null,
"starts_on": "пример",
"ends_on": null,
"generation_time": null,
"lead_time_days": 1,
"next_due_date": null,
"next_due_usage": null,
"next_cycle_number": 1,
"maintenance_regulation_id": null,
"regulation_overridden": true,
"revision": 1,
"status": "active",
"equipment_date_field": null,
"links": {
"edit": null,
"portal": null,
"public": null
},
"version": "1793782800",
"updated_at": null
},
"meta": {}
}