Получить параметры чеклиста
Запрос позволяет получить параметры чеклиста в задаче.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы получить параметры чеклиста, используйте HTTP-запрос с методом GET:
GET /v2/issues/<ключ_или_идентификатор_задачи>/checklistItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
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 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <ключ_или_идентификатор_задачи> | Идентификатор или ключ задачи | Строка |
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит информацию о пунктах чеклиста в формате JSON.
{
"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"
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| id | Идентификатор пункта чеклиста. | Строка |
| text | Текст пункта чеклиста. | Строка |
| textHtml | Текст пункта чеклиста в формате HTML. | Строка |
| checked | Признак выполнения пункта чеклиста:
|
Логический |
| assignee | Исполнитель пункта чеклиста. | Объект |
| deadline | Крайний срок исполнения пункта чеклиста. | Объект |
| checklistItemType | Тип пункта чеклиста. | Строка |
Поля объекта assignee
| Параметр | Описание | Тип данных |
|---|---|---|
| id | Идентификатор пользователя. | Число |
| display | Отображаемое имя пользователя. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя на Яндексе. | Число |
| login | Логин пользователя. | Строка |
| firstName | Имя пользователя. | Строка |
| lastName | Фамилия пользователя. | Строка |
| Адрес пользователя. | Строка | |
| trackerUid | Уникальный идентификатор аккаунта пользователя в Tracker. | Число |
Поля объекта deadline
| Параметр | Описание | Тип данных |
|---|---|---|
| date | Предельный срок в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. |
Дата |
| deadlineType | Тип данных параметра deadline. |
Строка |
| isExceeded | Признак наступления дедлайна:
|
Логический |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.