Выполнить переход в статус

Запрос позволяет перевести задачу в новый статус.

POST

https://api.tracker.yandex.net/v3/issues/<id_задачи>/transitions/<id_перехода>/_execute

Формат запроса

Перед выполнением запроса получите доступ к API.

Чтобы перевести задачу в новый статус, используйте HTTP-запрос с методом POST. Если настройки перехода позволяют изменять параметры задачи, укажите их в теле запроса в формате JSON:

POST /v3/issues/<id_задачи>/transitions/<id_перехода>/_execute
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "<ключ_1>":"<значение_1>",
  "<ключ_2>":"<значение_2>",
  ...
  "comment":"<текст_комментария>"
}
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • Используйте заголовок X-Org-ID, если к Трекеру привязана организация Яндекс 360 для бизнеса.

    • Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
<id_задачи> Идентификатор или ключ текущей задачи. Строка
<id_перехода> Идентификатор перехода. Строка
Параметры тела запроса

Обязательные параметры

Параметр Значение Тип данных
<ключ> Поле задачи, доступное для изменения при переходе. Список ключей: https://tracker.yandex.ru/admin/fields Зависит от типа параметра.
comment Комментарий к задаче. Строка

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит JSON-массив со списком переходов, доступных для задачи в новом статусе.

[ 
{
  "self": "https://api.tracker.yandex.net/v3/issues/DESIGN-1/transitions/close",
  "id" : "close",
  "to" : {
  "self": "https://api.tracker.yandex.net/v3/statuses/3",
    "id" : "3",
    "key" : "closed",
    "display" : "Closed"
  },
  "screen" : {
    "self": "https://api.tracker.yandex.net/v3/screens/50c85b17e4b04b38********",
    "id" : "50c85b17e4b04b38********"
  }
 },
 ...
]
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о переходе. Строка
id Идентификатор перехода. Строка
to Блок с информацией о статусе, в который можно перевести задачу. Объект
screen Блок с информацией об экране перехода. Объект

Поля объекта to

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о статусе. Строка
id Идентификатор статуса. Строка
key Ключ статуса. Строка
display Отображаемое название статуса. Строка

Поля объекта screen

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию об экране перехода. Строка
id Идентификатор экрана перехода. Строка

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
409
При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Получить переходы
Следующая
Получить историю изменений задачи