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

Получить комментарии к задаче

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

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

По умолчанию запрос возвращает только первую страницу, на которой отображается 50 комментариев. Если комментариев больше 50, используйте постраничное отображение результатов.

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

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

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

GET /v2/issues/<ключ_или_идентификатор_задачи>/comments
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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_задачи> Идентификатор или ключ текущей задачи. Строка
Параметры запроса

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

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

Запрос комментариев одной задачи:

Используется HTTP-метод GET.

GET /v2/issues/<ключ_задачи>/comments?expand=all HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

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

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

Тело ответа содержит JSON-массив с информацией о комментариях:

[
    {
        "self": "https://api.tracker.yandex.net/v2/issues/JUNE-2/comments/98******",
        "id": 98******,
        "longId" : "5fa15a24ac894475********",
        "text": "Комментарий **номер один.**",
        "textHtml": "<p>Комментарий <strong>номер один.</strong></p>\n",
        "attachments": [{ "self": "https://api.tracker.yandex.net/v2/issues/JUNE-3/attachments/1", "id": "1", "display": "Untitled.png" }],
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Иван Иванов"
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Иван Иванов"
        },
        "createdAt": "2017-06-11T05:11:12.347+0000",
        "updatedAt": "2017-06-11T05:11:12.347+0000",
        "version": 1,
        "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		 Строка
version Версия комментария. Каждое изменение комментария увеличивает номер версии. Число
type Тип комментария:
  • standart — отправлен через интерфейс Tracker;
  • incoming — создан из входящего письма;
  • outcoming — создан из исходящего письма.
 Строка
transport Способ добавления комментария:
  • internal — через интерфейс Tracker;
  • email — через письмо.
 Строка

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

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

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

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

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

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

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

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

GET /v2/issues/<ключ_или_идентификатор_задачи>/comments?perPage=<количество_комментариев>&id=<идентификатор_комментария>

где:

  • perPage — количество комментариев на странице;

  • id — значение параметра id у комментария, после которого начнется запрашиваемая страница.

Ссылки на первую и следующую страницы указаны в заголовке ответа Link.

О постраничном отображении результатов читайте также в разделе Общий формат запросов.

Предыдущая
Добавить комментарий
Следующая
Редактировать комментарий