jira.js
    Preparing search index...

    Function getBulkOperationProgress

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

      Parameters

      • client: Client
      • parameters: { taskId: string }
        • taskId: string

          The ID of the task.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              created?: Date;
              failedAccessibleIssues?: Record<string, any>;
              invalidOrInaccessibleIssueCount?: number;
              processedAccessibleIssues?: number[];
              progressPercent?: number;
              started?: Date;
              status?:
                  | string & {}
                  | "ENQUEUED"
                  | "RUNNING"
                  | "COMPLETE"
                  | "FAILED"
                  | "CANCEL_REQUESTED"
                  | "CANCELLED"
                  | "DEAD";
              submittedBy?: {
                  accountId?: string;
                  accountType?: "unknown"
                  | string & {}
                  | "atlassian"
                  | "app"
                  | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...)[];
                          defaultGroupsDetails?: (...)[];
                          defined?: boolean;
                          groupDetails?: (...)[];
                          groups?: (...)[];
                          hasUnlimitedSeats?: boolean;
                          key?: string;
                          name?: string;
                          numberOfSeats?: number;
                          platform?: boolean;
                          remainingSeats?: number;
                          selectedByDefault?: boolean;
                          userCount?: number;
                          userCountDescription?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: string | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              taskId?: string;
              totalIssueCount?: number;
              updated?: Date;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility