Удалить комментарий
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет удалить комментарий сущности.
Формат запроса
Перед выполнением запроса получите доступ к API.
Для удаления комментария используйте HTTP-запрос с методом DELETE.
DELETE /v2/entities/<тип_сущности>/<идентификатор_сущности>/comments/<идентификатор_комментария>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
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 для бизнеса, используется заголовок
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <тип_сущности> | Тип сущности:
|
Строка |
| <идентификатор_сущности> | Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. | Строка |
| <идентификатор_проекта_или_портфеля> | Идентификатор проекта или портфеля (значение поля shortId). Его можно использовать в запросе вместо идентификатора сущности. |
Строка |
| <идентификатор_комментария> | Уникальный идентификатор комментария. | Строка или число |
Важно
Идентификатор сущности не совпадает с идентификатором проекта или портфеля.
Параметры запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| notify | Уведомлять пользователей, которые указаны в полях Автор, Ответственный, Участники, Заказчики и Наблюдатели. Значение по умолчанию — true. |
Логический |
| notifyAuthor | Уведомлять автора изменений. Значение по умолчанию — false. |
Логический |
Пример: Удалить комментарий
- Используется HTTP-метод DELETE.
DELETE /v2/entities/project/<идентификатор_проекта>/comments/16 Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 204.
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.