Interface BulkOperationProgress

interface BulkOperationProgress {
    created?: string;
    failedAccessibleIssues?: {
        [key: string]: string[];
    };
    invalidOrInaccessibleIssueCount?: number;
    processedAccessibleIssues?: number[];
    progressPercent?: number;
    started?: string;
    status?:
        | "CANCELLED"
        | "ENQUEUED"
        | "RUNNING"
        | "COMPLETE"
        | "FAILED"
        | "CANCEL_REQUESTED"
        | "DEAD";
    submittedBy?: User;
    taskId?: string;
    totalIssueCount?: number;
    updated?: string;
}

Properties

created? failedAccessibleIssues? invalidOrInaccessibleIssueCount? processedAccessibleIssues? progressPercent? started? status? submittedBy? taskId? totalIssueCount? updated?

Properties

Optionalcreated

created?: string

A timestamp of when the task was submitted.

OptionalfailedAccessibleIssues

failedAccessibleIssues?: {
    [key: string]: string[];
}

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.

OptionalinvalidOrInaccessibleIssueCount

invalidOrInaccessibleIssueCount?: number

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.

OptionalprocessedAccessibleIssues

processedAccessibleIssues?: number[]

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

OptionalprogressPercent

progressPercent?: number

Progress of the task as a percentage.

Optionalstarted

started?: string

A timestamp of when the task was started.

Optionalstatus

status?:
    | "CANCELLED"
    | "ENQUEUED"
    | "RUNNING"
    | "COMPLETE"
    | "FAILED"
    | "CANCEL_REQUESTED"
    | "DEAD"

The status of the task.

OptionalsubmittedBy

submittedBy?: User

A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:

  • User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, displayName provides an indication and other parameters have default values or are blank (for example, email is blank).
  • User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, accountId returns unknown and all other parameters have fallback values.
  • User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.

OptionaltaskId

taskId?: string

The ID of the task.

OptionaltotalIssueCount

totalIssueCount?: number

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

Optionalupdated

updated?: string

A timestamp of when the task progress was last updated.

Settings

Member Visibility

On This Page

Properties