Создание — HTTP 201
Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.
| Поле | Тип | Обязательно | null | Ограничения и смысл |
|---|---|---|---|---|
data |
объект | да | нет | — |
data.id |
целое число | да | нет | — |
data.equipment_id |
целое число | нет | нет | — |
data.scenario_id |
целое число | нет | нет | — |
data.operation_id |
целое число / null | да | да | — |
data.description |
строка / null | да | да | — |
data.sort_order |
целое число | да | нет | — |
data.is_required |
логическое значение | да | нет | — |
data.is_active |
логическое значение | да | нет | — |
data.version |
строка | да | нет | — |
data.updated_at |
строка / 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,
"operation_id": null,
"description": null,
"sort_order": 1,
"is_required": true,
"is_active": true,
"version": "1793782800",
"updated_at": null
},
"meta": {
"operation_id": "ef62763b-87f9-4c90-83bb-e919f3c8e111",
"affected_resources": [
{
"type": "customers",
"id": 101,
"version": "1793782800",
"deleted": false
}
],
"warnings": []
}
}