Получить компоненты очереди

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

GET

https://api.tracker.yandex.net/v3/queues/{id_очереди}/components?fields=id,name,queue

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

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

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

GET /v3/queues/{id_очереди}/components?fields=id,name,queue
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth OAUTH_TOKEN при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer IAM_TOKEN при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,

    • если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.

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

Ресурс
Параметр Описание Тип данных
id_очереди Идентификатор или ключ очереди. Ключ чувствителен к регистру. Строка или число
Параметры запроса
Параметр Описание Тип данных
fields Список возвращаемых полей через запятую: version, name, queue, description, lead, assignAuto. Поля self и id возвращаются всегда. Строка

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

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

Тело ответа содержит JSON-массив компонентов.

[
    {
        "self": "https://api.tracker.yandex.net/v3/components/123",
        "id": 123,
        "name": "Компонент",
        "queue": {
            "self": "https://api.tracker.yandex.net/v3/queues/TEST",
            "id": "1",
            "key": "TEST",
            "display": "Тестовая очередь"
        }
    }
]
Параметры объекта компонента
Параметр Описание Тип данных
self Ссылка на объект компонента. Строка
id Идентификатор компонента. Число
name Название компонента. Строка
queue Очередь, в которую добавлен компонент. Объект

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

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