Получить историю изменений задачи

Запрос позволяет получить историю изменений задачи. Если количество записей в ответе более 50, необходимо использовать параметр perPage.

GET

https://api.tracker.yandex.net/v3/issues/<id_задачи>/changelog

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

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

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

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

  • Host: адрес узла, предоставляющего API.

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

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

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

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

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

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

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

Ресурс
Параметр Описание Тип данных
<id_задачи> Идентификатор или ключ текущей задачи. Строка
Параметры запроса

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

Параметр Описание Тип данных
id Идентификатор изменения, за которым следуют запрашиваемые изменения. Строка
perPage Количество изменений на странице. Если параметр не указан, по умолчанию на странице будет выведено 50 изменений. Число
field Идентификатор параметра изменений. Например, checklistItems для просмотра изменений в чеклисте или status для просмотра всех обновлений статуса задачи. Строка
type Ключ типа изменения. Строка

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

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

Тело ответа содержит JSON-массив с историей изменений задачи.

Заголовки ответа

Заголовки Link содержат ссылки на первую (rel="first") и последующую (rel="next") страницы ответа. По умолчанию на каждой странице располагается 50 изменений.

...
Link: <api.tracker.yandex.net/v3/issues/SCR-8/changelog?perPage=50>; rel="first"
Link: <api.tracker.yandex.net/v3/issues/SCR-8/changelog?id=5b9a1a88f7c60500********&perPage=50>; rel="next"
...

[
 {
     "id": "6033f986bd6c4a04********",
     "self": "https://api.tracker.yandex.net/v3/issues/TEST-27/changelog/6033f986bd6c4a04********",
     "issue": {
         "self": "https://api.tracker.yandex.net/v3/issues/TEST-27",
         "id": "6033f986bd6c4a04********",
         "key": "TEST-27",
         "display": "My issue"
     },
     "updatedAt": "2021-02-22T18:35:50.157+0000",
     "updatedBy": {
         "self": "https://api.tracker.yandex.net/v3/users/11********",
         "id": "11********",
         "display": "Имя Фамилия"
     },
     "type": "IssueCreated",
     "transport": "front",
     "fields": [
         {
             "field": {
                 "self": "https://api.tracker.yandex.net/v3/fields/status",
                 "id": "status",
                 "display": "Status"
             },
             "from": null,
             "to": {
                 "self": "https://api.tracker.yandex.net/v3/statuses/1",
                 "id": "1",
                 "key": "open",
                 "display": "Открыт"
             }
         }
     ]
 },
 {
     "id": "6033f98d4417c101********",
     "self": "https://api.tracker.yandex.net/v3/issues/TEST-27/changelog/6033f98d4417c101********",
     "issue": {
         "self": "https://api.tracker.yandex.net/v3/issues/TEST-27",
         "id": "6033f986bd6c4a04********",
         "key": "TEST-27",
         "display": "My issue"
     },
     "updatedAt": "2021-02-22T18:35:57.359+0000",
     "updatedBy": {
         "self": "https://api.tracker.yandex.net/v3/users/11********",
         "id": "11********",
         "display": "Имя Фамилия"
     },
     "type": "IssueUpdated",
     "transport": "front",
     "fields": [
         {
             "field": {
                 "self": "https://api.tracker.yandex.net/v3/fields/followers",
                 "id": "followers",
                 "display": "Followers"
             },
             "from": null,
             "to": [
                 {
                     "self": "https://api.tracker.yandex.net/v3/users/11********",
                     "id": "11********",
                     "display": "Имя Фамилия"
                 }
             ]
         }
     ]
 },
 {
    "id": "62bab52ca16f631e********",
    "self": "https://api.tracker.yandex.net/v3/issues/TEST-27/changelog/62bab52ca16f631e********",
    "issue": {
        "self": "https://api.tracker.yandex.net/v3/issues/TEST-27",
        "id": "5fbc929b5b28572f********",
        "key": "TEST-27",
        "display": "My issue"
    },
    "updatedAt": "2022-06-28T08:00:44.155+0000",
    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия"
    },
    "type": "IssueCommentAdded",
    "transport": "front",
    "comments": {
        "added": [
            {
                "self": "https://api.tracker.yandex.net/v3/issues/TEST-27/comments/10",
                "id": "10",
                "display": "My comment"
            }
        ]
    },
    "executedTriggers": [
        {
            "trigger": {
                "self": "https://api.tracker.yandex.net/v3/queues/TEST/triggers/29",
                "id": "29",
                "display": "My trigger"
            },
            "success": true,
            "message": "Success"
        }
     ]
  }
]
Параметры ответа
Параметр Описание Тип данных
id Идентификатор изменения. Строка
self Адрес ресурса API, который содержит информацию об изменении. Строка
issue Блок с информацией о задаче. Объект
updatedAt Дата и время изменения задачи в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
updatedBy Блок с информацией о пользователе, который внес изменение в задачу. Объект
transport Служебный параметр. Строка
type Тип изменения. Строка
fields Массив объектов с информацией об измененных параметрах задачи. Массив объектов
comments Блок с информацией о комментарии к задаче. Объект
executedTriggers Блок с информацией о триггере, который сработал в задаче. Объект

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

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

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

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

