Связаться с намиПодключиться

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

Статья создана
Обновлена 26 августа 2024 г.

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

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

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

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

GET /v2/components
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 для бизнеса.

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

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

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

[
  {
    "self": "https://api.tracker.yandex.net/v2/components/1",
    "id": 1,
    "version": 3,
    "name": "Test",
    "queue": {
        "self": "https://api.tracker.yandex.net/v2/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Организация"
    },
    "description": "<описание_компонента>",
    "lead": {
           "self": "https://api.tracker.yandex.net/v2/users/11********",
           "id": "11********",
           "display": "Иван Иванов"
        },
    "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. Число

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

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