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

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

GET

https://api.tracker.yandex.net/v3/issues/{id_задачи}/comments/{id_комментария}

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

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

Чтобы получить комментарий, используйте HTTP-запрос с методом GET:

GET /v3/issues/{id_задачи}/comments/{id_комментария}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
Заголовки

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

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth OAUTH_TOKEN при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer IAM_TOKEN при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,

    • если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.

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

Ресурс

Обязательные параметры

Параметр Описание Тип данных
id_задачи Идентификатор или ключ задачи. Строка
id_комментария Уникальный идентификатор комментария в числовом формате id или строковом формате longId. Строка или число
Параметры запроса

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

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

Пример: Получить комментарий

GET https://api.tracker.yandex.net/v3/issues/JUNE-2/comments/123456

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

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

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

{
    "self": "https://api.tracker.yandex.net/v3/issues/JUNE-2/comments/123456",
    "id": 123456,
    "longId": "5fa15a24ac894475********",
    "text": "My **first** comment",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия"
    },
    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v3/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 Адрес ресурса API, который соответствует комментарию. Строка
id Идентификатор комментария. Число
longId Идентификатор комментария в виде строки. Строка
text Текст комментария. Строка
createdBy Объект с информацией о создателе комментария. Объект
updatedBy Объект с информацией о пользователе, который последним изменил комментарий. Объект
createdAt Дата и время создания комментария. Строка
updatedAt Дата и время последнего изменения комментария. Строка
version Версия комментария. Число
type Тип комментария. Строка
transport Способ добавления комментария. Строка

Поля объектов createdBy и updatedBy

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

Если передать в заголовке If-None-Match значение ETag из предыдущего ответа, API возвращает ответ с кодом 304, когда комментарий не изменился. Тело ответа отсутствует.

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