Создать версию очереди

Запрос позволяет создать версию в очереди.

POST

https://api.tracker.yandex.net/v3/versions/

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

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

Чтобы создать версию очереди используйте HTTP-запрос с методом POST. В теле запроса укажите параметры в формате JSON.

POST /v3/versions/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
   "queue": "<ключ_очереди>",
   "name": "<название_версии>"
}
Заголовки
  • 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.

    Чтобы узнать идентификатор организации, перейдите на страницу АдминистрированиеОрганизации и скопируйте значение поля идентификатор.

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

Тело запроса содержит информацию, необходимую для создания новой версии очереди:

Обязательные параметры

Параметр Описание Тип данных
queue Ключ очереди. Строка
name Название версии. Строка

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

Параметр Описание Тип данных
description Описание версии. Строка
startDate Дата начала версии в формате YYYY-MM-DD. Строка
dueDate Дата завершения версии в формате YYYY-MM-DD. Строка

Пример: Создать версию очереди Test Queue.

  • Используется HTTP-метод POST.
  • Создается версия очереди с ключом TESTQUEUE.
  • Задается название версии version 0.1.
  • Задается описание версии Test version 1.
  • Задается дата начала версии 2023.10.03.
  • Задается дата завершения версии 2024.06.03.
POST /v3/queues/TEST/versions HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
  "queue": "TESTQUEUE",
  "name": "version 0.1",
  "description": "Test version 1",
  "startDate": "2023-10-03",
  "dueDate": "2024-06-03"
}

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

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

[
    {
        "self": "https://api.tracker.yandex.net/v3/versions/1",
        "id": 1,
        "version": 1,
        "queue": {
            "self": "https://api.tracker.yandex.net/v3/queues/TESTQUEUE",
            "id": "6",
            "key": "TESTQUEUE",
            "display": "Test Queue"
        },
        "name": "version 0.1",
        "description": "Test version 1",
        "startDate": "2023-10-03",
        "dueDate": "2024-06-03",
        "released": false,
        "archived": false
    }
]
Параметры ответа
Параметр Описание Тип данных
self Ссылка на объект версии. Строка
id Идентификатор версии. Число
version Номер версии. Число
queue Объект с информацией об очереди. Объект
name Название версии. Строка
description Текстовое описание версии. Строка
startDate Дата начала версии. Строка
dueDate Дата завершения версии. Строка
released Признак выпущенной версии. Логический
archived Признак архивной версии. Логический

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

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

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

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