Связаться с намиПодключиться

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

Статья создана
Обновлена 26 августа 2024 г.

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

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

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

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

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

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

  • 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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<тип_сущности> Тип сущности:
  • project — проект;
  • portfolio — портфель.
 Строка
<идентификатор_сущности> Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. Строка
<идентификатор_проекта_или_портфеля> Идентификатор проекта или портфеля (значение поля shortId). Его можно использовать в запросе вместо идентификатора сущности. Строка
<идентификатор_комментария> Уникальный идентификатор комментария. Строка или число

Важно

Идентификатор сущности не совпадает с идентификатором проекта или портфеля.

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

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

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

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

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

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

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

  • Используется HTTP-метод PATCH.
  • Изменяется текст комментария: «Измененный текст комментария».
  • Изменяется список призванных в комментарии.
PATCH /v2/entities/project/<идентификатор_проекта>/comments/31
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

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

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

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

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

{
    "self": "api.tracker.yandex.net/v2/entities/project/6586d6fee2b9ef74********/comments/31", 
    "id": 31, 
    "longId": "65a1ba7b46b9746d********", 
    "text": "Измененный текст комментария.", 
    "createdBy": {
        "self": "api.tracker.yandex.net/v2/users/19********",
        "id": "19********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": "15********"
    },
    "updatedBy": {
        "self": "api.tracker.yandex.net/v2/users/19********",
        "id": "19********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": "15********"
    }, 
    "createdAt": "2024-01-12T22:17:31.176+0000", 
    "updatedAt": "2024-01-12T22:17:31.176+0000", 
    "summonees": [
        {
            "self": "api.tracker.yandex.net/v2/users/19********",
            "id": "19********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": "15********"
        },
        {
            "self": "api.tracker.yandex.net/v2/users/19********",
            "id": "19********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp32********",
            "passportUid": "12********"
        }
    ],
    "maillistSummonees" : [
        {
            "self" : "api.tracker.yandex.net/v2/maillists/usertest@test.ru",
            "id" : "usertest@test.ru",
            "display" : "Рассылка от Ивана"
 } 
], 
    "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 — отправлен через интерфейс Tracker;
  • incoming — создан из входящего письма;
  • outcoming — создан из исходящего письма.
 Строка
transport Способ добавления комментария:
  • internal — через интерфейс Tracker;
  • email — через письмо.
 Строка

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

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

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

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

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

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