Bulk changes to issues

Use this request to reconfigure multiple issues at the same time.

POST

https://api.tracker.yandex.net/v3/bulkchange/_update

The maximum number of issues per change is 10,000.

Query format

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

To edit issues, use an HTTP POST request. In the request body, specify the parameters in JSON format.

POST /v3/bulkchange/_update
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-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.

  • 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.

Request parameters

Additional parameters

Parameter Description Data type
notify Flag indicating if users should be notified about issue changes:
  • true: Users specified in the issue fields are notified.
  • false (by default): No users are notified.
 Boolean
Request body parameters

Required parameters

Parameter

Description

Data type

issues

Array of issue IDs or a filter in the query language.

When creating a request, please note that you must escape quotation marks and special characters with a backslash (\). For more information, see Using special characters.

Array or String

values

Issue parameters that should be updated. Use the parameters that are available when editing the issue.

To edit issue parameters, you can use the set, add, remove, and other operators. For more information, see Editing parameters.

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 /v3/bulkchange/_update
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-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.
  • Issue search filter: the name contains Test, and the assignee is username.
  • Issue editing: the priority changes to Blocker, and the "Updated via API" comment is added.
POST /v3/bulkchange/_update
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
{
 "issues": "Summary: Test Assignee: username",
 "values": {
   "comment": "Updated via API",
   "priority": {"key": "blocker"}
 }
}

Example 3: Change tags in issues.

  • An HTTP POST method is used.
  • In the issues TEST-1, TEST-2, and TEST-3, tag2 replaces tag1.
POST /v3/bulkchange/_update
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
{
 "issues": ["TEST-1","TEST-2","TEST-3"],
 "values": {
   "tags": {"replace": {"target": "tag1", "replacement": "tag2"}
   }
 }
}

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": "username",
        "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.
Previous
Bulk moving issues to a different queue
Next
Bulk changes to issue statuses