Getting required queue fields
Written by
Updated at February 19, 2024
Use this request to get information about required queue fields. The queue is selected when the ID or key is specified.
Request format
Before making the request, get permission to access the API.
To get required fields of a queue, use an HTTP GET request.
GET /v2/queues/<queue_ID_or_key>/fields
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
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-IDheader is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-IDheader is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-IDheader and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Resource
| Parameter | Description | Data type |
|---|---|---|
| <queue_ID_or_key> | Queue ID or key. The queue key is case-sensitive. | String or number |
Example: Get required
TESTqueue fields.
- An HTTP
GETmethod is used.GET /v2/queues/TEST/fields HTTP/1.1 Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth token> X-Org-ID: <organization ID>
Response format
Request executed successfully
Request failed
If the request is successful, the API returns a response with code 200 OK.
[
{
"self": "https://https://api.tracker.yandex.net/v2/fields/stand",
"id": "stand",
"name": "Bench",
"version": 1361890459119,
"schema": {
"type": "string",
"required": false
},
"readonly": false,
"options": true,
"suggest": false,
"optionsProvider": {
"type": "QueueFixedListOptionsProvider",
"values": {
"DIRECT": [
"Not specified",
"Test",
"Developer",
"Beta",
"Production",
"Trunk"
]
},
"defaults": [
"Not specified",
"Test",
"Developer",
"Beta",
"Production"
]
},
"queryProvider": {
"type": "StringOptionalQueryProvider"
},
"order": 222
},
....
]
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the field object. | String |
| id | Field ID | String |
| name | Field name | String |
| version | Version number | Number |
| schema | Object with information about the type of field content. | Object |
| readonly | Shows if the field is editable. The possible values include:
|
Logical |
| options | Shows if there are options for filling in the field. | Logical |
| suggest | Shows if suggestions are available when filling in the field. | Logical |
| optionsProvider | Block with information about a set of possible field values. | Object |
| queryProvider | Information about the type of field for query requests. | Object |
| order | Weight of the field when displayed in the interface. Fields with a lower weight are displayed above fields with a higher weight. | Number |
schema object fields
| Parameter | Description | Data type |
|---|---|---|
| type | Type of field content. The possible values include:
|
String |
| required | Shows if the field is required. | Logical |
optionsProvider object fields
| Parameter | Description | Data type |
|---|---|---|
| type | Information about the type of field for query requests | String |
| values | Array with information about special values for queues | Object |
| defaults | Array of field values | Array |
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.