Editing a board

Use this request to edit board parameters.

PATCH

https://api.tracker.yandex.net/v3/boards/<board_ID>

Query format

Before making a request, get permission to access the API.

To edit board parameters, use an HTTP PATCH request. In the request body, specify the parameters in JSON format.

PATCH /v3/boards/<board_ID>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
If-Match: "<version_number>"

<new_board_parameters_in_JSON_format>
Headers
  • Host

    Address of the node that provides the API:

    api.tracker.yandex.net
    
  • 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 AdministrationOrganizations and copy the value from the ID field.

  • If-Match

    Number of the current board version. If you specify an obsolete version of the board, the HTTP request returns an error message saying 412 Precondition Failed.

Resource
Parameter Description Data type
<board_ID> Board ID Number
Request body parameters

The request body contains the board parameters to be changed.

Additional parameters

Parameter Description Data type
name Board name. String
columns Object with information about new 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.
The filter, orderBy, and orderAsc parameter group is incompatible with the query parameter that also describes filter conditions
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:
  • true: Ascending
  • false: Descending
Boolean
query Parameters of the filter used to select issues for the board.
The parameters are specified in the query language.
The query parameter is incompatible with the group of parameters that also describe filter conditions, including filter, orderBy, and orderAsc
String
useRanking Shows if you can change the order of issues on the board:
  • true: Yes
  • false: No
Boolean
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
Object

columns object fields

Parameter Description Data type
id Column ID String
name Column name String
statuses Keys of statuses of issues to be output in the column.
The list of all issue statuses: https://tracker.yandex.com/admin/statuses
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

country object fields

Parameter Description Data type
id Country ID String

Example: Edit the parameters of the board with ID 5.

  • The HTTP PATCH method is used.
PATCH /v3/boards/5
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization_ID>
If-Match: "<version_number>"

{
 "name": "Testing new",
 "columns":
    [
      {
        "id": "1",
        "name": "Open",
        "statuses": "open"
       },
       {
        "id": "2",
        "name": "Closed",
        "statuses": "closed"
       }
     ],
 "filter": {
      "assignee": "user1",
      "priority": [
          "normal",
          "blocker",
          "critical"
          ]
      },
 "orderBy": "created",
 "orderAsc": true,
 "useRanking": true,
 "country": {
      "id": "1"
      }
}

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 board parameters, including the updated ones.

{
  "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,

   "country": {
       "self": "https://api.tracker.yandex.net/v3/countries/1",
       "id": "1",
       "display": "Russia"
        }
   }
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:
  • true: Ascending
  • false: Descending
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:
  • true: Yes
  • false: No
Boolean
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
Object

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

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

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.
412
A conflict occurred while editing the object. The error may be due to an invalid update version.
422
JSON validation error, the request is rejected.
428
Access to the resource is denied. Make sure all required conditions for the request are specified.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.