Get required queue fields

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

Request format

To get the required queue fields, 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>
Request parameters
<queue-id>
The ID or key of the queue.

Request for versions of the “TEST” queue:

  • Uses the HTTP GET method.

GET /v2/queues/TEST/fields HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-Id: <organization ID>
Cache-Control: no-cache

Response format

[
    {
        "self": "https://api.tracker.yandex.net/v2/fields/stand",
        "id": "stand",
        "name": "Stand",
        "version": 1361890459119,
        "schema": {
            "type": "string",
            "required": false
        },
        "readonly": false,
        "options": true,
        "suggest": false,
        "optionsProvider": {
            "type": "QueueFixedListOptionsProvider",
            "values": {
                "DIRECT": [
                    "None",
                    "Testing",
                    "Development",
                    "Beta",
                    "Production",
                    "Trunk"
                ]
            },
            "defaults": [
                "None",
                "Testing",
                "Development",
                "Beta",
                "Production"
            ]
        },
        "queryProvider": {
            "type": "StringOptionalQueryProvider"
        },
        "order": 222
    },
    ....
]
Response parameters
Parameter Description Data type
self

A reference to the field object.

String.

id

The field ID.

String.

name

Name of the field.

String.

version

Version number.

Integer.

schema

Object with information about the type of field content.

Object.

readonly
Whether the field is editable. Possible values:
  • true — Editable field.
  • false — Read-only field.

Boolean.

options

Whether there are options for setting the field.

Boolean.

suggest

Whether the field shows suggestions or hints for filling it.

Boolean.

optionsProvider

A section with information about the acceptable values in the field.

Object.

queryProvider

Information about the type of field for queries.

Object.

order

The weight of the field for displaying it in the interface. Fields with a lower weight are displayed above fields with a higher weight.

Integer.

Fields for the schema object
type
Type of field content. Possible values:
  • float — Integer.
  • string — Text.

String.

required

Whether the field must be filled in.

Boolean.

Fields for the optionsProvider object
type

Information about the type of field for queries.

String.

values

Array with information about special values for queues.

Object

defaults

Array of field values.

Array.

Possible response codes

200
The request was successful.
404
The requested object was not found. You might have entered an incorrect object ID or key value.