Make bulk changes to issues
Written by
Use this request to change parameters for multiple issues at once.
Request format
Before making the request, get permission to access the API.
To edit issues, use an HTTP POST
request. Request parameters are passed 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>": "<parameter value>",
"<parameter>": "<parameter value>"
}
}
Headers
-
Host
Address of the node that provides the API:
https://api.tracker.yandex.net
-
Authorization
OAuth token in
OAuth <token value>
format. For example:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Organization ID.
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 |
---|---|---|
issues | IDs of issues to be edited. | String |
values | Issue parameters that will be updated. Use the parameters that are available when editing the issue. | String |
Example: Edit issues.
- An HTTP POST method is used.
- The type for issues
TEST-1,TEST-2, andTEST-3is changed toBug.
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": "Bug"} } }
Response format
Successful execution of the request
The request failed
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": "1ab23cd4e56789012fg345h6",
"self": "https://api.tracker.yandex.net/v2/bulkchange/1ab23cd4e56789012fg345h6",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/1234567890",
"id": "1234567890",
"display": "First and Last 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 |
Object fields createdBy
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the user. | String |
id | User ID. | Number |
display | User's name displayed. | 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.