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

Редактировать чеклист

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

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

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

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

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

[
 {
  "text": "Текст в пункте",
  "checked": true,
  "assignee": "11********",
  "deadline": {
        "date": "2021-05-25T00:00:00.000+0000",
        "deadlineType": "date"
      }
 },
 ...
]
Заголовки

  • 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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_задачи> Идентификатор или ключ задачи. Строка
<идентификатор_пункта_чеклиста> Идентификатор пункта чеклиста. Чтобы получить идентификатор, выполните запрос. Строка
Параметры тела запроса

Тело запроса содержит параметры пунктов чеклиста. В теле должны быть перечислены все пункты.

Обязательные параметры

Параметр Описание Тип данных
text Текст пункта чеклиста. Строка

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

Параметр Описание Тип данных
checked Признак выполнения пункта чеклиста:
  • true — пункт отмечен как выполненный;
  • false — пункт не отмечен как выполненный.
 Логический
assignee Идентификатор или логин пользователя, который является исполнителем пункта чеклиста. Строка
deadline Дедлайн пункта чеклиста. Объект

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

Параметр Описание Тип данных
date Дата дедлайна в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Дата
deadlineType Тип данных параметра deadline. Строка

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

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

Тело ответа содержит JSON-объект с параметрами пунктов чеклиста и параметрами задачи, в которой чеклист был изменен.

{
    "self": "https://api.tracker.yandex.net/v2/issues/ORG-3",
    "id": "5f981c00b982f075********",
    "key": "ORG-3",
    "version": 184,
    "lastCommentUpdatedAt": "2021-02-06T17:14:22.965+0000",
    "pendingReplyFrom": [
        {
            "self": "https://api.tracker.yandex.net/v2/users/12********",
            "id": "12********",
            "display": "Имя Фамилия"
        }
    ],
    "summary": "Название задачи",
    "statusStartTime": "2020-11-03T11:19:24.733+0000",
    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v2/users/19********",
        "id": "19********",
        "display": "Имя Фамилия"
    },
    "checklistDone": "2",
    "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/12********",
        "id": "12********",
        "display": "Имя Фамилия"
    },
    "createdAt": "2020-10-27T13:09:20.085+0000",
    "followers": [
        {
            "self": "https://api.tracker.yandex.net/v2/users/19********",
            "id": "19********",
            "display": "Имя Фамилия"
        }
    ],
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v2/users/12********",
        "id": "12********",
        "display": "Имя Фамилия"
    },
    "checklistItems": [
      {
            "id": "5fde5f0a1aee261d********",
            "text": "пункт чеклиста",
            "textHtml": "текст пункта в формате HTML",
            "checked": false,
            "assignee": {
               "id": 11********,
               "display": "Имя Фамилия",
               "passportUid": 11********,
               "login": "user_login",
               "firstName": "Имя",
               "lastName": "Фамилия",
               "email": "user_login@example.com",
               "trackerUid": 11********
               },
            "deadline": {
               "date": "2021-05-09T00:00:00.000+0000",
               "deadlineType": "date",
               "isExceeded": false
               },
            "checklistItemType": "standard"  
      }, 
      ...
     ], 
    },
   "checklistTotal": 4,
   "votes": 0,
   "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 Время обновления последнего комментария. Строка
pendingReplyFrom Объект с информацией о сотруднике, от которого ожидается ответ. Объект
summary Название задачи. Строка
statusStartTime Время создание задачи. Строка
updatedBy Объект с информацией о последнем сотруднике, изменявшим задачу. Объект
checklistDone Количество пунктов в чеклисте, которые отмечены как выполненные. Число
description Описание задачи. Строка
type Объект с информацией о типе задачи. Объект
priority Объект с информацией о приоритете. Объект
previousStatusLastAssignee Объект с информацией об исполнителе задачи в предыдущем статусе. Объект
createdAt Дата и время создания задачи. Строка
followers Массив объектов с информацией о наблюдателях задачи. Объект
createdBy Объект с информацией о создателе задачи. Объект
checklistItems Массив объектов с информацией о пунктах чеклиста. Объект
checklistTotal Количество пунктов в чеклисте. Число
votes Количество голосов за задачу. Число
deadline Крайний срок выполнения задачи. Строка
queue Объект с информацией об очереди задачи. Объект
updatedAt Дата и время последнего обновления задачи. Строка
status Объект с информацией о статусе задачи. Объект
previousStatus Объект с информацией о предыдущем статусе задачи. Объект
favorite Признак избранной задачи:
  • true — пользователь добавил задачу в избранное;
  • false — задача не добавлена в избранное.
 Число

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

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

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

Параметр Описание Тип данных
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 Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
id Идентификатор пункта чеклиста. Строка
text Текст пункта чеклиста. Строка
textHtml Текст пункта чеклиста в формате HTML. Строка
checked Признак выполнения пункта чеклиста:
  • true — пункт отмечен как выполненный;
  • false — пункт не отмечен как выполненный.
 Логический
assignee Исполнитель пункта чеклиста. Объект
deadline Крайний срок исполнения пункта чеклиста. Объект
checklistItemType Тип пункта чеклиста. Строка

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

Параметр Описание Тип данных
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя на Яндексе. Число
login Логин пользователя. Строка
firstName Имя пользователя. Строка
lastName Фамилия пользователя. Строка
email Адрес пользователя. Строка
trackerUid Уникальный идентификатор аккаунта пользователя в Tracker. Число

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

Параметр Описание Тип данных
date Предельный срок в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Дата
deadlineType Тип данных параметра deadline. Строка
isExceeded Признак наступления дедлайна:
  • true — предельный срок наступил;
  • false — предельный срок не наступил.
 Логический

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

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

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

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

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

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

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

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