Подключиться
Yandex Tracker

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

Статья создана

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

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

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

GET /v2/issues/<issue-id>/comments
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

Заголовки

  • Host

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

    https://api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <значение токена>, например:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

    Идентификатор организации.

Ресурс

  • <issue-id>
    Идентификатор или ключ задачи.

Запрос комментариев одной задачи с указанием необходимых полей:

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

GET /v2/issues/JUNE-3/comments HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>
Cache-Control: no-cache

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит JSON-массив с информацией о комментариях:

[
    {
        "self": "https://api.tracker.yandex.net/v2/issues/JUNE-2/comments/9849018",
        "id": 9849018,
        "longId" : "5fa15a24ac894475dd14ff07",
        "text": "Комментарий",
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
            "id": "<id сотрудника>",
            "display": "<отображаемое имя сотрудника>"
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
            "id": "<id сотрудника>",
            "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 Текст комментария. Строка
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 Ссылка на пользователя. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка

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

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

Возможные коды ответа

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