Массовое редактирование задач
Запрос позволяет изменить параметры нескольких задач одновременно.
Примечание
Максимальное количество задач для однократного обновления — 10 000.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы изменить задачи, используйте HTTP-запрос с методом POST
. Параметры запроса передаются в его теле в формате JSON.
POST /v2/bulkchange/_update
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"issues": ["TEST-1", "TEST-2", "TEST-3"],
"values": {
"<параметр_1>": "<значение_параметра_1>",
"<параметр_2>": "<значение_параметра_2>"
}
}
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net
-
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>
, например:OAuth 0c4181a7c2cf4521964a72ff********
-
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker
.- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID
. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID
. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-ID
и идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Параметры запроса
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
notify | Признак уведомления об изменении задачи:
|
Логический |
Параметры тела запроса
Обязательные параметры
Параметр | Описание | Тип данных |
---|---|---|
issues | Массив идентификаторов задач или фильтр на языке запросов. | Массив или Строка |
values | Параметры задач, которые будут изменены. Используйте параметры, доступные при редактировании задачи. | Строка |
Пример 1: Изменить задачи.
- Используется HTTP-метод POST.
- Тип задач «TEST-1», «TEST-2», «TEST-3» меняется на «Ошибка».
POST /v2/bulkchange/_update Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> { "issues": ["TEST-1","TEST-2","TEST-3"], "values": { "type": {"name": "Ошибка"} } }
Пример 2: Изменить задачи, используя фильтр на языке запросов.
- Используется HTTP-метод POST.
- Для задач, в названии которых есть слово
Test
, приоритет меняется наБлокер
и добавляется комментарий "Updated via API".
POST /v2/bulkchange/_update Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> { "issues": "Summary: Test" "values": { "comment": "Updated via API", "priority": {"key": "blocker"} } }
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 201 Created
.
Тело ответа содержит информацию об операции массового редактирования в формате JSON.
{
"id": "1ab23cd4e5678901********",
"self": "https://api.tracker.yandex.net/v2/bulkchange/1ab23cd4e5678901********",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/12********",
"id": "12********",
"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, запрос отклонен.