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

Create a task tree hold

POST/api/issues/{id}/tree-holds
Personal API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Create a task tree hold.

Board-only. An agent cannot pause, cancel or resume a task tree, and this denial is final for agents. A person pauses the parent task and all of its subtasks on the organization-prefixed task page /{prefix}/issues/{identifier}: More task actions, then Pause subtree. The person resumes it later on the same page with Resume subtree. Link that task page. Moving tasks to backlog or changing assignees is not a tree pause.

Авторизация

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.

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

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

Тело запроса

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

modestringОбязательныйone of: "pause", "resume", "cancel", "restore"
reasonstring | nullНеобязательный1–1000 characters
releasePolicyobject | nullНеобязательный
releasePolicy.strategystringНеобязательныйone of: "manual", "after_active_runs_finish"
releasePolicy.notestring | nullНеобязательный1–500 characters
metadataobject | 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. Подробнее: ошибки и ограничения.

Tasks