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

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

GET

https://api.tracker.yandex.net/v3/components/{id_компонента}

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

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

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

GET /v3/components/{id_компонента}
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 возвращаются всегда. Строка

Если передать в заголовке If-None-Match значение заголовка ETag из предыдущего ответа, при отсутствии изменений API возвращает код 304 без тела ответа.

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

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

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

{
    "self": "https://api.tracker.yandex.net/v3/components/123",
    "id": 123,
    "version": 1,
    "name": "Компонент",
    "description": "Описание компонента",
    "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/TEST",
        "id": "1",
        "key": "TEST",
        "display": "Тестовая очередь"
    },
    "lead": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия"
    },
    "assignAuto": false
}
Параметры ответа
Параметр Описание Тип данных
self Ссылка на объект компонента. Строка
id Идентификатор компонента. Число
version Версия компонента. Число
name Название компонента. Строка
description Описание компонента. Строка
queue Очередь, в которую добавлен компонент. Объект
lead Владелец компонента. Объект
assignAuto Признак автоматического назначения владельца компонента исполнителем. Логический

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

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

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

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

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

404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Получить компоненты очереди
Следующая
Создать компонент