Создать чеклист или добавить в него пункты
Запрос позволяет создать чеклист и добавить в него новые пункты.
POST
https://api.tracker.yandex.net/v3/issues/<id_задачи>/checklistItems
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы создать чеклист или добавить в него новые пункты, используйте HTTP-запрос с методом POST
. В теле запроса укажите параметры в формате JSON.
POST /v3/issues/<id_задачи>/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. -
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.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
Параметры тела запроса
Тело запроса содержит информацию, необходимую для создания чеклиста или добавления в него пункта:
Обязательные параметры
Параметр | Описание | Тип данных |
---|---|---|
text | Текст пункта. | Строка |
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
checked | Отметка о выполнении пункта:
|
Логический |
assignee | Идентификатор или логин пользователя, который назначен исполнителем пункта чеклиста. | Строка |
deadline | Дедлайн пункта чеклиста. | Объект |
Поля объекта deadline
Параметр | Описание | Тип данных |
---|---|---|
date | Дата дедлайна в формате YYYY-MM-DDThh:mm:ss.sss±hhmm . |
Дата |
deadlineType | Тип данных параметра deadline . |
Строка |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит JSON-объект с параметрами чеклиста и задачи, в которую он был добавлен.
{
"self": "https://api.tracker.yandex.net/v3/issues/ORG-3",
"id": "5f981c00b982f075********",
"key": "ORG-3",
"version": 133,
"lastCommentUpdatedAt": "2020-12-13T13:18:22.965+0000",
"pendingReplyFrom": [
{
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия"
}
],
"summary": "My issue",
"statusStartTime": "2020-11-03T11:19:24.733+0000",
"updatedBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия"
},
"description": "My description",
"type": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/2",
"id": "2",
"key": "task",
"display": "Задача"
},
"priority": {
"self": "https://api.tracker.yandex.net/v3/priorities/3",
"id": "3",
"key": "normal",
"display": "Средний"
},
"previousStatusLastAssignee": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия"
},
"createdAt": "2020-10-27T13:09:20.085+0000",
"followers": [
{
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия"
}
],
"createdBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия"
},
"checklistItems": [
{
"id": "5fde5f0a1aee261d********",
"text": "List item text",
"textHtml": "List item text in HTML",
"checked": false,
"checklistItemType": "standard"
}
],
"votes": 0,
"assignee": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия"
},
"deadline": "2020-10-28",
"queue": {
"self": "https://api.tracker.yandex.net/v3/queues/ORG",
"id": "1",
"key": "ORG",
"display": "My queue"
},
"updatedAt": "2020-12-19T20:14:02.648+0000",
"status": {
"self": "https://api.tracker.yandex.net/v3/statuses/1",
"id": "1",
"key": "open",
"display": "Открыт"
},
"previousStatus": {
"self": "https://api.tracker.yandex.net/v3/statuses/3",
"id": "3",
"key": "resolved",
"display": "Решен"
},
"favorite": false
}
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о задаче. | Строка |
id | Идентификатор задачи. | Строка |
version | Версия задачи. Каждое изменение параметров увеличивает номер версии. Редактирование задачи будет заблокировано, если версия достигнет предельного значения: для роботов 10100 , для пользователей 11100 . |
Число |
key | Ключ задачи. | Строка |
pendingReplyFrom | Объект с информацией о сотруднике, от которого ожидается ответ. | Объект |
lastCommentUpdatedAt | Время обновления последнего комментария. | Строка |
summary | Название задачи. | Строка |
statusStartTime | Время создание задачи. | Строка |
updatedBy | Объект с информацией о последнем сотруднике, изменявшим задачу. | Объект |
description | Описание задачи. | Строка |
type | Объект с информацией о типе задачи. | Объект |
priority | Объект с информацией о приоритете. | Объект |
previousStatusLastAssignee | Объект с информацией об исполнителе задачи в предыдущем статусе. | Объект |
createdAt | Дата и время создания задачи. | Строка |
followers | Массив объектов с информацией о наблюдателях задачи. | Объект |
createdBy | Объект с информацией о создателе задачи. | Объект |
checklistItems | Массив объектов с информацией о пунктах чеклиста. | Объект |
votes | Количество голосов за задачу. | Число |
assignee | Объект с информацией об исполнителе задачи. | Объект |
deadline | Крайний срок выполнения задачи. | Строка |
updatedAt | Дата и время последнего обновления задачи. | Строка |
queue | Объект с информацией об очереди задачи. | Объект |
status | Объект с информацией о статусе задачи. | Объект |
previousStatus | Объект с информацией о предыдущем статусе задачи. | Объект |
favorite | Признак избранной задачи:
|
Число |
Поля объекта updatedBy
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта pendingReplyFrom
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта type
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о типе задаче. | Строка |
id | Идентификатор типа задачи. | Строка |
key | Ключ типа задачи. | Строка |
display | Отображаемое название типа задачи. | Строка |
Поля объекта priority
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о приоритете. | Строка |
id | Идентификатор приоритета. | Строка |
key | Ключ приоритета. | Строка |
display | Отображаемое название приоритета. | Строка |
Поля объекта previousStatusLastAssignee
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта followers
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта createdBy
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта checklistItems
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор пункта чеклиста. | Строка |
text | Текст пункта чеклиста. | Строка |
textHtml | Текст пункта чеклиста в формате HTML. | Строка |
checked | Признак выполнения пункта чеклиста:
|
Логический |
assignee | Исполнитель пункта чеклиста. | Объект |
deadline | Крайний срок исполнения пункта чеклиста. | Объект |
checklistItemType | Тип пункта чеклиста. | Строка |
Поля объекта assignee
(пункт чеклиста)
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор пользователя. | Число |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя на Яндексе. | Число |
login | Логин пользователя. | Строка |
firstName | Имя пользователя. | Строка |
lastName | Фамилия пользователя. | Строка |
Адрес пользователя. | Строка | |
trackerUid | Уникальный идентификатор аккаунта пользователя в Трекере. | Число |
Поля объекта deadline
(пункт чеклиста)
Параметр | Описание | Тип данных |
---|---|---|
date | Предельный срок в формате YYYY-MM-DDThh:mm:ss.sss±hhmm . |
Дата |
deadlineType | Тип дедлайна:
|
Строка |
isExceeded | Признак наступления дедлайна:
|
Логический |
Поля объекта queue
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Строка |
key | Ключ очереди. | Строка |
display | Отображаемое название очереди. | Строка |
Поля объекта status
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о статусе. | Строка |
id | Идентификатор статуса. | Строка |
key | Ключ статуса. | Строка |
display | Отображаемое название статуса. | Строка |
Поля объекта previousStatus
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о статусе. | Строка |
id | Идентификатор статуса. | Строка |
key | Ключ статуса. | Строка |
display | Отображаемое название статуса. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 423
- Редактирование объекта заблокировано. Возможно, превышено допустимое значение параметра
version
— количество обновлений объекта. Максимальное значение версии составляет10100
для роботов и11100
для пользователей.