Добавить комментарий
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет добавить комментарий в задачу.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы добавить комментарий в задачу, используйте HTTP-запрос с методом POST. Параметр запроса передается в его теле в формате JSON:
POST /v2/issues/<ключ_или_идентификатор_задачи>/comments
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"text": "<текст_комментария>"
}
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net -
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>, например:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-IDи идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <ключ_или_идентификатор_задачи> | Идентификатор или ключ текущей задачи. | Строка |
Параметры запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| isAddToFollowers | Добавить автора комментария в наблюдатели (по умолчанию true). |
Логический |
Параметры тела запроса
Обязательные параметры
| Параметр | Значение | Тип данных |
|---|---|---|
| text | Комментарий к задаче. | Строка |
Дополнительные параметры
| Параметр | Значение | Тип данных |
|---|---|---|
| attachmentIds | Список идентификаторов вложений. | Массив строк |
| summonees | Идентификаторы или логины призванных пользователей. | Массив объектов или строк |
| maillistSummonees | Список рассылок, призванных в комментарии. | Массив строк |
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 201 Created.
Тело ответа содержит информацию о добавленном комментарии в формате JSON.
[
{
"self" : "https://api.tracker.yandex.net/v2/issues/TREK-1/comments/626",
"id" : 626,
"longId" : "5fa15a24ac894475********",
"text" : "Текст комментария",
"createBody" : {
"self" : "https://api.tracker.yandex.net/v2/users/11********",
"id" : "11********",
"display" : "Иван Иванов"
},
"updateBody" : {
"self" : "https://api.tracker.yandex.net/v2/users/11********",
"id" : "11********",
"display" : "Иван Иванов"
},
"createdAt" : "2020-11-03T13:24:52.575+0000",
"updatedAt" : "2020-11-03T13:24:52.575+0000",
"summonees" : [
{
"self" : "https://api.tracker.yandex.net/v2/users/11********",
"id" : "11********",
"display" : "Иван Иванов"
}
],
"maillistSummonees" : [
{
"self" : "https://api.tracker.yandex.net/v2/maillists/usertest@test.ru",
"id" : "usertest@test.ru",
"display" : "Рассылка от Ивана"
}
],
"version" : 1,
"type" : "standard",
"transport" : "internal"
}
]
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на комментарий. | Строка |
| id | Идентификатор комментария. | Число |
| longId | Идентификатор комментария в формате строки. | Строка |
| text | Комментарий к задаче. | Строка |
| createdBy | Блок с информацией о пользователе, который добавил комментарий. | Объект |
| updatedBy | Блок с информацией о пользователе, который последним изменил комментарий. | Объект |
| createdAt | Дата и время создания комментария. | Строка |
| updatedAt | Дата и время обновления комментария. | Строка |
| summonees | Блок с информацией о пользователях, которые призваны в комментарии. | Объект |
| maillistsummonees | Блок с информацией о рассылках, которые призваны в комментарии. | Объект |
| version | Версия комментария. Каждое изменение комментария увеличивает номер версии. | Число |
| type | Тип комментария:
|
Строка |
| transport | Способ добавления комментария:
|
Строка |
Поля объекта createdBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
Поля объекта updatedBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
Поля объекта summonees
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
Поля объекта maillistsummonees
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на рассылку. | Строка |
| id | Адрес рассылки. | Строка |
| display | Отображаемое имя рассылки. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.