Bulk changes to issue statuses
Use this request to complete a transition to a new status for multiple issues at the same time.
POST
https://api.tracker.yandex.net/v3/bulkchange/_transition
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.
Query format
Before making a request, get permission to access the API.
To update issue statuses, use an HTTP POST
request. In the request body, specify the parameters in JSON format.
POST /v3/bulkchange/_transition
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
{
"transition": "start_progress",
"issues": ["TEST-1","TEST-2","TEST-3"]
}
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
orX-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.
-
Request parameters
Additional parameters
Parameter | Description | Data type |
---|---|---|
notify | Flag indicating if users should be notified about issue changes:
|
Boolean |
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 /v3/bulkchange/_transition Host: api.tracker.yandex.net Authorization: OAuth <OAuth_token> X-Org-ID or X-Cloud-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://api.tracker.yandex.net/v3/bulkchange/1ab23cd4e5678901********",
"createdBy": {
"self": "https://api.tracker.yandex.net/v3/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. | Map item |
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 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.
- 422
- JSON validation error, the request is rejected.