Добавить реакцию на комментарий

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

POST

https://api.tracker.yandex.net/v3/issues/<id_задачи>/comments/<id_комментария>/reactions/<название_реакции>

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

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

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

POST /v3/issues/<id_задачи>/comments/<id_комментария>/reactions/<название_реакции>
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: идентификатор организации.

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

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

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

Ресурс
Параметр Описание Тип данных
<id_задачи> Идентификатор или ключ задачи. Строка
<id_комментария> Уникальный идентификатор комментария в числовом формате (id) или формате строки (longId). Строка или число
<название_реакции> Название реакции. Доступные значения:
  • LIKE — лайк;
  • DISLIKE — дизлайк;
  • LAUGH — смех;
  • HOORAY — ура;
  • CONFUSED — недоумение;
  • HEART — сердце;
  • ROCKET — ракета;
  • EYES — вижу;
  • FIRE — огонь;
  • OK — окей;
  • FACEPALM — фейспалм;
  • CHECK — галочка.
 Строка

Пример: Добавить реакцию «лайк» на комментарий

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

POST https://api.tracker.yandex.net/v3/issues/TREK-123/comments/12345/reactions/LIKE
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/v3/issues/TREK-123/comments/626",
  "id": 626,
  "longId": "5fa15a24ac894475********",
  "text": "Comment text",
  "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": "2020-11-03T13:24:52.575+0000",
  "updatedAt": "2020-11-03T13:24:52.575+0000",
  "reactionsCount": {
    "like": 1
  },
  "ownReactions": [
    "like"
  ],
  "version": 1,
  "type": "standard",
  "transport": "internal"
}
Параметры ответа
Параметр Описание Тип данных
self Ссылка на комментарий. Строка
id Идентификатор комментария. Число
longId Идентификатор комментария в формате строки. Строка
text Текст комментария. Строка
createdBy Блок с информацией о пользователе, который создал комментарий. Объект
updatedBy Блок с информацией о пользователе, который последним изменил комментарий. Объект
createdAt Дата и время создания комментария. Строка
updatedAt Дата и время обновления комментария. Строка
reactionsCount Объект с количеством реакций каждого типа. Ключ — название реакции в нижнем регистре, значение — количество. Объект
ownReactions Массив реакций текущего пользователя на этот комментарий. Названия реакций указаны в нижнем регистре. Массив строк
version Версия комментария. Каждое изменение комментария увеличивает номер версии. Число
type Тип комментария:
  • standard — отправлен через интерфейс Трекера;
  • 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. Строка

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

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