Creating a resolution
Use this request to create a new resolution.
POST
https://api.tracker.yandex.net/v3/resolutions/
You need Administrator rights to run this request.
Request format
Before sending a request, get permission to access the API.
To create a resolution, use an HTTP POST request. In the request body, specify the parameters in JSON format:
POST /v3/resolutions/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
{
"key": "myResolution",
"name": {
"ru": "Моя резолюция",
"en": "My resolution"
}
}
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-IDorX-Cloud-Org-ID: Organization ID.-
Use the
X-Org-IDheader if a Tracker organization is linked to Yandex 360 for Business. -
Use the
X-Cloud-Org-IDheader 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.
-
Request body parameters
The request body contains information required to create a new resolution:
Required parameters
| Parameter | Description | Data type |
|---|---|---|
| key | Resolution key (ID). Use Latin characters only, starting with a lowercase letter. | String |
| name | Resolution name | Object |
Fields of the name object
| Parameter | Description | Data type |
|---|---|---|
| ru | Resolution name in Russian | String |
| en | Resolution name in English | String |
Response format
If the request is successful, the API returns a response with code 201 Created.
The request body contains information about the created resolution in JSON format.
{
"self": "https://api.tracker.yandex.net/v3/resolutions/9",
"id": 9,
"key": "myResolution",
"version": 1,
"name": "My resolution",
"order": 90
}
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the resolution | String |
| id | Unique ID of the resolution in Yandex Tracker | Number |
| key | Resolution key | String |
| version | Resolution version | Number |
| name | Resolution name | String |
| order | Resolution weight. This parameter affects the order in which the resolution appears in the interface | Number |
- 404
- The requested object was not found. You may have specified an invalid object ID or key.
- 409
- There was a conflict when editing the object. The error may be due to an invalid update version.