Contact UsGet started

Creating a queue

Written by
Updated at February 19, 2024

Use this request to create queues.

Request format

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

To create a queue, use an HTTP POST request. Request parameters are provided in the request body in JSON format.

POST /v2/queues/
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>

{
    "key": "DESIGN",
    "name": "Design",
    "lead": "artemredkin",
    "defaultType": "task",
    "defaultPriority": "normal",
    "issueTypesConfig":[
                {"issueType":"task",
                  "workflow":"oicn",
                  "resolutions":["wontFix",...]},
  ...
  ]
}
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Request body parameters

Required parameters

Parameter Description Data type
key Queue key String
name Queue name String
lead Username or ID of the queue owner String
defaultType ID or key of the default issue type String
defaultPriority ID or key of the default issue priority String
issueTypesConfig Array with settings of queue issue types Array of objects

issueTypesConfig array object fields

Parameter Description Data type
issueType Key of the issue type String
workflow Workflow ID String
resolutions Array with the IDs or keys of possible resolutions Array

Response format

If the request is successful, the API returns a response with code 201 Created.

The request body contains information about the created queue in JSON format.

{
       "self": "https://https://api.tracker.yandex.net/v2/queues/DESIGN",
       "id": "111",
       "key": "DESIGN",
       "version": 1400150916068,
       "name": "Design",
       "lead": {
          "self": "https://https://api.tracker.yandex.net/v2/users/44********",
          "id": "artemredkin",
          "display": "Artem Redkin"
    },
       "assignAuto": false,
       "allowExternals" : false,
       "defaultType": {
          "self": "https://https://api.tracker.yandex.net/v2/issuetypes/2",
          "id": "2",
          "key": "task",
          "display": "Task"
   },
       "defaultPriority": {
          "self": "https://https://api.tracker.yandex.net/v2/priorities/2",
          "id": "2",
          "key": "normal",
          "display": "Normal"
  }
}
Response parameters
Parameter Description Data type
self Queue link. String
id Queue ID. Number in string format
key Queue key. String
version Queue version. Each change to the queue increases its version number. Number
name Queue name String
lead Block with information about the queue owner Object
assignAuto Automatically assign new issues in the queue:
  • true: Assign
  • false: Do not assign
 Logical
allowExternals Allow sending emails to external addresses. Acceptable values include:
  • true: Enable.
  • false: Disable.
 Logical
defaultType Block with information about the default issue type Object
defaultPriority Block with information about the default issue priority Object
Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display User's name displayed. String

defaultType object fields

Parameter Description Data type
self Link to the issue type String
id ID of the issue type String
key Key of the issue type String
display Issue type name displayed String

defaultPriority object fields

Parameter Description Data type
self Link to the priority type String
id Priority ID String
key Priority key String
display Priority name displayed String

If the request is processed incorrectly, the API returns a message with error details:

400
One or more request parameters have an invalid value.
403
Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
The requested object was not found. You may have specified an invalid object ID or key.
409
There was a conflict when editing the object. The error may be due to an invalid update version.
422
JSON validation error, the request is rejected.
500
Internal service error. Try resending your request in a few minutes.
503
The API service is temporarily unavailable.
Previous
Deleting a file
Next
Getting queue parameters