Получить список очередей проекта
Запрос позволяет получить список очередей, задачи которых попадают в проект.
GET
https://api.tracker.yandex.net/v3/projects/<id_проекта>/queues
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы получить список очередей проекта, используйте HTTP-запрос с методом GET
.
GET /v3/projects/<id_проекта>/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.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
Скопировано -
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<id_проекта> | Идентификатор проекта | Число |
Параметры запроса
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
expand | Дополнительные поля, которые будут включены в ответ. Если проект содержит несколько очередей, параметры отображаются для каждой очереди:
|
Строка |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит информацию о проекте в формате JSON.
[
{
"self": "https://api.tracker.yandex.net/v3/queues/ORG",
"id": 1,
"key": "ORG",
"version": 6,
"name": "Default",
"description": "Queue description",
"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/2",
"id": "2",
"key": "task",
"display": "Задача"
},
"defaultPriority": {
"self": "https://api.tracker.yandex.net/v3/priorities/3",
"id": "3",
"key": "normal",
"display": "Средний"
},
"allowExternalMailing": true,
"addIssueKeyInEmail": true,
"denyVoting": false,
"denyConductorAutolink": false,
"denyTrackerAutolink": true,
"useComponentPermissionsIntersection": false,
"useLastSignature": false
},
{
"self": "https://api.tracker.yandex.net/v3/queues/TEST",
"id": 3,
"key": "TEST",
"version": 8,
"name": "Testing",
"description": "Queue description",
"lead": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 11********
},
"assignAuto": true,
"defaultType": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/2",
"id": "2",
"key": "task",
"display": "Задача"
},
"defaultPriority": {
"self": "https://api.tracker.yandex.net/v3/priorities/3",
"id": "3",
"key": "normal",
"display": "Средний"
},
"allowExternalMailing": false,
"addIssueKeyInEmail": false,
"denyVoting": false,
"denyConductorAutolink": false,
"denyTrackerAutolink": false,
"useComponentPermissionsIntersection": false,
"useLastSignature": false
}
]
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Число |
key | Ключ очереди. | Строка |
version | Версия очереди. Каждое изменение очереди увеличивает номер версии. | Строка |
name | Название очереди. | Строка |
description | Текстовое описание очереди. | Строка |
lead | Блок с информацией о владельце очереди. | Объект |
assignAuto | Признак автоматического назначения исполнителя для новых задач очереди:
|
Логический |
defaultType | Блок с информацией о типе задачи по умолчанию. | Объект |
defaultPriority | Блок с информацией о приоритете задачи по умолчанию. | Объект |
allowExternalMailing | Признак отправки писем на внешние адреса:
|
Логический |
addIssueKeyInEmail | Признак добавления номера задачи в тему письма:
|
Логический |
denyVoting | Признак запрета голосования за задачи:
|
Логический |
denyConductorAutolink | Служебный параметр. | Логический |
denyTrackerAutolink | Признак автоматической связи с задачами других очередей:
|
Логический |
useComponentPermissionsIntersection | Способ получения прав доступа к задачам с несколькими компонентами:
|
Логический |
useLastSignature | Служебный параметр. | Логический |
Поля объекта lead
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Число |
display | Отображаемое имя пользователя. | Строка |
Поля объекта defaultType
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о типе задаче. | Строка |
id | Идентификатор типа задачи. | Число |
key | Ключ типа задачи. | Строка |
display | Отображаемое название типа задачи. | Строка |
Поля объекта defaultPriority
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о приоритете задаче. | Строка |
id | Идентификатор приоритета задачи. | Число |
key | Ключ приоритета задачи. | Строка |
display | Отображаемое название приоритета задачи. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.