Массовое изменение статуса задач

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

POST

https://api.tracker.yandex.net/v3/bulkchange/_transition

Примечание

Чтобы узнать, какие переходы доступны для задачи, выполните запрос списка переходов. Для некоторых статусов (например, «Закрыт») в параметре value тела запроса должна быть указана резолюция.

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

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

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

POST /v3/bulkchange/_transition
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "transition": "start_progress",
  "issues": ["TEST-1","TEST-2","TEST-3"]
}
Заголовки
  • Host: адрес узла, предоставляющего API.

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

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

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

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

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

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

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

Параметры запроса

Дополнительные параметры

Параметр Описание Тип данных
notify Признак уведомления об изменении задачи:
  • true — пользователи, указанные в полях задачи, получат уведомления;
  • false — (по умолчанию) пользователи не получат уведомления.
Логический
Параметры тела запроса

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

Параметр Описание Тип данных
transition Идентификатор перехода. Строка
issues Идентификаторы задач, статус которых необходимо изменить. Строка

Дополнительные параметры

Параметр Описание Тип данных
values Параметры задач, которые будут изменены при смене статуса. Используйте параметры, доступные при редактировании задачи. Строка

Пример. Изменить статус нескольких задач.

  • Используется HTTP-метод POST.
  • Статус задач «TEST-1», «TEST-2», «TEST-3» меняется на «Закрыт» с резолюцией «Решен».
POST /v3/bulkchange/_transition
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"transition": "close",
"issues": ["TEST-1", "TEST-2", "TEST-3"],
"values": {
   "resolution": "fixed"
  }
}

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

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

Тело ответа содержит информацию об операции массового редактирования в формате JSON.

{
    "id": "1ab23cd4e5678901********",
    "self": "https://api.tracker.yandex.net/v3/bulkchange/1ab23cd4e5678901********",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/12********",
        "id": "username",
        "display": "Имя Фамилия"
    },
    "createdAt": "2020-12-15T11:52:53.665+0000",
    "status": "CREATED",
    "statusText": "Операция массового редактирования задач создана.",
    "executionChunkPercent": 0,
    "executionIssuePercent": 0
}
Параметры ответа
Параметр Описание Тип данных
id Идентификатор операции массового редактирования. Строка
self Адрес ресурса API, который содержит информацию о массовом редактировании. Строка
createdBy Объект с информацией об инициаторе массового редактирования. Объект
createdAt Дата и время создания операции массового редактирования. Строка
status Статус операции массового редактирования. Строка
statusText Описание статуса операции массового редактирования. Строка
executionChunkPercent Служебный параметр. Число
executionIssuePercent Служебный параметр. Число

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

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

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

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
422
Ошибка валидации JSON, запрос отклонен.