Получить историю событий сущности

Запрос позволяет получить историю событий сущности с постраничным отображением.

GET

https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/events/_relative

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

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

Для получения истории событий с постраничным отображением используйте HTTP-запрос с методом GET.

GET /v3/entities/<тип_сущности>/<id_сущности>/events/_relative
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.

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

Ресурс
Параметр Описание Тип данных
<тип_сущности> Тип сущности:
  • project — проект;
  • portfolio — портфель;
  • goal — цель
Строка
<id_сущности> Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. В качестве идентификатора можно использовать параметр id или shortId. Строка
Параметры запроса

Если параметры не указаны, выводится полный список событий.

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

Параметр

Описание

Тип данных

perPage

Определяет максимальное количество событий в ответе. Значение по умолчанию — 50.

Число

from

Идентификатор события, после которого начинает формироваться список. Само событие в список не включается. Не используется вместе с параметром selected.

Строка

selected

Идентификатор события, вокруг которого формируется список. Не указывается вместе с параметром from. Список формируется в следующем порядке (для perPage=5):

  1. Событие с указанным идентификатором.
  2. Событие, предшествующее первому событию.
  3. Событие, следующее за первым событием.
  4. Событие, предшествующее второму событию.
  5. Событие, следующее за третьим событием.

Строка

newEventsOnTop

Меняет порядок событий в списке на противоположный. Значение по умолчанию — false.

Логический

direction

Определяет порядок событий в списке:

  • forward (по умолчанию);
  • backward — инвертирует значение параметра newEventsOnTop.

Строка

Пример: Получить список событий

  • Используется HTTP-метод GET.
  • В ответе выводится информация о трех событиях.
  • Список начинается с события, следующего после <id_события_1>.
GET https://api.tracker.yandex.net/v3/entities/project/<id_проекта>/events/_relative?perPage=3&from=<id_события_1>

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

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

Тело ответа содержит информацию о событиях сущности в формате JSON.

{
    "events": [
        {
            "id": "65a26b254dbe6212********", 
            "author": {
                "self": "https://api.tracker.yandex.net/v3/users/11********",
                "id": "11********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": 11********
            },
            "date": "2024-01-13T10:51:17.821+0000", 
            "transport": "v3", 
            "display": "Issue updated", 
            "changes": [
                {
                    "diff": "<added>Имя Фамилия</added>", 
                    "field": {
                        "id": "teamUsers", 
                        "display": "Participants"
                    }
                }
            ]
        }, 
        {
            "id": "65a26b264dbe6215********", 
            "author": {
                "self": "https://api.tracker.yandex.net/v3/users/11********",
                "id": "11********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": 11********
            },
            "date": "2024-01-13T10:51:17.954+0000", 
            "transport": "v3", 
            "display": "Comment added", 
            "changes": [
                {
                    "diff": "<added>My comment</added>", 
                    "field": {
                        "id": "comment.text", 
                        "display": "Comment text", 
                        "addedSummonees": [
                            {
                                "self": "https://api.tracker.yandex.net/v3/users/11********",
                                "id": "11********",
                                "display": "Имя Фамилия",
                                "cloudUid": "ajeppa7dgp71********",
                                "passportUid": 11********
                            }
                        ], 
                        "email": null
                    },
                    "commentUrl": ""
                }
            ]
        }, 
        {
            "id": "65a26b384dbe6216********",  
            "author": {
                "self": "https://api.tracker.yandex.net/v3/users/11********",
                "id": "11********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": 11********
            },
            "date": "2024-01-13T10:51:36.807+0000", 
            "transport": "v3", 
            "display": "File added", 
            "changes": [
                {
                    "diff": "<added>Add a file</added>",
                    "field": {
                        "id": "comment.text", 
                        "display": "Comment", 
                        "email": null
                    },
                    "commentUrl": ""
                }, 
                {
                    "diff": "<added>image.jpg</added>", 
                    "field": {
                        "id": "issue.attachments", 
                        "display": "Attachments"
                    }
                }
            ]
        }
    ], 
    "hasNext": true,
    "hasPrev": true
}
Параметры ответа
Параметр Описание Тип данных
events Массив объектов с информацией о событиях. Массив объектов
hasNext Указывает на наличие последующих записей в списке. Логический
hasPrev Указывает на наличие предыдущих записей в списке. Логический

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

Параметр Описание Тип данных
id Идентификатор события. Строка
author Объект с информацией об авторе события. Объект
date Дата и время создания события в формате:
YYYY-MM-DDThh:mm:ss.sss±hhmm.
Строка
transport Служебный параметр. Строка
display Отображаемое название события. Строка
changes Массив объектов с информацией об изменениях. Состав и содержимое полей объектов зависят от изменяемого параметра. Массив объектов

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

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

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

400
Один или несколько параметров запроса имеют недопустимое значение.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
422
Ошибка валидации JSON, запрос отклонен.