Getting global fields
Written by
Updated at February 19, 2024
Request format
To get all global fields of an organization, use an HTTP GET
request:
GET /v2/fields
Host: https://api.tracker.yandex.net
Authorization: OAuth <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 <OAuth_token>
format, e.g.:OAuth 0c4181a7c2cf4521964a72ff********
-
X-Org-ID or X-Cloud-Org-ID
Organization ID. You can find it out on the Tracker organizations page
.- If a Yandex 360 for Business organization is the only one linked to Tracker, the
X-Org-ID
header is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-ID
header is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-ID
header and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Response format
Request executed successfully
Request failed
If the request is successful, the API returns a response with code 200 OK
.
The response body contains information about the global fields of the organization in JSON format.
{
"self": "https://https://api.tracker.yandex.net/v2/fields/standard_field_key",
"id": "standard_field_key",
"name": "standard_field_name",
"key": "standard_field_key",
"version": 0,
"schema": {
"type": "string",
"required": true
},
"readonly": true,
"options": true,
"suggest": true,
"suggestProvider": {
"type": "QueueSuggestProvider"
},
"optionsProvider": {
"type": "QueueOptionsProvider"
},
"queryProvider": {
"type": "QueueQueryProvider"
},
"order": 1,
"category": {
"self": "https://https://api.tracker.yandex.net/v2/fields/categories/0000000000000001********",
"id": "0000000000000001********",
"display": "System"
},
"type": "standard"
},
...
Response parameters
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the field | String |
id | Field ID | String |
name | Field name | String |
key | Field key | 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:
|
Logical |
options | Shows if the list of values is restricted:
|
Logical |
suggest | Enables/disables search suggestions when entering field values:
|
Logical |
suggestProvider | Object with information about the search suggestion class. You cannot 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 cannot 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 |
type | Field type | String |
schema
object fields
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:
|
Logical |
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
- 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 resending your request in a few minutes.
- 503
- The API service is temporarily unavailable.