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

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

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

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

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

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

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

GET /v2/entities/<тип_сущности>/<идентификатор_сущности>/events/_relative
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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<тип_сущности> Тип сущности:
  • project — проект;
  • portfolio — портфель.
 Строка
<идентификатор_сущности> Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. Строка
<идентификатор_проекта_или_портфеля> Идентификатор проекта или портфеля (значение поля shortId). Его можно использовать в запросе вместо идентификатора сущности. Строка

Важно

Идентификатор сущности не совпадает с идентификатором проекта или портфеля.

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

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

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

Параметр

Описание

Тип данных

perPage

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

Число

from

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

Строка

selected

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

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

Строка

newEventsOnTop

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

Логический

direction

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

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

Строка

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

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

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

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

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

{
    "events": [
        {
            "id": "65a26b254dbe6212********", 
            "author": {
                "self": "api.tracker.yandex.net/v2/users/19********",
                "id": "19********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": "16********"
            },
            "date": "2024-01-13T10:51:17.821+0000", 
            "transport": "v2", 
            "display": "Задача обновлена", 
            "changes": [
                {
                    "diff": "<added>Имя_Фамилия</added>", 
                    "field": {
                        "id": "teamUsers", 
                        "display": "Участники"
                    }
                }
            ]
        }, 
        {
            "id": "65a26b264dbe6215********", 
            "author": {
                "self": "api.tracker.yandex.net/v2/users/19********",
                "id": "19********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": "16********"
            },
            "date": "2024-01-13T10:51:17.954+0000", 
            "transport": "v2", 
            "display": "Комментарий добавлен", 
            "changes": [
                {
                    "diff": "<added>Добавлен первый комментарий</added>", 
                    "field": {
                        "id": "comment.text", 
                        "display": "Текст комментария", 
                        "addedSummonees": [
                            {
                                "self": "api.tracker.yandex.net/v2/users/19********",
                                "id": "19********",
                                "display": "Имя Фамилия",
                                "cloudUid": "ajeppa7dgp71********",
                                "passportUid": "16********"
                            }
                        ], 
                        "email": None
                    },
                    "commentUrl": ""
                }
            ]
        }, 
        {
            "id": "65a26b384dbe6216********",  
            "author": {
                "self": "api.tracker.yandex.net/v2/users/19********",
                "id": "19********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": "16********"
            },
            "date": "2024-01-13T10:51:36.807+0000", 
            "transport": "v2", 
            "display": "Файл добавлен", 
            "changes": [
                {
                    "diff": "<added>Добавляем файл в комментарии.</added>",
                    "field": {
                        "id": "comment.text", 
                        "display": "Текст комментария", 
                        "email": None
                    },
                    "commentUrl": ""
                }, 
                {
                    "diff": "<added>image.jpg</added>", 
                    "field": {
                        "id": "issue.attachments", 
                        "display": "Вложения"
                    }
                }
            ]
        }
    ], 
    "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 Отображаемое имя пользователя. Строка
cloudUid Уникальный идентификатор пользователя в Yandex Cloud Organization. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Строка

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

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