Создание — HTTP 201
Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.
| Поле | Тип | Обязательно | null | Ограничения и смысл |
|---|---|---|---|---|
data |
объект | да | нет | — |
data.id |
целое число | да | нет | — |
data.number |
строка / null | да | да | — |
data.title |
строка / null | да | да | — |
data.customer_id |
целое число / null | да | да | — |
data.customer_site_id |
целое число / null | да | да | — |
data.workshop_id |
целое число / null | да | да | — |
data.status |
строка | да | нет | Допустимо: "draft", "active", "suspended", "ended" |
data.billing_period |
строка | да | нет | Допустимо: "monthly", "quarterly", "yearly" |
data.reaction_hours |
целое число / null | да | да | — |
data.resolution_hours |
целое число / null | да | да | — |
data.start_date |
строка / null | да | да | — |
data.end_date |
строка / null | да | да | — |
data.equipment_ids |
массив | да | нет | — |
data.equipment_ids[] |
целое число | да | нет | — |
data.next_maintenance_date |
строка / null | да | да | — |
data.maintenance_interval_days |
целое число / null | да | да | — |
data.note |
строка / null | да | да | — |
data.version |
строка | да | нет | — |
data.updated_at |
строка / null | да | да | — |
data.fee |
объект | нет | нет | — |
data.fee.amount |
строка | да | нет | — |
data.fee.currency |
строка | да | нет | — |
data.discount_operations |
строка / null | нет | да | — |
data.discount_products |
строка / null | нет | да | — |
data.next_invoice_date |
строка / null | нет | да | — |
meta |
объект | да | нет | — |
meta.operation_id |
строка | да | нет | — |
meta.affected_resources |
массив | да | нет | — |
meta.affected_resources[] |
объект | да | нет | — |
meta.affected_resources[].type |
строка | да | нет | — |
meta.affected_resources[].id |
целое число / строка | да | нет | — |
meta.affected_resources[].version |
строка / null | да | да | — |
meta.affected_resources[].deleted |
логическое значение | да | нет | — |
meta.warnings |
массив | да | нет | — |
meta.warnings[] |
объект | да | нет | — |
meta.warnings[].code |
строка | да | нет | — |
meta.warnings[].message |
строка | да | нет | — |
meta.warnings[].resource_refs |
массив | да | нет | — |
meta.warnings[].resource_refs[] |
объект | да | нет | — |
meta.warnings[].resource_refs[].type |
строка | да | нет | — |
meta.warnings[].resource_refs[].id |
целое число / строка | да | нет | — |
Пример формы ответа
Все значения демонстрационные. Идентификаторы связей и доступные ссылки определяет организация.
{
"data": {
"id": 101,
"number": null,
"title": null,
"customer_id": null,
"customer_site_id": null,
"workshop_id": null,
"status": "draft",
"billing_period": "monthly",
"reaction_hours": null,
"resolution_hours": null,
"start_date": null,
"end_date": null,
"equipment_ids": [],
"next_maintenance_date": null,
"maintenance_interval_days": null,
"note": null,
"version": "1793782800",
"updated_at": null
},
"meta": {
"operation_id": "ef62763b-87f9-4c90-83bb-e919f3c8e111",
"affected_resources": [
{
"type": "customers",
"id": 101,
"version": "1793782800",
"deleted": false
}
],
"warnings": []
}
}