Удалить сущность

Запрос позволяет удалить сущность — цель, проект или портфель проектов.

DELETE

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

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

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

Чтобы удалить сущность, используйте HTTP-запрос с методом DELETE.

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

  • 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. Строка
Параметры запроса

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

Параметр Описание Тип данных
withBoard Удалить вместе с доской. Логический

Пример: Удалить проект

  • Используется HTTP-метод DELETE.
  • Вместе с проектом удаляется доска задач.
DELETE https://api.tracker.yandex.net/v3/entities/project/655f328da834c763********?withBoard=true

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

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

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

401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Изменить сущность
Следующая
Получить список сущностей