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

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

POST

https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/comments

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

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

Чтобы добавить комментарий к сущности, используйте HTTP-запрос с методом POST. В теле запроса укажите параметры в формате JSON.

POST /v3/entities/<тип_сущности>/<id_сущности>/comments
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "text": "<текст_комментария>",
  "summonees": ["<логины_или_идентификаторы_призванных>"]
}
Заголовки

  • 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.

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

Ресурс
Параметр Описание Тип данных
<тип_сущности> Тип сущности:
  • project — проект;
  • portfolio — портфель;
  • goal — цель
 Строка
<id_сущности> Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. В качестве идентификатора можно использовать параметр id или shortId. Строка
Параметры запроса

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

Параметр Описание Тип данных
isAddToFollowers Добавить автора комментария в наблюдатели. Значение по умолчанию — true. Логический
notify Уведомлять пользователей, которые указаны в полях Автор, Ответственный, Участники, Заказчики и Наблюдатели. Значение по умолчанию — true. Логический
notifyAuthor Уведомлять автора изменений. Значение по умолчанию — false. Логический
expand Дополнительная информация, которая будет включена в ответ:
  • all — все;
  • html — HTML-разметка комментария;
  • attachments — вложенные файлы;
  • reactions — реакции на комментарий.
 Строка
Параметры тела запроса

Тело запроса содержит информацию, необходимую для добавления комментария:

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

Параметр Описание Тип данных
text Текст комментария. Строка

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

Параметр Описание Тип данных
attachmentIds Идентификаторы временных файлов, которые будут добавлены как вложения. Массив строк
summonees Идентификаторы или логины призванных пользователей. Массив объектов или строк
maillistSummonees Список рассылок, призванных в комментарии. Массив строк

Пример: Добавить комментарий

  • Используется HTTP-метод POST.
  • В сущность (проект) добавляется комментарий: «Текст комментария».
  • Призывается пользователь.
POST /v3/entities/project/<id_проекта>/comments
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
   "text":"<текст_комментария>",
   "summonees": [<идентификатор_пользователя>]
}

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

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

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

{
    "self": "https://api.tracker.yandex.net/v3/entities/project/6586d6fee2b9ef74********/comments/22", 
    "id": 22, 
    "longId": "65a1ba7b46b9746d********", 
    "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": "2024-01-12T22:17:31.176+0000", 
    "updatedAt": "2024-01-12T22:17:31.176+0000", 
    "summonees": [
        {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp32********",
            "passportUid": 11********
        }
    ],
    "version": 1, 
    "type": "standard", 
    "transport": "internal"
}
Параметры ответа
Параметр Описание Тип данных
self Ссылка на объект комментария. Строка
id Идентификатор комментария. Число
longId Идентификатор комментария в виде строки. Строка
text Текст комментария. Строка
textHtml HTML-разметка комментария. Строка
attachments Вложения. Строка
createdBy Объект с информацией о создателе комментария. Объект
updatedBy Объект с информацией о сотруднике, внесшем последнее изменение в комментарий. Объект
createdAt Дата и время создания комментария в формате:
YYYY-MM-DDThh:mm:ss.sss±hhmm.		 Строка
updatedAt Дата и время обновления комментария в формате:
YYYY-MM-DDThh:mm:ss.sss±hhmm.		 Строка
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. Строка

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

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