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

Write a compiled status card query

PUT/api/status-cards/{id}/query
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Write a compiled status card query.

Авторизация

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 status card's id.

Тело запроса

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

queriesarray<object>Обязательный
queries[].qanyНеобязательный
queries[].scopeanyНеобязательный
queries[].limitanyНеобязательный
queries[].offsetanyНеобязательный
queries[].statusanyНеобязательный
queries[].displayStatusanyНеобязательный
queries[].priorityanyНеобязательный
queries[].assigneeAgentIdanyНеобязательный
queries[].assigneeUserIdanyНеобязательный
queries[].projectIdanyНеобязательный
queries[].labelIdanyНеобязательный
queries[].updatedWithinanyНеобязательный
queries[].updatedAfteranyНеобязательный
queries[].sortanyНеобязательный
titlestringОбязательный1–300 characters
changeSummarystringОбязательный1–2000 characters
generationIssueIdstring (uuid)Обязательный

Ответы

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. Подробнее: ошибки и ограничения.

Status cards