Исход операции, её ресурсы и состояние — HTTP 200
Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.
| Поле | Тип | Обязательно | null | Ограничения и смысл |
|---|---|---|---|---|
data |
объект | да | нет | — |
data.id |
строка | да | нет | — |
data.state |
строка | да | нет | Допустимо: "processing", "succeeded", "failed", "needs_reconciliation" |
data.method |
строка | да | нет | — |
data.path |
строка | да | нет | — |
data.created_at |
строка / null | да | да | — |
data.completed_at |
строка / null | да | да | — |
data.resource_refs |
массив | да | нет | — |
data.resource_refs[] |
объект | да | нет | — |
data.resource_refs[].type |
строка | да | нет | — |
data.resource_refs[].id |
целое число / строка | да | нет | — |
data.resource_refs[].version |
строка / null | нет | да | — |
data.resource_refs[].deleted |
логическое значение | нет | нет | — |
data.error |
объект / null | да | да | — |
data.response_available |
логическое значение | да | нет | — |
data.http_status |
целое число / null | да | да | — |
data.response |
объект / null | да | да | — |
data.response.data |
объект | да | нет | — |
data.response.meta |
объект | да | нет | — |
data.items |
массив | нет | нет | — |
data.items[] |
объект | да | нет | — |
data.items[].type |
строка | да | нет | — |
data.items[].id |
целое число | да | нет | — |
data.items[].state |
строка | да | нет | — |
data.items[].error |
объект / null | да | да | — |
meta |
объект | да | нет | — |
Пример формы ответа
Все значения демонстрационные. Идентификаторы связей и доступные ссылки определяет организация.
{
"data": {
"id": "ef62763b-87f9-4c90-83bb-e919f3c8e111",
"state": "processing",
"method": "POST",
"path": "/api/v1/customers",
"created_at": null,
"completed_at": null,
"resource_refs": [
{
"type": "customers",
"id": 101
}
],
"error": null,
"response_available": false,
"http_status": null,
"response": null
},
"meta": {}
}