Editing a resolution

Use this request to make changes to a resolution.

PATCH

https://api.tracker.yandex.net/v3/resolutions/<resolution_key_or_ID>?version=<resolution_version>

You need Administrator rights to run this request.

Request format

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

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

PATCH /v3/resolutions/<resolution_ID_or_key>?version=<resolution_version>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
{
    "name": {
        "ru": "Моя резолюция",
        "en": "My resolution"
    },
    "description": "My resolution's description",
    "order": 350
}

To retrieve resolution parameters such as id, key, or version, use the Get a list of resolutions request.

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-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 Administration → Organizations and copy the value from the ID field.

Resource
Parameter Description Data type
resolution_ID_or_key Unique ID of the resolution in Yandex Tracker or the resolution key. View the list of resolutions on the https://tracker.yandex.com/admin/resolutions page Number or string
Request parameters

Additional parameters

Parameter Description Data type
version Resolution version. Changes only apply to the current resolution version. Number
Request body parameters

Additional parameters

Parameter Description Data type
name Resolution name. Object
description Resolution description. String
order Resolution weight. This parameter affects the order of resolution display in the interface. Number

Example: Changing a resolution name.

  • An HTTP PATCH method is used.
  • Editing resolution with id = 9 and version = 1.
  • Resolution to be renamed to: Won't fix.
PATCH /v3/resolutions/9?version=1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name": {
        "ru": "Не будет исправлено",
        "en": "Won't fix"
        },
    "description": "Issue won't be fixed"
}

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains information about the edited resolution in JSON format.

    {
        "self": "https://api.tracker.yandex.net/v3/resolutions/9",
        "id": 9,
        "key": "myResolution",
        "version": 2,
        "name": "Won't fix",
        "description": "Issue won't be fixed",
        "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
description Resolution description String
order Resolution weight. This parameter affects the order in which the resolution appears in the interface Number

If the request is processed incorrectly, the API returns a response with an error code:

401
The user is not authorized. Make sure that actions described in the API access section are performed.
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.
409
There was a conflict when editing the object. The error may be due to an invalid update version.
423
Object edits disabled. The version parameter value limit (the maximum number of object updates) might have been exceeded. The maximum version value is 10100 for robots and 11100 for users.
Previous
Creating a resolution
Next
Adding a record of time spent