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

Запрос позволяет редактировать пункты чеклиста (в проектах и портфелях) или списка ключевых результатов (в целях).

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

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

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

Чтобы изменить пункты в чеклисте, используйте HTTP-запрос с методом PATCH. В теле запроса укажите параметры в формате JSON.

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

{
  "id": "<идентификатор_пункта>",
  "text": "<текст_пункта>",
  "checked": true,
  "assignee": "<логин_или_идентификатор_исполнителя>",
  "deadline": {
    "date": "2021-05-09T00:00:00.000+0000",
    "deadlineType": "date"
  }
}

Пример: Изменить два пункта в чеклисте

• Используется HTTP-метод PATCH.
• В первом пункте чеклиста меняется название на «Измененный первый пункт чеклиста». Значения остальных полей сбрасываются (исполнитель, дедлайн, отметка о выполнении и тип пункта).
• Во втором пункте изменяется исполнитель и ставится отметка о выполнении. Значения остальных полей сбрасываются (дедлайн и тип пункта).
• В ответе выводится информация о всех пунктах чеклиста (fields=checklistItems).

PATCH /v3/entities/project/<id_проекта>/checklistItems?fields=checklistItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

[
  {
     "id": "658953a65c0f1b21********",
     "text":"Измененный первый пункт чеклиста."
  },
  {
     "id": "658953a65c0f1b21********",
     "text":"Второй пункт чеклиста.",
     "assignee": 19*********,
     "checked": true
  }
]

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

{
    "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/19********",
        "id": "19********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": "15********"
    },
    "createdAt": "2023-12-13T15:06:27.231Z",
    "updatedAt": "2023-12-13T15:06:27.231Z",
    "fields": {
        "checklistItems": [
           {
               "id": "6586d91f99a40477********", 
               "text": "Измененный первый пункт чеклиста.", 
               "checked": false, 
               "assignee": {
                  "id": 133******,
                  "passportUid": 133******,
                  "login": "username",
                  "display": "Имя Фамилия",
                  ...
                },
               "checklistItemType": "standard"
           },
           {
               "id": "6586d91f99a40477********", 
               "text": "Второй пункт чеклиста.", 
               "checked": true, 
               "checklistItemType": "standard"
           }
        ]
    }
}