Bulk changes to issue statuses
Use this request to complete a transition to a new status for multiple issues at the same time.
Note
To find out what status transitions are available for an issue, make a request for a list of transitions. For some statuses, e.g., Closed, the request body needs to specify the resolution in the value parameter.
Request format
Before making the request, get permission to access the API.
To update issue statuses, use an HTTP POST request. Request parameters are provided in the request body in JSON format.
POST /v2/bulkchange/_transition
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>
{
"transition": "start_progress",
"issues": ["TEST-1","TEST-2","TEST-3"]
}
Headers
-
Host
Address of the node that provides the API:
https://api.tracker.yandex.net -
Authorization
OAuth token in
OAuth <OAuth_token>format, e.g.:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID or X-Cloud-Org-ID
Organization ID. You can find it out on the Tracker organizations page.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
X-Org-IDheader is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-IDheader is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-IDheader and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Request parameters
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| notify | Flag indicating if users should be notified about issue changes:
|
Logical |
Request body parameters
Required parameters
| Parameter | Description | Data type |
|---|---|---|
| transition | Transition ID. | String |
| issues | IDs of the issues to change the status of. | String |
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| values | Issue parameters that will be updated after the status change. Use the parameters that are available when editing the issue. | String |
Example. Bulk change of multiple issues' statuses.
- An HTTP POST method is used.
- The status for the TEST-1, TEST-2, and TEST-3 issues changes to Closed with the Resolved resolution.
POST /v2/bulkchange/_transition Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth_token> X-Org-ID: <organization ID> { "transition": "close", "issues": ["TEST-1", "TEST-2", "TEST-3"], "values": { "resolution": "fixed" } }
Response format
If the request is successful, the API returns a response with code 201 Created.
The response body contains information about the bulk change operation in JSON format.
{
"id": "1ab23cd4e5678901********",
"self": "https://https://api.tracker.yandex.net/v2/bulkchange/1ab23cd4e5678901********",
"createdBy": {
"self": "https://https://api.tracker.yandex.net/v2/users/12********",
"id": "12********",
"display": "Full name"
},
"createdAt": "2020-12-15T11:52:53.665+0000",
"status": "CREATED",
"statusText": "Bulk change task created.",
"executionChunkPercent": 0,
"executionIssuePercent": 0
}
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| id | Bulk change operation ID. | String |
| self | Address of the API resource with information about the bulk change. | String |
| createdBy | Object with information about the user who made the bulk change. | Object |
| createdAt | Date and time when the bulk change operation was created. | String |
| status | Bulk change operation status. | String |
| statusText | Description of the bulk change operation status. | String |
| executionChunkPercent | Service parameter | Number |
| executionIssuePercent | Service parameter | Number |
createdBy object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the user. | String |
| id | User ID. | Number |
| display | Displayed user name. | 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.
- 401
- The user isn't authorized. Make sure to perform the actions described in API access.
- 403
- Insufficient rights 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.
- 422
- JSON validation error, the request is rejected.