Making a status transition

Use this request to switch an issue to a new status.

POST

https://api.tracker.yandex.net/v3/issues/<issue_ID>/transitions/<transition_ID>/_execute

Query format

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

To change an issue's status, use an HTTP POST request. If the transition settings let you change the issue parameters, specify them in the request body in JSON format:

POST /v3/issues/<issue_ID>/transitions/<transition_ID>/_execute
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
  "<key_1>":"<value_1>",
  "<key_2>":"<value_2>",
  ...
  "comment":"<comment_text>"
}
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
<issue_ID> ID or key of the current issue. String
<transition_ID> Transition ID. String
Request body parameters

Required parameters

Parameter Value Data type
<key> Issue field that can be edited during the transition. List of keys: https://tracker.yandex.com/admin/fields Depends on the parameter type.
comment Comment on the issue. String

Response format

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

The response body contains a JSON array with a list of transitions available for the issue in the new status.

[
{
  "self": "https://api.tracker.yandex.net/v3/issues/DESIGN-1/transitions/close",
  "id" : "close",
  "to" : {
  "self": "https://api.tracker.yandex.net/v3/statuses/3",
    "id" : "3",
    "key" : "closed",
    "display" : "Closed"
  },
  "screen" : {
    "self": "https://api.tracker.yandex.net/v3/screens/50c85b17e4b04b38********",
    "id" : "50c85b17e4b04b38********"
  }
 },
 ...
]
Response parameters
Parameter Description Data type
self Address of the API resource with information about the transition. String
id Transition ID. String
to Block with information about the status that the issue can transition to. Map item
screen Block with information about the transition screen. Map item

to object fields

Parameter Description Data type
self Address of the API resource with information about the status. String
id Status ID. String
key Status key. String
display Status name displayed. String

screen object fields

Parameter Description Data type
self Address of the API resource with information about the transition screen. String
id Transition screen ID. 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.
409
There was a conflict when editing the object. The error may be due to an invalid update version.
422
JSON validation error, the request is rejected.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.
Previous
Getting transitions
Next
Getting the history of issue changes