Создать чеклист или добавить в него пункты

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

Обновлена 26 августа 2024 г.

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

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

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

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

Чтобы создать чеклист или добавить в него новые пункты, используйте HTTP-запрос с методом POST. Информация о новых пунктах передается в его теле в формате JSON.

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

{
  "text": "<текст_пункта>",
  "checked": true,
  "assignee": "<логин_или_идентификатор_исполнителя>",
  "deadline": {
    "date": "2021-05-09T00: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 для бизнеса.

Ресурс

Параметр	Описание	Тип данных
<тип_сущности>	Тип сущности: project — проект; portfolio — портфель.	Строка
<идентификатор_сущности>	Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей.	Строка
<идентификатор_проекта_или_портфеля>	Идентификатор проекта или портфеля (значение поля `shortId`). Его можно использовать в запросе вместо идентификатора сущности.	Строка

Важно

Идентификатор сущности не совпадает с идентификатором проекта или портфеля.

Параметры запроса

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

Параметр	Описание	Тип данных
notify	Уведомлять пользователей, которые указаны в полях Автор, Ответственный, Участники, Заказчики и Наблюдатели. Значение по умолчанию — `true`.	Логический
notifyAuthor	Уведомлять автора изменений. Значение по умолчанию — `false`.	Логический
fields	Дополнительные поля сущности, которые будут включены в ответ.	Строка
expand	Дополнительная информация, которая будет включена в ответ: `attachments` — вложенные файлы.	Строка

Параметры тела запроса

Тело запроса содержит информацию, необходимую для добавления в чеклист пунктов:

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

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

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

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

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

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

Пример: Добавить два пункта в чеклист

Используется HTTP-метод POST.

В чеклист добавляется пункт: «Первый пункт чеклиста».

В чеклист добавляется пункт: «Второй пункт чеклиста», отмеченный как выполненный.

В ответе выводится информация о всех пунктах чеклиста (fields=checklistItems).
POST /v2/entities/project/<идентификатор_проекта>/checklistItems?fields=checklistItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

[
  {
     "text":"Первый пункт чеклиста."
  },
  {
     "text":"Второй пункт чеклиста.",
     "checked": true
  }
]

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

Запрос выполнен успешно

Запрос выполнен с ошибкой

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

Тело ответа содержит информацию о сущности, о вложениях сущности и о пунктах чеклиста в формате JSON.

{
    "self": "https://api.tracker.yandex.net/v2/entities/project/6586d6fee2b9ef74********", 
    "id": "6586d6fee2b9ef74********",
    "version": 133,
    "shortId": 0,
    "entityType": "project",
    "createdBy": {
        "self": "api.tracker.yandex.net/v2/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, 
               "checklistItemType": "standard"
           },
           {
               "id": "6586d91f99a40477********", 
               "text": "Второй пункт чеклиста.", 
               "checked": true, 
               "checklistItemType": "standard"
           }
        ]
    }
}

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о сущности.	Строка
id	Идентификатор сущности.	Строка
version	Версия сущности. Каждое изменение параметров увеличивает номер версии.	Число
shortId	Идентификатор проекта или портфеля.	Число
entityType	Тип сущности: project — проект; portfolio — портфель.	Строка
createdBy	Объект с информацией о создателе сущности.	Объект
createdAt	Дата создания сущности в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`.	Строка
updatedAt	Дата последнего обновления сущности в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`.	Строка
fields	Дополнительные поля сущности.	Объект

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Число
display	Отображаемое имя пользователя.	Строка
cloudUid	Уникальный идентификатор пользователя в Yandex Cloud Organization.	Строка
passportUid	Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID.	Строка

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

Параметр	Описание	Тип данных
checklistItems	Информация о пунктах чеклиста.	Массив объектов

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

Параметр	Описание	Тип данных
id	Идентификатор пункта чеклиста.	Число
text	Текст пункта чеклиста.	Строка
checked	Отметка о выполнении пункта: `true` — пункт отмечен как выполненный; `false` — пункт не отмечен как выполненный.	Логический
checklistItemType	Тип пункта чеклиста: standard; metric; criterion; filter.	строка

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

400: Один или несколько параметров запроса имеют недопустимое значение.

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

422: Ошибка валидации JSON, запрос отклонен.

Создать чеклист или добавить в него пункты

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

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

Была ли статья полезна?

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

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