Связаться с намиПодключиться

Информация о выполнении пакетной операции

Статья создана
Обновлена 26 августа 2024 г.

Вы можете получить статус выполнения операции массового редактирования задач, а также список возникших ошибок для каждой задачи:

Получить статус выполнения пакетной операции

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

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

Чтобы получить статус выполнения пакетной операции, используйте HTTP-запрос с методом GET.

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

  • 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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<id> Идентификатор запущенной пакетной операции в формате 593cd211ef7e8a33********. Строка

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

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

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

{
   "id": "593cd211ef7e8a33********",
   "self": "https://api.tracker.yandex.net/v2/bulkchange/593cd211ef7e8a33********",
   "createdBy": {
      "self": "https://api.tracker.yandex.net/v2/users/1120000000******",
      "id": "111111",
      "display": "Иван Иванов",
      "passportUid": 12********
   },
   "createdAt": "2024-06-26T19:00:47.451+0000",
   "status": "FAILED",
   "statusText": "Завершился с ошибками",
   "executionChunkPercent": 100,
   "executionIssuePercent": 100,
   "totalIssues": 24,
   "totalCompletedIssues": 0
}
Параметры ответа
Параметр Описание Тип данных
id Идентификатор пакетной операции. Строка
self Адрес ресурса API, который содержит информацию о пакетной операции. Строка
createdBy Информация об инициаторе пакетной операции. Объект
createdAt Дата и время создания пакетной операции. Строка
status Статус пакетной операции. Строка
statusText Описание статуса пакетной операции. Строка
executionChunkPercent Служебный параметр. Число
executionIssuePercent Служебный параметр. Число
totalIssues Количество задач, которые должны быть отредактированы. Число
totalCompletedIssues Количество задач, для которых пакетная операция завершилась успешно. Число

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

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

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

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

Получить список задач, для которых операция завершилась с ошибкой

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

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

Чтобы получить список задач, для которых пакетная операция завершилась с ошибкой, используйте HTTP-запрос с методом GET.

GET /v2/bulkchange/{id}/issues
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

  • 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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<id> Идентификатор запущенной пакетной операции в формате 593cd211ef7e8a33********. Строка

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

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

Тело ответа содержит список задач, для которых пакетная операция завершилась с ошибкой, в формате JSON.

[
   {
      "issue": {
            "self": "https://api.tracker.yandex.net/v2/issues/TEST-1",
            "id": "593cd211ef668a33********",
            "key": "TEST-1",
            "display": "Тест"
      },
      "status": "FAILED",
      "statusText": "Изменения не выполнены",
      "error": {
            "errors": {
               "resolution": "Выбранную резолюцию нельзя использовать для задачи этого типа в данной очереди."
            },
            "errorMessages": []
      }
   },
   {
      "issue": {
            "self": "https://api.tracker.yandex.net/v2/issues/TEST-4",
            "id": "593cd211ef756a33********",
            "key": "TEST-4",
            "display": "Задача"
      },
      "status": "FAILED",
      "statusText": "Изменения не выполнены",
      "error": {
            "errors": {
               "resolution": "Выбранную резолюцию нельзя использовать для задачи этого типа в данной очереди."
            },
            "errorMessages": []
      }
   },
   ...
]
Параметры ответа
Параметр Описание Тип данных
issue Блок с информацией о задаче. Объект
status Тип ошибки выполнения пакетной операции. Строка
statusText Описание ошибки выполнения пакетной операции. Строка
error Блок с информацией об ошибках, возникших в задаче при выполнении пакетной операции. Объект

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

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

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

Параметр Описание Тип данных
errors Описание ошибок. Объект
errorMessages Служебный параметр. Массив

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

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