Подключиться
Yandex Tracker

Удалить чеклист

Статья создана

Запрос позволяет удалить чеклист из задачи.

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

Чтобы удалить чеклист из задачи, используйте HTTP-запрос с методом DELETE:

DELETE /v2/issues/<issue-id>/checklistItems
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>

Заголовки

  • Host

    Адрес узла, предоставляющего API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <значение токена>, например:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

    Идентификатор организации.

Ресурс

  • <issue-id>
    Идентификатор или ключ задачи.

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK. Тело ответа содержит JSON-объект с параметрами задачи, из которой был удален чеклист.

{
    "self": "https://api.tracker.yandex.net/v2/issues/ORG-3",
    "id": "5f981c00b982f0755dbdc13d",
    "key": "ORG-3",
    "version": 147,
    "lastCommentUpdatedAt": "2020-12-13T13:18:22.965+0000",
    "pendingReplayFrom": [
        {
            "self": "https://api.tracker.yandex.net/v2/users/1134669289",
            "id": "id сотрудника",
            "display": "Имя Фамилия"
        }
    ],
    "summary": "Название задачи",
    "statusStartTime": "2020-11-03T11:19:24.733+0000",
    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v2/users/19904929",
        "id": "id сотрудника",
        "display": "Имя Фамилия"
    },
    "checklistDone": "0",
    "description": "Описание задачи",
    "type": {
        "self": "https://api.tracker.yandex.net/v2/issuetypes/2",
        "id": "2",
        "key": "task",
        "display": "Задача"
    },
    "priority": {
        "self": "https://api.tracker.yandex.net/v2/priorities/3",
        "id": "3",
        "key": "normal",
        "display": "Средний"
    },
    "previousStatusLastAssignee": {
        "self": "https://api.tracker.yandex.net/v2/users/1134669289",
        "id": "id сотрудника",
        "display": "Имя Фамилия"
    },
    "createdAt": "2020-10-27T13:09:20.085+0000",
    "followers": [
        {
            "self": "https://api.tracker.yandex.net/v2/users/19904929",
            "id": "id сотрудника",
            "display": "Имя Фамилия"
        }
    ],
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v2/users/1134669289",
        "id": "id сотрудника",
        "display": "Имя Фамилия"
    },
   "checklistTotal": 4,
   "votes": 0,
   "assignee": {
        "self": "https://api.tracker.yandex.net/v2/users/1134669289",
        "id": "id сотрудника",
        "display": "Имя Фамилия"
    },
   "deadline": "2020-10-28",
   "queue": {
        "self": "https://api.tracker.yandex.net/v2/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Стартрек"
    },
   "updatedAt": "2021-02-16T08:28:41.095+0000",
   "status": {
        "self": "https://api.tracker.yandex.net/v2/statuses/2",
        "id": "2",
        "key": "needInfo",
        "display": "Требуется информация"
    },
    "previousStatus": {
        "self": "https://api.tracker.yandex.net/v2/statuses/3",
        "id": "3",
        "key": "inProgress",
        "display": "В работе"
    },
    "favorite": false
}

Параметры ответа

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о задаче. Строка
id Идентификатор задачи. Число
key Ключ задачи. Строка
version Версия задачи. Каждое изменение параметров увеличивает номер версии. Число
lastCommentUpdatedAt Время обновления последнего комментария. Строка
pendingReplayFrom Объект с информацией о сотруднике, от которого ожидается ответ. Объект
summary Название задачи. Строка
statusStartTime Время создание задачи. Строка
updatedBy Объект с информацией о последнем сотруднике, изменявшим задачу. Объект
checklistDone Количество пунктов в чеклисте, которые отмечены как выполненные. Число
description Описание задачи. Строка
type Объект с информацией о типе задачи. Объект
priority Объект с информацией о приоритете. Объект
previousStatusLastAssignee Объект с информацией об исполнителе задачи в предыдущем статусе. Объект
createdAt Дата и время создания задачи. Строка
followers Массив объектов с информацией о наблюдателях задачи. Объект
createdBy Объект с информацией о создателе задачи. Объект
checklistTotal Количество пунктов в чеклисте. Число
votes Количество голосов за задачу. Число
assignee Объект с информацией об исполнителе задачи. Объект
deadline Крайний срок выполнения задачи. Строка
queue Объект с информацией об очереди задачи. Объект
updatedAt Дата и время последнего обновления задачи. Строка
status Объект с информацией о статусе задачи. Объект
previousStatus Объект с информацией о предыдущем статусе задачи. Объект
favorite Признак избранной задачи:
  • true — пользователь добавил задачу в избранное;
  • false — задача не добавлена в избранное.
 Число

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
self Ссылка на тип задачи. Строка
id Идентификатор типа задачи. Строка
key Ключ типа задачи. Строка
display Отображаемое название типа задачи. Строка

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

Параметр Описание Тип данных
self Ссылка на тип приоритета. Строка
id Идентификатор приоритета. Строка
key Ключ приоритета. Строка
display Отображаемое название приоритета. Строка

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
self Ссылка на очередь. Строка
id Идентификатор очереди. Число
key Ключ очереди. Строка
display Отображаемое название очереди. Строка

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

Параметр Описание Тип данных
self Ссылка на статус. Строка
id Идентификатор статуса. Строка
key Ключ статуса. Строка
display Отображаемое название статуса. Строка

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

Параметр Описание Тип данных
self Ссылка на статус. Строка
id Идентификатор статуса. Строка
key Ключ статуса. Строка
display Отображаемое название статуса. Строка

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

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