Получить версии очереди
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет получить информацию о версиях очереди. Очередь выбирается при указании идентификатора или ключа.
Формат запроса
Перед выполнением запроса получите доступ к API.
Для получения версий очереди используйте HTTP-запрос с методом GET
.
GET /v2/queues/<ключ_или_идентификатор_очереди>/versions
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 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<ключ_или_идентификатор_очереди> | Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. | Строка или число |
Пример: Получить версии очереди
TEST
.
- Используется HTTP-метод
GET
.GET /v2/queues/TEST/versions 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/versions/49***",
"id": 49***,
"version": 1,
"queue": {
"self": "https://api.tracker.yandex.net/v2/queues/JUNE",
"id": "1928",
"key": "JUNE",
"display": "june"
},
"name": "версия1",
"description": "iohb ±!@#$%^&*()_+=-/\\?<>.,/§:»'|;",
"startDate": "2017-06-09",
"dueDate": "20227-06-09",
"released": false,
"archived": false
},
...
]
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на объект версии | Строка |
id | Идентификатор версии | Число |
version | Номер версии | Число |
queue | Объект с информацией об очереди | Объект |
name | Название версии | Строка |
description | Текстовое описание версии | Строка |
startDate | Начальная дата очереди | Строка |
dueDate | Конечная дата очереди | Строка |
released | Признак выпущенной версии | Логический |
archived | Признак архивной версии | Логический |
Поля объекта queue
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Строка |
key | Ключ очереди. | Строка |
display | Отображаемое название очереди. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.