Bulk changes to issues
Use this request to reconfigure multiple issues at the same time.
Note
The maximum number of issues per change is 10,000.
Request format
Before making the request, get permission to access the API.
To edit issues, use an HTTP POST
request. Request parameters are provided in the request body in JSON format.
POST /v2/bulkchange/_update
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
{
"issues": ["TEST-1", "TEST-2", "TEST-3"],
"values": {
"<parameter_1>": "<parameter_1_value>",
"<parameter_2>": "<parameter_2_value>"
}
}
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-ID
header is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-ID
header is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-ID
header 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 |
---|---|---|
issues | Array of issue IDs or a filter in the query language. | Array or String |
values | Issue parameters that will be updated. Use the parameters that are available when editing the issue. | String |
Example 1: Edit issues.
- An HTTP POST method is used.
- The issue type for TEST-1, TEST-2, and TEST-3 changes to Error.
POST /v2/bulkchange/_update Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth_token> X-Org-ID: <organization ID> { "issues": ["TEST-1","TEST-2","TEST-3"], "values": { "type": {"name": "Error"} } }
Example 2: Edit issues using a filter in the query language.
- An HTTP POST method is used.
- For issues with the word
Test
in their names, the priority changes toBlocker
and a comment saying Updated via API is added.
POST /v2/bulkchange/_update Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth_token> X-Org-ID: <organization ID> { "issues": "Summary: Test" "values": { "comment": "Updated via API", "priority": {"key": "blocker"} } }
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.