Getting board parameters
Use this request to get the parameters of an issue board.
GET
https://api.tracker.yandex.net/v3/boards/<board_ID>
Query format
Before making a request, get permission to access the API.
To get the parameters of a specific issue board, use an HTTP GET
request.
GET /v3/boards/<board_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
Copied -
-
X-Org-ID
orX-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.
Copied -
Resource
Parameter | Description | Data type |
---|---|---|
<board_ID> | Board ID | Number |
Response format
If the request is successful, the API returns a response with code 200 OK
.
The response body contains a JSON object with board parameters.
{
"self": "https://api.tracker.yandex.net/v3/boards/1",
"id" : 1,
"version" : 1412806202302,
"name" : "Testing",
"columns" :
[
{
"self": "https://api.tracker.yandex.net/v3/boards/1/columns/13874********",
"id" : "13874********",
"display" : "Open"
},
...
],
"filter": {
"<parameter_1_key>": "<value_1>",
"<parameter_2_key>": [
"<value_2>",
...
],
...
},
"orderBy": "updated",
"orderAsc": false,
"query": "<parameter_1>: <value_1> AND <parameter_2>: <value_2> OR <parameter_3>: <value_3>...",
"useRanking": false,
"estimateBy": {
"self": "https://api.tracker.yandex.net/v3/fields/storyPoints",
"id": "storyPoints",
"display": "Story Points"
},
"country": {
"self": "https://api.tracker.yandex.net/v3/countries/1",
"id": "1",
"display": "Russia"
},
"defaultQueue": {
"self": "https://api.tracker.yandex.net/v3/queues/DOC",
"id": "3",
"key": "DOC",
"display": "Documenting"
},
"calendar": {
"id": 6
}
}
Response parameters
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with board parameters | String |
id | Board ID | Number |
version | Board version; each change to the board increases its version number | Number |
name | Board name. | String |
columns | Object with information about board columns | Map item |
filter | Object with information about filter conditions used for selecting issues for the board. Issue parameters are made up of fields and values |
Map item |
orderBy | Field key. The field is used as a parameter for sorting board issues. The full list of fields: https://tracker.yandex.com/admin/fields |
String |
orderAsc | Sort direction:
|
Boolean |
query | Parameters of the filter used to select issues for the board. The parameters are specified in the query language |
String |
useRanking | Shows if you can change the order of issues on the board:
|
Map item |
estimateBy | Object with information about the parameter that issues on the board are estimated by. Defaults to Story Points . |
Map item |
country | Object with information about the country. Data of a country-specific business calendar is used in the burndown chart. To get a list of countries, use the HTTP GET /v3/countries request |
Map item |
defaultQueue | Object with information about the default queue for creating issues. | Map item |
calendar | Object with information about the business calendar used for the board. The calendar is used to count working and non-working days in the Burndown chart. | Number |
columns
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the board column | String |
id | Column ID | String |
display | Column name displayed | String |
filter
object fields
Parameter | Description | Data type |
---|---|---|
<parameter_1_key> | Key of the field that is used as a parameter for selecting issues for the board. The full list of fields: https://tracker.yandex.com/admin/fields |
String |
<parameter_2_key> | Array with the keys of the fields that are used as parameters for selecting issues for the board. The full list of fields: https://tracker.yandex.com/admin/fields |
Array |
estimateBy
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the issue estimation parameter. | String |
id | ID of the issue estimation parameter | String |
display | Issue estimation parameter name displayed. | String |
country
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with the country name | String |
id | Country ID | String |
display | Country name displayed | String |
defaultQueue
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the queue | String |
id | Queue ID | String |
key | Queue key | String |
display | Queue name displayed | String |
calendar
object fields
Parameter | Description | Data type |
---|---|---|
id | Calendar ID | Number |
If the request is processed incorrectly, the API returns a response with an error code:
- 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.