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

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

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

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

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

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

Для получения информации об очереди используйте HTTP-запрос с методом GET.

GET /v2/queues/<ключ_или_идентификатор_очереди>
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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_очереди> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка или число
Параметры запроса

Дополнительные параметры

Параметр Описание Тип данных
expand Дополнительные поля, которые будут включены в ответ. Возможные значения:
  • all — в ответ будут включены все дополнительные поля очереди;
  • projects — проекты очереди;
  • components — компоненты очереди;
  • versions — версии очереди;
  • types — типы задач;
  • team — список участников команды очереди;
  • workflows — список жизненных циклов;
  • fields — обязательные поля очереди;
  • issueTypesConfig — настройки типов задач очереди.
 Строка

Пример: Получить информацию об очереди.

  • Используется HTTP-метод GET.
  • В ответе включено отображение всех дополнительных полей.
GET /v2/queues/TEST?expand=all HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

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

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

{
    "self": "https://api.tracker.yandex.net/v2/queues/TEST",
    "id": "3",
    "key": "TEST",
    "version": 5,
    "name": "Test",
    "description": "Очередь, заведённая в тестовых целях",
    "lead": {
           "self": "https://api.tracker.yandex.net/v2/users/11********",
           "id": "11********",
           "display": "Иван Иванов"
    },
    "assignAuto": false,
    "defaultType": {
           "self": "https://api.tracker.yandex.net/v2/issuetypes/1",
           "id": "1",
           "key": "bug",
           "display": "Ошибка"
    },
    "defaultPriority": {
           "self": "https://api.tracker.yandex.net/v2/priorities/3",
           "id": "3",
           "key": "normal",
           "display": "Средний"
    },
    "teamUsers": [
           {
               "self": "https://api.tracker.yandex.net/v2/users/11********",
               "id": "11********",
               "display": "Иван Иванов"
           },
           ...
    ],
    "issueTypes": [
           {
               "self": "https://api.tracker.yandex.net/v2/issuetypes/1",
               "id": "1",
               "key": "bug",
               "display": "Ошибка"
           },
           ...
    ],
    "versions": [
           {
               "self": "https://api.tracker.yandex.net/v2/versions/4",
               "id": "4",
               "display": "Куку"
        }
    ],
    "workflows": {
           "dev": [
               {
                    "self": "https://api.tracker.yandex.net/v2/issuetypes/1",
                    "id": "1",
                    "key": "bug",
                    "display": "Ошибка"
                },
                ...
           ]
    },
    "denyVoting": false,
    "issueTypesConfig": [
           {
               "issueType": {
                      "self": "https://api.tracker.yandex.net/v2/issuetypes/1",
                      "id": "1",
                      "key": "bug",
                      "display": "Ошибка"
            },
            "workflow": {
                      "self": "https://api.tracker.yandex.net/v2/workflows/dev",
                      "id": "dev",
                      "display": "dev"
            },
            "resolutions": [
                   {
                      "self": "https://api.tracker.yandex.net/v2/resolutions/2",
                      "id": "2",
                      "key": "wontFix",
                      "display": "Не будет исправлено"
                   },
                ...
            ]
        },
        ...
    ]
}
Параметры ответа
Параметр Описание Тип данных
self Ссылка на очередь Строка
id Идентификатор очереди Число в формате строки
key Ключ очереди Строка
version Версия очереди. Каждое изменение очереди увеличивает номер версии Число
name Название очереди Строка
description Текстовое описание очереди Строка
lead Блок с информацией о владельце очереди Объект
assignAuto Автоматически назначить исполнителя для новых задач очереди:
  • true— назначить;
  • false— не назначать.
 Логический
defaultType Блок с информацией о типе задачи по умолчанию Объект
defaultPriority Блок с информацией о приоритете задачи по умолчанию Объект
teamUsers Массив с информацией об участниках команды очереди Массив объектов
issueTypes Массив с информацией о типах задач очереди Массив объектов
versions Массив с информацией о версиях очереди Массив объектов
workflows Список жизненных циклов очереди и их типов задач Массив
denyVoting Признак возможности голосования за задачи Логический
issueTypesConfig Массив с настройками задач очереди Массив объектов
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число

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

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

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

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

Поля объектов массива teamUsers

Параметр Описание Тип данных
self Ссылка на пользователя Строка
id Идентификатор пользователя Строка
display Отображаемое имя пользователя Строка

Поля объектов массива issueTypes

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

Поля объектов массива versions

Параметр Описание Тип данных
self Ссылка на версию очереди Строка
id Идентификатор версии Строка
display Отображаемое название версии Строка

Поля объектов массива workflows

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

Поля объектов массива issueTypesConfig

Параметр Описание Тип данных
issueType Блок с информацией о типе задачи Объект
workflow Блок с информацией о жизненном цикле типа задачи Объект
resolutions Массив с возможными резолюциями типа задачи Массив объектов

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

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

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

Параметр Описание Тип данных
self Ссылка на объект жизненного цикла Строка
id Идентификатор жизненного цикла Строка
display Отображаемое название жизненного цикла Строка

Поля объектов массива resolutions

Параметр Описание Тип данных
self Ссылка на объект резолюции Строка
id Идентификатор резолюции Строка
key Идентификатор резолюции Строка
display Отображаемое название резолюции Строка

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

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