Массовое изменение статуса задач
Запрос позволяет выполнить переход в новый статус для нескольких задач одновременно.
Примечание
Чтобы узнать, какие переходы доступны для задачи, выполните запрос списка переходов. Для некоторых статусов (например, Закрыт
) в параметре value
тела запроса должна быть указана резолюция.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы изменить статус задач, используйте HTTP-запрос с методом POST
. Параметры запроса передаются в его теле в формате JSON.
POST /v2/bulkchange/_transition
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>
{
"transition": "start_progress",
"issues": ["TEST-1","TEST-2","TEST-3"]
}
Параметры запроса
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
notify | Признак уведомления об изменении задачи:
|
Логический. |
Параметры тела запроса
Обязательные параметры
Параметр | Описание | Тип данных |
---|---|---|
transition | Идентификатор перехода. | Строка. |
issues | Идентификаторы задач, статус которых необходимо изменить. | Строка. |
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
values | Параметры задач, которые будут изменены при смене статуса. Используйте параметры, доступные при редактировании задачи. | Строка. |
Пример: Изменить статус нескольких задач.
Используется HTTP-метод POST.
Статус задач
TEST-1,TEST-2,TEST-3меняется наЗакрытс резолюциейРешен.POST /v2/bulkchange/_update Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-Id: <идентификатор организации> { "transition": "close", "issues": ["TEST-1", "TEST-2", "TEST-3"], "values": { "resolution": "fixed" } }
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 201 Created
.
Тело ответа содержит информацию об операции массового редактирования в формате JSON.
{
"id": "1ab23cd4e56789012fg345h6",
"self": "https://api.tracker.yandex.net/v2/bulkchange/1ab23cd4e56789012fg345h6",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/1234567890",
"id": "1234567890",
"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
- Ошибка валидации. Возможно, тело запроса содержит недопустимый или несуществующий параметр.