Jira.js - Jira Cloud API library
    Preparing search index...

    Class IssueBulkOperations

    Index

    Constructors

    constructor

    Methods

    getAvailableTransitions getBulkEditableFields getBulkOperationProgress submitBulkDelete submitBulkEdit submitBulkMove submitBulkTransition submitBulkUnwatch submitBulkWatch

    Constructors

    Methods

    • Use this API to retrieve a list of transitions available for the specified issues that can be used or bulk transition operations. You can submit either single or multiple issues in the query to obtain the available transitions.

      The response will provide the available transitions for issues, organized by their respective workflows. Only the transitions that are common among the issues within that workflow and do not involve any additional field updates will be included. For bulk transitions that require additional field updates, please utilise the Jira Cloud UI.

      You can request available transitions for up to 1,000 issues in a single operation. This API uses pagination to return responses, delivering 50 workflows at a time.

      Permissions required:

      Type Parameters

      Parameters

      Returns Promise<void>

    • Use this API to retrieve a list of transitions available for the specified issues that can be used or bulk transition operations. You can submit either single or multiple issues in the query to obtain the available transitions.

      The response will provide the available transitions for issues, organized by their respective workflows. Only the transitions that are common among the issues within that workflow and do not involve any additional field updates will be included. For bulk transitions that require additional field updates, please utilise the Jira Cloud UI.

      You can request available transitions for up to 1,000 issues in a single operation. This API uses pagination to return responses, delivering 50 workflows at a time.

      Permissions required:

      Type Parameters

      Parameters

      Returns Promise<T>

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

      Permissions required:

      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.

      Type Parameters

      Parameters

      Returns Promise<void>

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

      Permissions required:

      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.

      Type Parameters

      Parameters

      Returns Promise<T>

    • Use this API to submit a bulk issue move request. You can move multiple issues from multiple projects in a single request, but they must all be moved to a single project, issue type, and parent. You can't move more than 1000 issues (including subtasks) at once.

      This is an early version of the API and it doesn't have full feature parity with the Bulk Move UI experience.

      • Moving issue of type A to issue of type B in the same project or a different project: SUPPORTED

      • Moving multiple issues of type A in one or more projects to multiple issues of type B in one of the source projects or a different project: SUPPORTED

      • Moving issues of multiple issue types in one or more projects to issues of a single issue type in one of the source project or a different project: SUPPORTED
        E.g. Moving issues of story and task issue types in project 1 and project 2 to issues of task issue type in project 3

      • Moving a standard parent issue of type A with its multiple subtask issue types in one project to standard issue of type B and multiple subtask issue types in the same project or a different project: SUPPORTED

      • Moving standard issues with their subtasks to a parent issue in the same project or a different project without losing their relation: SUPPORTED

      • Moving an epic issue with its child issues to a different project without losing their relation: SUPPORTED
        This usecase is supported using multiple requests. Move the epic in one request and then move the children in a separate request with target parent set to the epic issue id

        (Alternatively, move them individually and stitch the relationship back with the Bulk Edit API)

      When using the bulk move, keep in mind that there are limits on the number of issues and fields you can include.

      • You can move up to 1,000 issues in a single operation, including any subtasks.
      • The total combined number of fields across all issues must not exceed 1,500,000. For example, if each issue includes 15,000 fields, then the maximum number of issues that can be moved is 100.

      Permissions required:

      Type Parameters

      Parameters

      Returns Promise<void>

    • Use this API to submit a bulk issue move request. You can move multiple issues from multiple projects in a single request, but they must all be moved to a single project, issue type, and parent. You can't move more than 1000 issues (including subtasks) at once.

      This is an early version of the API and it doesn't have full feature parity with the Bulk Move UI experience.

      • Moving issue of type A to issue of type B in the same project or a different project: SUPPORTED

      • Moving multiple issues of type A in one or more projects to multiple issues of type B in one of the source projects or a different project: SUPPORTED

      • Moving issues of multiple issue types in one or more projects to issues of a single issue type in one of the source project or a different project: SUPPORTED
        E.g. Moving issues of story and task issue types in project 1 and project 2 to issues of task issue type in project 3

      • Moving a standard parent issue of type A with its multiple subtask issue types in one project to standard issue of type B and multiple subtask issue types in the same project or a different project: SUPPORTED

      • Moving standard issues with their subtasks to a parent issue in the same project or a different project without losing their relation: SUPPORTED

      • Moving an epic issue with its child issues to a different project without losing their relation: SUPPORTED
        This usecase is supported using multiple requests. Move the epic in one request and then move the children in a separate request with target parent set to the epic issue id

        (Alternatively, move them individually and stitch the relationship back with the Bulk Edit API)

      When using the bulk move, keep in mind that there are limits on the number of issues and fields you can include.

      • You can move up to 1,000 issues in a single operation, including any subtasks.
      • The total combined number of fields across all issues must not exceed 1,500,000. For example, if each issue includes 15,000 fields, then the maximum number of issues that can be moved is 100.

      Permissions required:

      Type Parameters

      Parameters

      Returns Promise<T>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods