Получить список компонентов

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

GET

https://api.tracker.yandex.net/v3/components

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

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

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

GET /v3/components
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.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

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

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

Тело ответа содержит JSON-массив с параметрами всех компонентов, созданных пользователями организации.

[
  {
    "self": "https://api.tracker.yandex.net/v3/components/1",
    "id": 1,
    "version": 3,
    "name": "Test",
    "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "My queue"
    },
    "description": "My component",
    "lead": {
           "self": "https://api.tracker.yandex.net/v3/users/11********",
           "id": "11********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 11********
        },
    "assignAuto": false
  },
...
]
Параметры ответа
Параметр Описание Тип данных
self Ссылка на компонент. Строка
id Идентификатор компонента. Число
version Версия компонента. Каждое изменение компонента увеличивает номер версии. Число
name Название компонента. Строка
queue Объект с информацией об очереди компонента. Объект
description Текстовое описание компонента. Строка
lead Блок с информацией о владельце компонента. Объект
assignAuto Автоматически назначить владельца компонента исполнителем для новых задач с этим компонентом:
  • true— назначить;
  • false— не назначать.
 Логический

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию об очереди. Строка
id Идентификатор очереди. Строка
key Ключ очереди. Строка
display Отображаемое название очереди. Строка

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

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

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

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