Поля объектов массива fields

Параметр Описание Тип данных
field Блок с информацией об измененном параметре задачи. Объект
from Информация о значении параметра до изменения.
  • Если в поле можно записать несколько значений, то передается массив объектов. Например, поле followers.
  • Если в поле можно записать только одно значение, то оно передается в строковом формате. Например, поле statusStartTime.
 Строка / Объект
to Информация о значении параметра после изменения.
  • Если в поле можно записать несколько значений, то передается массив объектов. Например, поле followers.
  • Если в поле можно записать только одно значение, то оно передается в строковом формате. Например, поле statusStartTime.
 Строка / Объект

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

Параметр Описание Тип данных
self Ссылка на измененный параметр задачи. Строка
id Идентификатор параметра задачи. Строка
display Отображаемое название параметра задачи. Строка

Поля объектов from и to

Параметр Описание Тип данных
self Ссылка на значение параметра задачи. Строка
id Идентификатор значения параметра задачи. Строка
key Ключ значения параметра. Строка
display Отображаемое название значения параметра. Строка

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

Параметр Описание Тип данных
added Блок с информацией о комментарии. Объект

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

Параметр Описание Тип данных
self Ссылка на объект комментария. Строка
id Идентификатор комментария. Число
display Текст комментария. Строка

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

Параметр Описание Тип данных
trigger Блок с информацией о триггере. Объект
success Статус срабатывания триггера. Допустимые значения:
  • true— успешно;
  • false— неуспешно.
 Логический
message Действие, которое было выполнено при срабатывании триггера. Строка

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

Параметр Описание Тип данных
self Ссылка на объект триггера. Строка
id Идентификатор триггера. Число
display Отображаемое название триггера. Строка

Тип изменения type

Тип изменения Описание
IssueUpdated Задача изменена.
IssueCreated Задача создана.
IssueMoved Задача перемещена в другую очередь.
IssueCloned Создана копия задачи.
IssueCommentAdded Добавлен комментарий к задаче.
IssueCommentUpdated Изменен комментарий к задаче.
IssueCommentRemoved Удален комментарий к задаче.
IssueWorklogAdded Добавлена запись о затраченном времени.
IssueWorklogUpdated Изменена запись о затраченном времени.
IssueWorklogRemoved Удалена запись о затраченном времени.
IssueCommentReactionAdded За комментарий проголосовали.
IssueCommentReactionRemoved Отозван голос за комментарий.
IssueVoteAdded За задачу проголосовали.
IssueVoteRemoved Отозван голос за задачу.
IssueLinked Создана связь с другой задачей.
IssueLinkChanged Изменен тип связи с другой задачей.
IssueUnlinked Удалена связь с другой задачей.
RelatedIssueResolutionChanged Изменена резолюция связанной задачи.
IssueAttachmentAdded К задаче прикреплен файл.
IssueAttachmentRemoved Прикрепленный к задаче файл удален.
IssueWorkflow Изменен статус задачи.

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

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