Getting issue field parameters

GET

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

Query format

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

GET /v3/fields/<field_ID>
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
<field_ID> Issue field ID. String

Response format

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

The response body contains a JSON object with all issue field parameters.

{
    "self": "https://api.tracker.yandex.net/v3/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/v3/fields/categories/58bc3b921d9c********",
        "id": "58bc3b921d9c********",
        "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 Map item
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 cannot change the class using the API.		 Map item
optionsProvider Object with information about allowed field values. Map item
queryProvider Object with information about the query language class.
You cannot change the class using the API.		 Map item
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 /v3/fields/categories		 Map item

schema object fields

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

suggestProvider object fields

Parameter Description Data type
type Search suggestion class. String

optionsProvider object fields

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

queryProvider object fields

Parameter Description Data type
type Query language type String

category object fields

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:

400
One or more request parameters have an invalid value.
403
You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
The requested object was not found. You may have specified an invalid object ID or key.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.
Previous
Creating an issue field
Next
Editing an issue field name