v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB

Issue bulk operations

Get bulk issue operation progress

Use this to get the progress state for the specified bulk operation taskId.

Permissions required:

Global bulk change permission.

If the task is running, this resource will return:

{"taskId":"10779","status":"RUNNING","progressPercent":65,"submittedBy":{"accountId":"5b10a2844c20165700ede21g"},"created":1690180055963,"started":1690180056206,"updated":169018005829}

If the task has completed, then this resource will return:

{"processedAccessibleIssues":[10001,10002],"created":1709189449954,"progressPercent":100,"started":1709189450154,"status":"COMPLETE","submittedBy":{"accountId":"5b10a2844c20165700ede21g"},"invalidOrInaccessibleIssueCount":0,"taskId":"10000","totalIssueCount":2,"updated":1709189450354}

Note: You can view task progress for up to 14 days from creation.

get/rest/api/3/bulk/queue/{taskId}

Path parameters

taskIdstring required

The ID of the task.

Response

Returned if the request is successful.

createdstring date-time

A timestamp of when the task was submitted.

failedAccessibleIssuesobject

Map of issue IDs for which the operation failed and that the user has permission to view, to their one or more reasons for failure. These reasons are open-ended text descriptions of the error and are not selected from a predefined list of standard reasons.

invalidOrInaccessibleIssueCountinteger

The number of issues that are either invalid or issues that the user doesn't have permission to view, regardless of the success or failure of the operation.

processedAccessibleIssuesinteger[]

List of issue IDs for which the operation was successful and that the user has permission to view.

progressPercentinteger

Progress of the task as a percentage.

startedstring date-time

A timestamp of when the task was started.

The status of the task.

taskIdstring

The ID of the task.

totalIssueCountinteger

The number of issues that the bulk operation was attempted on.

updatedstring date-time

A timestamp of when the task progress was last updated.