Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Intertech Services AG
Yandex Tracker
  • Getting started
  • Yandex Tracker mobile app
  • Tutorials
  • Concepts
  • Configuring queues
  • Working with issues
  • Structuring issues
  • Projects
  • Agile development tools
  • Issue boards (beta)
  • Find issues
  • Notifications and subscriptions
  • Statistics and dashboards
  • Automation and templates
  • Configuring an SLA for issues
  • Integration with other services
  • Developer tools
  • Pricing policy
  • API reference
    • Overview
    • API access
    • Generic request format
    • Issues
    • Checklists
    • Projects
    • Comments
    • Macros
    • External links
    • Attached files
    • Queues
      • Create a queue
      • Get queue parameters
      • Get a list of queues
      • Get queue versions
      • Get required queue fields
      • Delete a queue
      • Restore a queue
      • Remove a tag from a queue
      • Automation
    • Issue boards
    • Components
    • Import
    • Bulk operations
    • Time tracking
    • Issue fields
    • Users
    • Possible response codes
  • Questions and answers
  • Revision history
  • Support
  1. API reference
  2. Queues
  3. Get required queue fields

Get required fields for the queue

Written by
Yandex Cloud
  • Request format
  • Response format

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:
  • true: 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. 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:
  • float: Numeric field.
  • string: Text field.
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.

Was the article helpful?

Language / Region
Yandex project
© 2023 Intertech Services AG
In this article:
  • Request format
  • Response format