Получить параметры чеклиста

Запрос позволяет получить параметры чеклиста в задаче.

GET

https://api.tracker.yandex.net/v3/issues/<id_задачи>/checklistItems

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

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

Чтобы получить параметры чеклиста, используйте HTTP-запрос с методом GET:

GET /v3/issues/<id_задачи>/checklistItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

  • 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_задачи> Идентификатор или ключ задачи Строка

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

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

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

{
    "id": "5fde5f0a1aee261d********",
    "text": "List item text",
    "textHtml": "List item text in 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 Признак выполнения пункта чеклиста:
  • true — пункт отмечен как выполненный;
  • false — пункт не отмечен как выполненный.
 Логический
assignee Исполнитель пункта чеклиста. Объект
deadline Крайний срок исполнения пункта чеклиста. Объект
checklistItemType Тип пункта чеклиста. Строка

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

Параметр Описание Тип данных
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя на Яндексе. Число
login Логин пользователя. Строка
firstName Имя пользователя. Строка
lastName Фамилия пользователя. Строка
email Адрес пользователя. Строка
trackerUid Уникальный идентификатор аккаунта пользователя в Трекере. Число

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

Параметр Описание Тип данных
date Предельный срок в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Дата
deadlineType Тип данных параметра deadline. Строка
isExceeded Признак наступления дедлайна:
  • true — предельный срок наступил;
  • false — предельный срок не наступил.
 Логический

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

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Создать чеклист или добавить в него пункты
Следующая
Редактировать чеклист