Получить комментарии к сущности

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

GET

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

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

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

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

GET /v3/entities/<тип_сущности>/<id_сущности>/comments
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. Строка
Параметры запроса

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

Параметр Описание Тип данных
expand Дополнительная информация, которая будет включена в ответ:
  • all — все;
  • html — HTML-разметка комментария;
  • attachments — вложенные файлы;
  • reactions — реакции на комментарий.
 Строка

Пример: Получить список комментариев

  • Используется HTTP-метод GET.
  • В ответе выводится информация о всех комментариях.
GET https://api.tracker.yandex.net/v3/entities/project/<id_проекта>/comments?expand=all

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

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

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

[
    {
        "self": "https://api.tracker.yandex.net/v3/entities/project/6586d6fee2b9ef74********/comments/15", 
        "id": 15, 
        "longId": "65a156a29d5d2000********",
        "text": "Комментарий **номер один.**",
        "textHtml": "<p>Комментарий <strong>номер один.</strong></p>\n",
        "attachments": [
            {
                "self": "https://api.tracker.yandex.net/v3/entities/project/6586d6fee2b9ef74********/attachments/25", 
                "id": "25", 
                "display": "image.jpg"
            }
        ], 
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 11********
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 11********
        },
        "createdAt": "2024-01-12T15:11:30.278+0000", 
        "updatedAt": "2024-01-12T16:33:35.988+0000", 
        "usersReacted": {
            "like": [
                {
                    "self": "https://api.tracker.yandex.net/v3/users/11********",
                    "id": "11********",
                    "display": "Имя Фамилия",
                    "cloudUid": "ajeppa7dgp71********",
                    "passportUid": 11********
                }
            ]
        }, 
        "ownReactions": ["like"], 
        "summonees": [
            {
                "self": "https://api.tracker.yandex.net/v3/users/11********",
                "id": "11********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp32********",
                "passportUid": 11********
            }
        ],
        "version": 3, 
        "type": "standard", 
        "transport": "internal"
    }
]
Параметры ответа
Параметр Описание Тип данных
self Ссылка на объект комментария. Строка
id Идентификатор комментария. Число
longId Идентификатор комментария в виде строки. Строка
text Текст комментария. Строка
textHtml HTML-разметка комментария. Строка
attachments Вложения. Строка
createdBy Объект с информацией о создателе комментария. Объект
updatedBy Объект с информацией о сотруднике, внесшем последнее изменение в комментарий. Объект
createdAt Дата и время создания комментария в формате:
YYYY-MM-DDThh:mm:ss.sss±hhmm.		 Строка
updatedAt Дата и время обновления комментария в формате:
YYYY-MM-DDThh:mm:ss.sss±hhmm.		 Строка
usersReacted Реакции пользователей (присутствует в ответе, если в запросе для параметра expand указано значение all или reactions):
  • like;
  • dislike;
  • laugh;
  • tada;
  • hooray;
  • confused;
  • heart;
  • rocket;
  • eyes;
  • fire;
  • ok;
  • facepalm;
  • check.
 Объект со списком реакций и отреагировавших
reactionsCount Количество реакций (присутствует в ответе, если в запросе для параметра expand не указано значение all или reactions). Объект со списком и количеством реакций
ownReactions Реакции автора комментария:
  • like;
  • dislike;
  • laugh;
  • tada;
  • hooray;
  • confused;
  • heart;
  • rocket;
  • eyes;
  • fire;
  • ok;
  • facepalm;
  • check.
 Список строк
summonees Идентификаторы или логины призванных пользователей. Массив объектов или строк
maillistSummonees Список рассылок, призванных в комментарии. Массив строк
version Версия комментария. Каждое изменение комментария увеличивает номер версии. Число
type Тип комментария:
  • standart — отправлен через интерфейс Трекера;
  • incoming — создан из входящего письма;
  • outcoming — создан из исходящего письма.
 Строка
transport Способ добавления комментария:
  • internal — через интерфейс Трекера;
  • email — через письмо.
 Строка

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

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

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

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

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

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

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

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

Постраничное отображение комментариев к сущности

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

GET /v3/entities/<тип_сущности>/<id_сущности>/comments/_relative
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

В строке запроса укажите дополнительные параметры:

Параметр

Описание

Тип данных

perPage

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

Число

from

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

Строка

selected

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

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

Строка

newCommentsOnTop

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

Логический

direction

Определяет порядок комментариев в списке:

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

Строка

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

Пример: Получить список комментариев

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

Формат ответа с постраничным отображением комментариев

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

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

{
    "comments": [
        {
            "self": "https://api.tracker.yandex.net/v3/entities/project/65a1bdb02b780b31********/comments/22", 
            "id": 22, 
            "longId": "65a1bdb02b780b31********", 
            "text": "Предыдущий комментарий.",
            ...
        }, 
        {
            "self": "https://api.tracker.yandex.net/v3/entities/project/65a1bdb02b780b32********/comments/23", 
            "id": 23, 
            "longId": "65a1bdb02b780b32********", 
            "text": "Указанный комментарий.", 
            ...
        }, 
        {
            "self": "https://api.tracker.yandex.net/v3/entities/project/65a1bdb02b780b33********/comments/24", 
            "id": 24, 
            "longId": "65a1bdb02b780b33********", 
            "text": "Следующий комментарий.", 
            ...
        }
    ], 
    "hasNext": True, 
    "hasPrev": True
}
Параметры ответа
Параметр Описание Тип данных
comments Список комментариев. Список объектов
hasNext Указывает на наличие последующих записей в списке. Логический
hasPrev Указывает на наличие предыдущих записей в списке. Логический

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

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