Bulk operation's status and details

You can view the status of your bulk issue edit and a list of errors for each issue:

GET

https://api.tracker.yandex.net/v3/bulkchange/<id>

Get the status of a bulk operation

Query format

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

Use an HTTP GET request to retrieve the status of a bulk operation.

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

Resource
Parameter Description Data type
<id> ID of the running bulk operation in 593cd211ef7e8a33******** format. String

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains the bulk operation status in JSON format.

{
   "id": "593cd211ef7e8a33********",
   "self": "https://api.tracker.yandex.net/v3/bulkchange/593cd211ef7e8a33********",
   "createdBy": {
      "self": "https://api.tracker.yandex.net/v3/users/1120000000******",
      "id": "111111",
      "display": "John Smith",
      "passportUid": 12********
   },
   "createdAt": "2024-06-26T19:00:47.451+0000",
   "status": "FAILED",
   "statusText": "Bulk edit completed with errors",
   "executionChunkPercent": 100,
   "executionIssuePercent": 100,
   "totalIssues": 24,
   "totalCompletedIssues": 0
}
Response parameters
Parameter Description Data type
id Bulk operation ID. String
self Address of the API resource that contains information about the bulk operation. String
createdBy Details about who started the bulk operation. Map item
createdAt Bulk operation date and time. String
status Bulk operation status. String
statusText Description of the bulk operation status. String
executionChunkPercent Service parameter Number
executionIssuePercent Service parameter Number
totalIssues Number of issues to be edited. Number
totalCompletedIssues Number of issues with successful bulk operations. Number

createdBy object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization 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.

Get a list of issues where operations returned an error

Query format

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

Use an HTTP GET request to retrieve a list of issues where operations returned an error.

GET /v3/bulkchange/{id}/issues
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
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.

Resource
Parameter Description Data type
<id> ID of the running bulk operation in 593cd211ef7e8a33******** format. String

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains a JSON list of issues where operations returned an error.

[
   {
      "issue": {
            "self": "https://api.tracker.yandex.net/v3/issues/TEST-1",
            "id": "593cd211ef668a33********",
            "key": "TEST-1",
            "display": "Test"
      },
      "status": "FAILED",
      "statusText": "Edit failed",
      "error": {
            "errors": {
               "resolution": "You cannot use the selected resolution for this type of issue in this queue."
            },
            "errorMessages": []
      }
   },
   {
      "issue": {
            "self": "https://api.tracker.yandex.net/v3/issues/TEST-4",
            "id": "593cd211ef756a33********",
            "key": "TEST-4",
            "display": "Issue"
      },
      "status": "FAILED",
      "statusText": "Edit failed",
      "error": {
            "errors": {
               "resolution": "You cannot use the selected resolution for this type of issue in this queue."
            },
            "errorMessages": []
      }
   },
   ...
]
Response parameters
Parameter Description Data type
issue Block with issue details. Map item
status Type of error in the bulk operation. String
statusText Error description for the bulk process. String
error Block with details about errors that occurred during the bulk operation. Map item

createdBy object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

error object fields

Parameter Description Data type
errors Error description. Map item
errorMessages Service parameter Array

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 changes to issue statuses
Next
Getting global fields