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

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

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

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

GET /v2/queues/<queue-id>?
expand=<дополнительные поля в ответе>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>

Параметры запроса

<queue-id>

Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов.

expand (необязательный)

Дополнительные поля, которые будут включены в ответ. Возможные значения:

all — в ответ будут включены все дополнительные поля очереди;
projects — проекты очереди;
components — компоненты очереди;
versions — версии очереди;
types — типы задач;
team — список участников команды очереди;
workflows — список жизненных циклов;
fields — обязательные поля очереди;
issueTypesConfig — настройки типов задач очереди.

Запрос очереди:

Используется HTTP-метод GET.
В ответе включено отображение всех дополнительных полей.

GET /v2/queues/TEST?expand=all HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>
Cache-Control: no-cache

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

{
    "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/1120000000016876",
           "id": "<id сотрудника>",
           "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/1120000000016876",
               "id": "<id сотрудника>",
               "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	Массив с настройками задач очереди.	Массив объектов.
Поля объекта `lead`
`self`	Ссылка на пользователя Трекера.	Строка.
`id`	Идентификатор пользователя.	Строка.
`display`	Отображаемое имя пользователя.	Строка.
Поля объекта `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`	Отображаемое название резолюции.	Строка.


Параметр	Описание	Тип данных
`self`	Ссылка на очередь.	Строка.
`id`	Идентификатор очереди.	Строка.
`key`	Ключ очереди.	Строка.
`version`	Версия очереди. Каждое изменение очереди увеличивает номер версии.	Число.
`name`	Название очереди.	Строка.
`description`	Текстовое описание очереди.	Строка.
lead	Блок с информацией о владельце очереди.	Объект.
`assignAuto`	Автоматически назначить исполнителя для новых задач очереди: `true`— назначить. `false`— не назначать.	Логический.
defaultType	Блок с информацией о типе задачи по умолчанию.	Объект.
defaultPriority	Блок с информацией о приоритете задачи по умолчанию	Объект.
teamUsers	Массив с информацией об участниках команды очереди	Массив объектов.
issueTypes	Массив с информацией о типах задач очереди.	Массив объектов.
versions	Массив с информацией о версиях очереди	Массив объектов.
workflows	Список жизненных циклов очереди и их типов задач.	Массив.
`denyVoting`	Признак возможности голосования за задачи.	Логический.
issueTypesConfig	Массив с настройками задач очереди.	Массив объектов.
Поля объекта `lead`
`self`	Ссылка на пользователя Трекера.	Строка.
`id`	Идентификатор пользователя.	Строка.
`display`	Отображаемое имя пользователя.	Строка.
Поля объекта `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`	Отображаемое название резолюции.	Строка.

Возможные коды ответа

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