Редактировать комментарий

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

PATCH

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

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

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

Чтобы изменить комментарий, который был добавлен к задаче ранее, используйте HTTP-запрос с методом PATCH. Параметр запроса передается в его теле в формате JSON:

PATCH /v3/issues/<id_задачи>/comments/<id_комментария>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
   "text": "<новый_текст_комментария>"
}

Заголовки

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.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

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

Параметры тела запроса

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

Параметр	Значение	Тип данных
text	Скорректированный комментарий к задаче.	Строка

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

Параметр	Значение	Тип данных
attachmentIds	Идентификаторы временных файлов, которые будут добавлены как вложения.	Массив строк
summonees	Идентификаторы или логины призванных пользователей.	Массив объектов или строк
markupType	Тип отображаемой в тексте разметки. Если вы используете в тексте комментария разметку YFM, укажите значение `md`.	Строка

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

Запрос выполнен успешно

Запрос выполнен с ошибкой

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

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

  {
    "self": "https://api.tracker.yandex.net/v3/issues/TREK-1/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",  
    "summonees" : [
     { 
       "self": "https://api.tracker.yandex.net/v3/users/11********",
       "id": "11********",
       "display": "Имя Фамилия",
       "cloudUid": "ajeppa7dgp53********",
       "passportUid": 11********
     } 
    ],
   "maillistSummonees" : [
     { 
      "self": "https://api.tracker.yandex.net/v3/maillists/usertest@test.ru",
      "id": "usertest@test.ru",
      "display": "My maillist"
     } 
    ], 
    "version" : 1,  
    "type": "standard",  
    "transport": "internal"
  }

Параметры ответа

Параметр	Описание	Тип данных
self	Ссылка на комментарий.	Строка
id	Идентификатор комментария.	Строка
longId	Идентификатор комментария в формате строки.	Строка
text	Комментарий к задаче.	Строка
createdBy	Блок с информацией о пользователе, который добавил комментарий.	Объект
updatedBy	Блок с информацией о пользователе, который последним изменил комментарий.	Объект
createdAt	Дата и время создания комментария.	Строка
updatedAt	Дата и время обновления комментария.	Строка
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.	Строка

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

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

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

Параметр	Описание	Тип данных
self	Ссылка на рассылку.	Строка
id	Адрес рассылки.	Строка
display	Отображаемое имя рассылки.	Строка

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

400: Один или несколько параметров запроса имеют недопустимое значение.

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

Была ли статья полезна?

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

Удалить комментарий