Creating a queue

Use this request to create queues.

POST

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

Query format

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

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

POST /v3/queues/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-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.

  • 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

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://api.tracker.yandex.net/v3/queues/DESIGN",
       "id": "111",
       "key": "DESIGN",
       "version": 1400150916068,
       "name": "Design",
       "lead": {
          "self": "https://api.tracker.yandex.net/v3/users/44********",
          "id": "artemredkin",
          "display": "Artem Redkin"
    },
       "assignAuto": false,
       "allowExternals" : false,
       "defaultType": {
          "self": "https://api.tracker.yandex.net/v3/issuetypes/2",
          "id": "2",
          "key": "task",
          "display": "Task"
   },
       "defaultPriority": {
          "self": "https://api.tracker.yandex.net/v3/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 Map item
assignAuto Automatically assign new issues in the queue:
  • true: Assign
  • false: Do not assign
 Boolean
allowExternals Allow sending emails to external addresses. Acceptable values include:
  • true: Enable.
  • false: Disable.
 Boolean
defaultType Block with information about the default issue type Map item
defaultPriority Block with information about the default issue priority Map item
Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization 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
You are not authorized 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 again later.
503
The API service is temporarily unavailable.
Previous
Deleting a project
Next
Getting queue parameters