Get required fields for the queue
Written by
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>/fields
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>
Headers
-
Host
API host address:
https://api.tracker.yandex.net
-
Authorization
OAuth token in
OAuth <token value>
format. For example:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Organization ID.
Resource
Parameter | Description | Data type |
---|---|---|
<queue-id> | Queue ID or key. The queue key is case-sensitive. | String or number |
Example: Get required
TEST
queue fields.
- An HTTP
GET
method 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://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",
"Development",
"Beta",
"Production",
"Trunk"
]
},
"defaults": [
"Not specified",
"Test",
"Development",
"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. Possible values:
|
Boolean |
options | Shows if there are options for filling in the field. | Boolean |
suggest | Shows if suggestions are available when filling in the field. | Boolean |
optionsProvider | Block with information about a set of possible field values. | Object |
queryProvider | Information about the type of field for quiery 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 |
Object fields schema
Parameter | Description | Data type |
---|---|---|
type | Type of field content. Possible values:
|
String |
required | Shows if the field is required. | Boolean |
Object fields optionsProvider
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.