Текущее состояние и предложение — HTTP 200
Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.
| Поле | Тип | Обязательно | null | Ограничения и смысл |
|---|---|---|---|---|
data |
объект | да | нет | — |
data.id |
строка | да | нет | — |
data.date |
строка | да | нет | — |
data.workshop_id |
целое число | да | нет | — |
data.user_ids |
массив | да | нет | — |
data.user_ids[] |
целое число | да | нет | — |
data.visit_ids |
массив | да | нет | — |
data.visit_ids[] |
целое число | да | нет | — |
data.mode |
строка | да | нет | — |
data.work_start |
строка | да | нет | — |
data.work_end |
строка | да | нет | — |
data.return_to_workshop |
логическое значение | да | нет | — |
data.status |
строка | да | нет | — |
data.progress |
объект | да | нет | — |
data.progress.completed_steps |
целое число | да | нет | — |
data.progress.total_steps |
целое число | да | нет | — |
data.preview |
объект / null | да | да | — |
data.preview.moves |
массив | да | нет | — |
data.preview.moves[] |
объект | да | нет | — |
data.preview.moves[].visit_id |
целое число | да | нет | — |
data.preview.moves[].crew_user_ids |
массив | да | нет | — |
data.preview.moves[].crew_user_ids[] |
целое число | да | нет | — |
data.preview.moves[].starts_at |
строка | да | нет | — |
data.preview.moves[].ends_at |
строка | да | нет | — |
data.preview.unassigned_visit_ids |
массив | да | нет | — |
data.preview.unassigned_visit_ids[] |
целое число | да | нет | — |
data.version |
строка | да | нет | — |
data.source_version |
строка | да | нет | — |
data.operation_id |
строка | да | нет | — |
data.budget |
объект | да | нет | — |
data.budget.max_requests |
целое число | да | нет | — |
data.budget.max_matrix_pairs |
целое число | да | нет | — |
data.usage |
объект | да | нет | — |
data.usage.requests |
целое число | да | нет | — |
data.usage.matrix_pairs |
целое число | да | нет | — |
data.error |
объект / null | да | да | — |
data.error.code |
строка | да | нет | — |
data.error.message |
строка | да | нет | — |
meta |
объект | да | нет | — |
Пример формы ответа
Все значения демонстрационные. Идентификаторы связей и доступные ссылки определяет организация.
{
"data": {
"id": "ef62763b-87f9-4c90-83bb-e919f3c8e111",
"date": "пример",
"workshop_id": 101,
"user_ids": [],
"visit_ids": [],
"mode": "пример",
"work_start": "09:00",
"work_end": "18:00",
"return_to_workshop": true,
"status": "processing",
"progress": {
"completed_steps": 1,
"total_steps": 1
},
"preview": null,
"version": "1793782800",
"source_version": "1793782800",
"operation_id": "ef62763b-87f9-4c90-83bb-e919f3c8e111",
"budget": {
"max_requests": 1,
"max_matrix_pairs": 1
},
"usage": {
"requests": 1,
"matrix_pairs": 1
},
"error": null
},
"meta": {}
}