Редактировать комментарий
Запрос позволяет редактировать комментарий.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы изменить комментарий, который был добавлен к задаче ранее, используйте HTTP-запрос с методом PATCH
. Параметр запроса передается в его теле в формате JSON:
PATCH /v2/issues/<issue-id>/comments/<comment-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>
{
"text": "<новый текст комментария>"
}
-
Host
Адрес узла, предоставляющего API:
https://api.tracker.yandex.net
-
Authorization
OAuth-токен в формате
OAuth <значение токена>
, например:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Идентификатор организации.
Параметр | Описание | Тип данных |
---|---|---|
<issue-id> | Идентификатор или ключ текущей задачи. | Строка |
<comment-id> | Уникальный идентификатор комментария в числовом формате (id) или формате строки (longId). | Строка или число |
Обязательные параметры
Параметр | Значение | Тип данных |
---|---|---|
text | Скорректированный комментарий к задаче. | Строка |
Дополнительные параметры
Параметр | Значение | Тип данных |
---|---|---|
attachmentIds | Список идентификаторов вложений. | Массив строк |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит информацию о добавленном комментарии в формате JSON.
[
{
"self" : "https://api.tracker.yandex.net/v2/issues/TREK-1/comments/684",
"id" : "684",
"longId" : "5fc4bc634e121b12f44a0488",
"text" : "<текст комментария>",
"createBody" : {
"self" : "https://api.tracker.yandex.net/v2/users/1120000000016876",
"id" : "<id пользователя>",
"display" : "<отображаемое имя пользователя>"
},
"updateBody" : {
"self" : "https://api.tracker.yandex.net/v2/users/1120000000016876",
"id" : "<id пользователя>",
"display" : "<отображаемое имя пользователя>"
},
"createdAt" : "2020-11-30T09:33:23.638+0000",
"updatedAt" : "2020-11-30T09:39:07.631+0000",
"summonees" : [
{
"self" : "https://api.tracker.yandex.net/v2/users/1120000000016576",
"id" : "<id пользователя>",
"display" : "<отображаемое имя пользователя>"
}
],
"maillistSummonees" : [
{
"self" : "https://api.tracker.yandex.net/v2/maillists/usertest@test.ru",
"id" : "<адрес рассылки>",
"display" : "<отображаемое имя рассылки>"
}
],
"version" : 2,
"type" : "standard",
"transport" : "internal"
}
]
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на комментарий. | Строка |
id | Идентификатор комментария. | Строка |
longId | Идентификатор комментария в формате строки. | Строка |
text | Комментарий к задаче. | Строка |
createdBy | Блок с информацией о пользователе, который добавил комментарий. | Объект |
updatedBy | Блок с информацией о пользователе, который последним изменил комментарий. | Объект |
createdAt | Дата и время создания комментария. | Строка |
updatedAt | Дата и время обновления комментария. | Строка |
summonees | Блок с информацией о пользователях, которые призваны в комментарии. | Объект |
maillistsummonees | Блок с информацией о рассылках, которые призваны в комментарии. | Объект |
version | Версия комментария. Каждое изменение комментария увеличивает номер версии. | Число |
type | Тип комментария:
|
Строка |
transport | Способ добавления комментария:
|
Строка |
Поля объекта createdBy
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
Поля объекта updatedBy
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
Поля объекта summonees
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
Поля объекта maillistsummonees
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на рассылку. | Строка |
id | Адрес рассылки. | Строка |
display | Отображаемое имя рассылки. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.