Получить список очередей
Запрос позволяет получить список доступных очередей. Если количество очередей в ответе более 50, необходимо использовать механизм постраничного отображения.
GET
https://api.tracker.yandex.net/v3/queues/
Формат запроса
Перед выполнением запроса получите доступ к API.
Для поиска задач используйте HTTP-запрос с методом GET
.
GET /v3/queues/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
Host
: адрес узла, предоставляющего API. -
Authorization
: токен для авторизации в одном из форматов:-
OAuth <OAuth-токен>
при авторизации по протоколу OAuth 2.0. Читать подробнее -
Bearer <IAM-токен>
при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее
Скопировано -
-
X-Org-ID
илиX-Cloud-Org-ID
: идентификатор организации.-
Используйте заголовок
X-Org-ID
, если к Трекеру привязана организация Яндекс 360 для бизнеса. -
Используйте заголовок
X-Cloud-Org-ID
, если к Трекеру привязана организация Yandex Cloud Organization.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
Скопировано -
Параметры запроса
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
expand | Дополнительные поля, которые будут включены в ответ. Возможные значения:
|
Строка |
perPage | Количество очередей на странице ответа. Значение по умолчанию — 50. Дополнительные параметры показа ответа можно настроить с помощью механизма постраничного отображения. | Целое число |
Пример: Получить список задач с указанием дополнительных параметров фильтрации.
- Используется HTTP-метод
GET
.GET https://api.tracker.yandex.net/v3/queues
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
[
{
"self": "https://api.tracker.yandex.net/v3/queues/TEST",
"id": "3",
"key": "TEST",
"version": 5,
"name": "Test",
"description": "My queue",
"lead": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 11********
},
"assignAuto": false,
"defaultType": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/1",
"id": "1",
"key": "task",
"display": "Задача"
},
"defaultPriority": {
"self": "https://api.tracker.yandex.net/v3/priorities/3",
"id": "3",
"key": "normal",
"display": "Средний"
},
"teamUsers": [
{
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 11********
},
...
],
"issueTypes": [
{
"self": "https://api.tracker.yandex.net/v3/issuetypes/1",
"id": "1",
"key": "task",
"display": "Задача"
},
...
],
"versions": [
{
"self": "https://api.tracker.yandex.net/v3/versions/4",
"id": "4",
"display": "My version"
}
],
"workflows": {
"dev": [
{
"self": "https://api.tracker.yandex.net/v3/issuetypes/1",
"id": "1",
"key": "task",
"display": "Задача"
},
...
]
},
"denyVoting": false,
"issueTypesConfig": [
{
"issueType": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/1",
"id": "1",
"key": "task",
"display": "Задача"
},
"workflow": {
"self": "https://api.tracker.yandex.net/v3/workflows/dev",
"id": "dev",
"display": "dev"
},
"resolutions": [
{
"self": "https://api.tracker.yandex.net/v3/resolutions/2",
"id": "2",
"key": "wontFix",
"display": "Won't fix"
},
...
]
},
...
]
},
...
]
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на очередь. | Строка |
id | Идентификатор очереди. | Число в формате строки |
key | Ключ очереди. | Строка |
version | Версия очереди. Каждое изменение очереди увеличивает номер версии. | Число |
name | Название очереди. | Строка |
description | Текстовое описание очереди. | Строка |
lead | Блок с информацией о владельце очереди. | Объект |
assignAuto | Автоматически назначить исполнителя для новых задач очереди:
|
Логический |
defaultType | Блок с информацией о типе задачи по умолчанию. | Объект |
defaultPriority | Блок с информацией о приоритете задачи по умолчанию | Объект |
teamUsers | Массив с информацией об участниках команды очереди | Массив объектов |
issueTypes | Массив с информацией о типах задач очереди. | Массив объектов |
versions | Массив с информацией о версиях очереди | Массив объектов |
workflows | Список жизненных циклов очереди и их типов задач. | Массив. |
denyVoting | Признак возможности голосования за задачи. | Логический |
issueTypesConfig | Массив с настройками задач очереди. | Массив объектов |
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта 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 | Отображаемое название резолюции | Строка |