Creating a queue version

Use this request to create a queue version.

POST

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

Query format

Before making a request, get permission to access the API.

To create a queue version, use an HTTP POST request. In the request body, specify the parameters in JSON format.

POST /v3/versions/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
   "queue": "<queue_key>",
   "name": "version_name>
}

Headers

Host: Address of the node that provides the API.
Authorization: Authorization token about these formats:
- OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more
- Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more
X-Org-ID or X-Cloud-Org-ID: Organization ID.
- Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.
- Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Request body parameters

The request body contains the information required to create a new queue version:

Required parameters

Parameter	Description	Data type
queue	Queue key.	String
name	Version name	String

Additional parameters

Parameter	Description	Data type
description	Version description	String
startDate	Version start date in `YYYY-MM-DD` format	String
dueDate	Version end date in `YYYY-MM-DD` format	String

Example: Creating a queue version named Test Queue.

An HTTP POST method is used.

Create a queue version with the TESTQUEUE key.

Set the version name: version 0.1.

Set the version description: Test version 1.

Set the version start date: 2023.10.03.

Set the version end date: 2024.06.03.
POST /v3/queues/TEST/versions HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
{
  "queue": "TESTQUEUE",
  "name": "version 0.1",
  "description": "Test version 1",
  "startDate": "2023-10-03",
  "dueDate": "2024-06-03"
}

Response format

Request executed successfully

Request failed

If the request is successful, the API returns a response with code 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
    }
]

Response parameters

Parameter	Description	Data type
self	Link to the version object	String
id	Version ID.	Number
version	Version number	Number
queue	Object with information about the queue	Map item
name	Version name	String
description	Text description of the version	String
startDate	Version start date	String
dueDate	Version end date	String
released	Flag of the released version	Boolean
archived	Flag of the archived version	Boolean

queue object fields

Parameter	Description	Data type
self	Address of the API resource with information about the queue.	String
id	Queue ID.	String
key	Queue key.	String
display	Queue name displayed.	String

If the request is processed incorrectly, the API returns a response with an error code:

404: The requested object was not found. You may have specified an invalid object ID or key.

Was the article helpful?

Getting a list of queues

Getting queue versions