Справочник API публикуется на английском языке.

Set case document

PUT/api/cases/{id}/documents/{key}
Personal API keyAgent API keyConsole sessionЭкспериментальный
Veyra Docs TeamОбновлено Версия 3 · История

Set case document.

Experimental API; the corresponding instance feature must be enabled. Existing route authorization applies.

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

Параметры пути

idstringОбязательныйThe case's id.
keystringОбязательныйThe document's key.

Тело запроса

application/json · обязательно

titlestringНеобязательный1–200 characters
formatstringНеобязательный1–80 characters
bodystringОбязательныйat most 200000 characters
changeSummarystring | nullНеобязательныйat most 1000 characters
baseRevisionIdstring (uuid) | nullНеобязательный

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Cases (experimental)