Удалить чеклист
Запрос позволяет удалить все пункты чеклиста в проектах и портфелях. Действие не может быть отменено.
DELETE
https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/checklistItems
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы удалить все пункты в чеклисте, используйте HTTP-запрос с методом DELETE
.
DELETE /v3/entities/<тип_сущности>/<id_сущности>/checklistItems
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.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<тип_сущности> | Тип сущности:
|
Строка |
<id_сущности> | Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. В качестве идентификатора можно использовать параметр id или shortId . |
Строка |
Параметры запроса
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
notify | Уведомлять пользователей, которые указаны в полях Автор, Ответственный, Участники, Заказчики и Наблюдатели. Значение по умолчанию — true . |
Логический |
notifyAuthor | Уведомлять автора изменений. Значение по умолчанию — false . |
Логический |
fields | Дополнительные поля сущности, которые будут включены в ответ. | Строка |
expand | Дополнительная информация, которая будет включена в ответ:
|
Строка |
Пример: Удалить все пункты в чеклисте
- Используется HTTP-метод DELETE.
- В чеклисте удаляются все пункты.
DELETE https://api.tracker.yandex.net/v3/entities/project/<id_проекта>/checklistItems
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит JSON-объект с параметрами сущности, из которой удален чеклист.
{
"self": "https://api.tracker.yandex.net/v3/entities/project/6586d6fee2b9ef74********",
"id": "6586d6fee2b9ef74********",
"version": 133,
"shortId": 0,
"entityType": "project",
"createdBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 11********
},
"createdAt": "2023-12-13T15:06:27.231Z",
"updatedAt": "2023-12-13T15:06:27.231Z"
}
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о сущности | Строка |
id | Идентификатор сущности | Строка |
version | Версия сущности. Каждое изменение параметров увеличивает номер версии. Редактирование сущности будет заблокировано, если версия достигнет предельного значения: для роботов 10100 , для пользователей 11100 |
Число |
shortId | Числовой идентификатор сущности | Число |
entityType | Тип сущности | Строка |
createdBy | Блок с информацией о создателе сущности | Объект |
createdAt | Дата создания сущности в формате YYYY-MM-DDThh:mm:ss.sss±hhmm |
Строка |
updatedAt | Дата последнего обновления сущности в формате YYYY-MM-DDThh:mm:ss.sss±hhmm |
Строка |
fields | Блок с дополнительными полями сущности | Объект |
Поля объекта createdBy
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 423
- Редактирование объекта заблокировано. Возможно, превышено допустимое значение параметра
version
— количество обновлений объекта. Максимальное значение версии составляет10100
для роботов и11100
для пользователей.