Создать чеклист или добавить в него пункты
Запрос позволяет создать чеклист в проекте или портфеле и добавить в него новые пункты. Новые пункты добавляются в конец списка. Подробнее о чеклистах см. в разделе Как создать чеклист.
POST
https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/checklistItems
Чтобы добавить чеклист в проект или портфель, вы также можете использовать запрос Изменить сущность. В теле запроса передайте объект fields с вложенным массивом checklistItems: см. Дополнительные параметры сущности.
Чтобы получить чеклист проекта или портфеля, используйте запрос Получить параметры сущности с параметром fields=checklistItems.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы создать чеклист или добавить в него новые пункты, используйте HTTP-запрос с методом POST. Информация о новых пунктах передается в его теле в формате JSON.
POST /v3/entities/<тип_сущности>/<id_сущности>/checklistItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"text": "Item text",
"checked": true,
"assignee": "username",
"deadline": {
"date": "2021-05-09T00:00:00.000+0000",
"deadlineType": "date"
}
}
Заголовки
-
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 | Дополнительная информация, которая будет включена в ответ:
|
Строка |
Параметры тела запроса
Тело запроса содержит информацию, необходимую для добавления в чеклист пунктов:
Обязательные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| text | Текст пункта чеклиста. | Строка |
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| checked | Отметка о выполнении пункта:
|
Логический |
| assignee | Идентификатор или логин пользователя, который является исполнителем пункта чеклиста. | Число или строка |
| deadline | Дедлайн пункта чеклиста. | Объект |
Поля объекта deadline
| Параметр | Описание | Тип данных |
|---|---|---|
| date | Дата дедлайна в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. |
Дата |
| deadlineType | Тип данных параметра deadline. |
Строка |
Пример: Добавить два пункта в чеклист
- Используется HTTP-метод POST.
- В чеклист добавляется пункт: "First list item".
- В чеклист добавляется пункт: "Second list item", отмеченный как выполненный.
- В ответе выводится информация о всех пунктах чеклиста (
fields=checklistItems).POST /v3/entities/project/<id_проекта>/checklistItems?fields=checklistItems Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> [ { "text": "First list item" }, { "text": "Second list item", "checked": true } ]
Формат ответа
В случае успешного выполнения запроса 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",
"fields": {
"checklistItems": [
{
"id": "6586d91f99a40477********",
"text": "First list item",
"checked": false,
"checklistItemType": "standard"
},
{
"id": "6586d91f99a40477********",
"text": "Second list item",
"checked": true,
"checklistItemType": "standard"
}
]
}
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| 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. | Строка |
Поля объекта fields
| Параметр | Описание | Тип данных |
|---|---|---|
| checklistItems | Информация о пунктах чеклиста. | Массив объектов |
Поля объекта checklistItems
| Параметр | Описание | Тип данных |
|---|---|---|
| id | Идентификатор пункта чеклиста. | Строка |
| text | Текст пункта чеклиста. | Строка |
| textHtml | Текст пункта чеклиста в формате HTML. | Строка |
| checked | Признак выполнения пункта чеклиста:
|
Логический |
| assignee | Исполнитель пункта чеклиста. | Объект |
| deadline | Крайний срок исполнения пункта чеклиста. | Объект |
| checklistItemType | Тип пункта чеклиста. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 423
- Редактирование объекта заблокировано. Возможно, превышено допустимое значение параметра
version— количество обновлений объекта. Максимальное значение версии составляет10100для роботов и11100для пользователей.