Getting required queue fields

Use this request to get information about required queue fields. The queue is selected when the ID or key is specified.

GET

https://api.tracker.yandex.net/v3/queues/<queue_ID>/fields

Query format

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

To get required fields of a queue, use an HTTP GET request.

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

Resource
Parameter Description Data type
<queue_ID> Queue ID or key. The queue key is case-sensitive. String or number

Example: Getting required TEST queue fields.

  • HTTP GET method is used.
GET https://api.tracker.yandex.net/v3/queues/TEST/fields

Response format

If the request is successful, the API returns a response with code 200 OK.

[
    {
        "self": "https://api.tracker.yandex.net/v3/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. Map item
readonly Shows if the field is editable. The possible values include:
  • true: The field is editable.
  • false: Non-editable.
 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. Map item
queryProvider Information about the type of field for query requests. Map item
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:
  • float: Numeric field.
  • string: Text field.
 String
required Shows if the field is required. Boolean

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 Map item
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.
Previous
Getting queue versions
Next
Deleting a queue