Get started
Yandex Tracker

Get issue field parameters

Written by

Request format

To get possible values of an issue field, use an HTTP GET request:

GET /v2/fields/<field-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <token> 
X-Org-ID: <organization ID>

Resource

  • <field-id>

    Issue field ID.

Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <token value> format. For example:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

    Organization ID.

Response format

If the request is successful, the API returns a response with code 200. The response body contains a JSON object with all issue field parameters.

{
    "self": "https://api.tracker.yandex.net/v2/fields/ruName",
    "id": "ruName",
    "name": "ru_name",
    "description": "description text",
    "version": 3,
    "schema": {
        "type": "array",
        "items": "string",
        "required": false
    },
    "readonly": false,
    "options": true,
    "suggest": true,
    "suggestProvider": {
        "type": "UserSuggestProvider"
    },
    "optionsProvider": {
        "type": "FixedListOptionsProvider",
        "values": [
            "value 1",
            "value 2"
        ]
    },
    "queryProvider": {
        "type": "StringOptionalQueryProvider"
    },
    "order": 14,
    "category": {
        "self": "https://api.tracker.yandex.net/v2/fields/categories/58bc3b921d9c7d68164e",
        "id": "58bc3b921d9c7d68164e",
        "display": "System"
    }
}

Response parameters

Parameter Description Data type
self Address of the API resource with information about the issue field. String
id Field ID. String
name Field name. String
description Field description. String
version Field version. Each change to the field increases the version number. Number
schema Object with information about the field value's data type. Object
readonly Shows if the field value is editable:
  • true: Non-editable.
  • false: Editable.
 Boolean
options Shows if the list of values is restricted:
  • true: The list of values is not restricted, you can set any value.
  • false: The list of values is restricted by the organization's settings.
 Boolean
suggest Enables/disables search suggestions when entering field values:
  • true: Enabled.
  • false: Disabled.
 Boolean
suggestProvider Object with information about the search suggestion class.
You can't change the class using the API.		 Object
optionsProvider Object with information about allowed field values. Object
queryProvider Object with information about the query language class.
You can't change the class using the API.		 Object
order Sequence number in the list of organization fields: https://tracker.yandex.com/admin/fields Number
category Object with information about the field category.
To get a list of all categories, use the HTTP request:
GET /v2/fields/categories		 Object

Object fields schema

Parameter Description Data type
type Field value type. Possible data types:
  • string: String Available for fields with a single value.
  • array: Array Available for fields with multiple values.
 String
items Value type. Available for fields with multiple values. String
required Shows if the field is required:
  • true: Required.
  • false: Optional.
 Boolean

Object fields suggestProvider

Parameter Description Data type
type Search suggestion class. String

Object fields optionsProvider

Parameter Description Data type
type Type of field values. String
values Array of field values. Array

Object fields queryProvider

Parameter Description Data type
type Query language type. String

Object fields category

Parameter Description Data type
self Address of the API resource with information about the field category. String
id Field category ID. String
display Category name displayed. String

If the request is processed incorrectly, the API returns a message with error details:

HTTP error code Error description
400 Bad Request One of the request parameters has an invalid value or data format.
403 Forbidden The user or application has no access rights to the resource, the request is rejected.
404 Not Found The requested resource not found.
500 Internal Server Error Internal service error. Try again later.
503 Service Unavailable The API service is temporarily unavailable.
In this article: