Массовый перенос задач в другую очередь

Статья создана

Обновлена 26 августа 2024 г.

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

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

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

Важно

Если переносимая задача имеет тип и статус, которые не существуют в новой очереди, перенос не будет выполнен. Чтобы при переносе сбросить статус задачи в начальное значение, используйте параметр InitialStatus.

По умолчанию при переносе очищаются значения компонентов, версий и проектов задачи. Если в новой очереди настроены аналогичные значения для этих полей, для переноса компонентов, версий и проектов используйте параметр MoveAllFields.

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

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

Чтобы перенести задачи в другую очередь, используйте HTTP-запрос с методом POST:

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

{
  "queue": "<ключ_очереди>",
  "issues": ["TEST-1","TEST-2","TEST-3"]
}

Заголовки

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 для бизнеса.

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

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

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

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

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

Параметр	Описание	Тип данных
queue	Ключ очереди, в которую планируется перенести задачи.	Строка
issues	Идентификаторы задач, которые необходимо перенести.	Строка

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

Параметр	Описание	Тип данных
values	Параметры задач, которые будут изменены при переносе. Используйте параметры, доступные при редактировании задачи.	Строка
moveAllFields	Перенос версий, компонентов и проектов задачи в новую очередь: `true` — перенести, если в новой очереди существуют соответствующие версии, компоненты, проекты; `false` (по умолчанию) — очистить версии, компоненты, проекты.	Логический
initialStatus	Сброс статуса задачи в начальное значение. Статус необходимо сбросить, если задача переносится в очередь с другим воркфлоу: `true` — статус будет сброшен; `false` (по умолчанию) — статус останется без изменений.	Логический

Пример запроса: Перенести задачи.

Используется HTTP-метод POST.

Задачи «TEST-1», «TEST-2», «TEST-3» перемещаются в очередь «CHECK».

Каждой перемещенной задаче присваивается тег «перемещено».
POST /v2/bulkchange/_move
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
"queue": "CHECK",
"issues": ["TEST-1","TEST-2","TEST-3"],
"values": {
   "tags": {
   "add": ["перемещено"]
   }
},
"moveAllFields": true
}

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

Запрос выполнен успешно

Запрос выполнен с ошибкой

В случае успешного выполнения запроса 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, запрос отклонен.

Массовый перенос задач в другую очередь

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

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

Была ли статья полезна?

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

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