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

Create an organization case

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

Create an organization case.

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. Как работают ключи.

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

companyIdstringОбязательныйThe organization's id.

Тело запроса

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

projectIdstring (uuid) | nullНеобязательный
caseTypestringОбязательный1–120 characters
keystring | nullНеобязательный1–512 characters
titlestringОбязательный1–500 characters
summarystring | nullНеобязательныйat most 8000 characters
statusstringНеобязательныйone of: "draft", "in_progress", "in_review", "approved", "done", "cancelled"
fieldsobjectНеобязательный
parentCaseIdstring (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)