Выполнить переход в статус
Запрос позволяет перевести задачу в новый статус.
Формат запроса
Чтобы перевести задачу в новый статус, используйте HTTP-запрос с методом POST
. Если настройки перехода позволяют изменять параметры задачи, укажите их в теле запроса в формате JSON:
POST /v2/issues/<issue-id>/transitions/<transition-id>/_execute
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>
{
"<ключ1>":"<значение1>",
"<ключ2>":"<значение2>"
...
"comment":"<текст комментария>"
}
- <issue-id>
- Идентификатор или ключ задачи.
- <transition-id>
- Идентификатор перехода.
- Host
-
Адрес узла, предоставляющего API:
https://api.tracker.yandex.net
- Authorization
-
OAuth-токен в формате
OAuth <значение токена>
, например:OAuth 0c4181a7c2cf4521964a72ff57a34a07
- X-Org-ID
-
Идентификатор организации.
Параметр | Значение | Тип данных |
---|---|---|
<ключ> | Поле задачи, доступное для изменения при переходе. Список ключей: https://tracker.yandex.ru/admin/fields | Зависит от типа параметра. |
comment | Комментарий к задаче. | Строка. |
Параметр | Значение | Тип данных |
---|---|---|
<ключ> | Поле задачи, доступное для изменения при переходе. Список ключей: https://tracker.yandex.ru/admin/fields | Зависит от типа параметра. |
comment | Комментарий к задаче. | Строка. |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит JSON-массив со списком переходов, доступных для задачи в новом статусе.
[
{
"self" : "https://api.tracker.yandex.net/v2/issues/DESIGN-1/transitions/close",
"id" : "close",
"to" : {
"self" : "https://api.tracker.yandex.net/v2/statuses/3",
"id" : "3",
"key" : "closed",
"display" : "Closed"
},
"screen" : {
"self" : "https://api.tracker.yandex.net/v2/screens/50c85b17e4b04b38ef31a522",
"id" : "50c85b17e4b04b38ef31a522"
}
},
...
]
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на переход. | Строка. |
id | Идентификатор перехода. | Строка. |
to | Блок с информацией о статусе, в который можно перевести задачу. | Объект. |
screen | Блок с информацией об экране перехода. | Объект. |
Поля объекта to | ||
self | Ссылка на статус. | Строка. |
id | Идентификатор статуса. | Строка. |
key | Ключ статуса. | Строка. |
display | Отображаемое название статуса. | Строка. |
Поля объекта screen | ||
self | Ссылка на экран перехода. | Строка. |
id | Идентификатор экрана перехода. | Строка. |
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на переход. | Строка. |
id | Идентификатор перехода. | Строка. |
to | Блок с информацией о статусе, в который можно перевести задачу. | Объект. |
screen | Блок с информацией об экране перехода. | Объект. |
Поля объекта to | ||
self | Ссылка на статус. | Строка. |
id | Идентификатор статуса. | Строка. |
key | Ключ статуса. | Строка. |
display | Отображаемое название статуса. | Строка. |
Поля объекта screen | ||
self | Ссылка на экран перехода. | Строка. |
id | Идентификатор экрана перехода. | Строка. |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки.
HTTP-код ошибки | Описание ошибки |
---|---|
400 Bad Request | Один из параметров запроса имеет недопустимое значение или формат данных. |
403 Forbidden | У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен. |
404 Not Found | Запрашиваемый ресурс не найден. |
409 Conflict | Запрос не может быть выполнен по причине конфликта имен. |
422 Unprocessable Entity | Ошибка валидации JSON, запрос отклонен. |
500 Internal Server Error | Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время. |
503 Service Unavailable | Сервис API временно недоступен. |
HTTP-код ошибки | Описание ошибки |
---|---|
400 Bad Request | Один из параметров запроса имеет недопустимое значение или формат данных. |
403 Forbidden | У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен. |
404 Not Found | Запрашиваемый ресурс не найден. |
409 Conflict | Запрос не может быть выполнен по причине конфликта имен. |
422 Unprocessable Entity | Ошибка валидации JSON, запрос отклонен. |
500 Internal Server Error | Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время. |
503 Service Unavailable | Сервис API временно недоступен. |