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>
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.
Resource
| Parameter | Description | Data type |
|---|---|---|
| <field-id> | Issue field ID. | String |
Response format
Successful execution of the request
The request failed
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/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:
|
Boolean |
| options | Shows if the list of values is restricted:
|
Boolean |
| suggest | Enables/disables search suggestions when entering field values:
|
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 |
| items | Value type. Available for fields with multiple values. | String |
| required | Shows if the field is required:
|
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:
- 400
- One or more request parameters have an invalid value.
- 403
- Insufficient rights 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.