Function getTask

getTask(
    client: Client,
    parameters: { taskId: string },
    options?: RequestOptions,
): Promise<
    {
        description?: string;
        elapsedRuntime: number;
        finished?: number;
        id: string;
        lastUpdate: number;
        message?: string;
        progress: number;
        result?: unknown;
        self: string;
        started?: number;
        status: | string & {}
        | "ENQUEUED"
        | "RUNNING"
        | "COMPLETE"
        | "FAILED"
        | "CANCEL_REQUESTED"
        | "CANCELLED"
        | "DEAD";
        submitted: number;
        submittedBy: number;
        [key: string]: unknown;
    },
>
Returns the status of a long-running asynchronous task.

When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice.

Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.
- read:jira-work
Permissions required: either of:
- Administer Jira global permission.
- Creator of the task.
Parameters
- client: Client
- parameters: { taskId: string }
  - taskId: string
    
    The ID of the task.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        description?: string;
        elapsedRuntime: number;
        finished?: number;
        id: string;
        lastUpdate: number;
        message?: string;
        progress: number;
        result?: unknown;
        self: string;
        started?: number;
        status: | string & {}
        | "ENQUEUED"
        | "RUNNING"
        | "COMPLETE"
        | "FAILED"
        | "CANCEL_REQUESTED"
        | "CANCELLED"
        | "DEAD";
        submitted: number;
        submittedBy: number;
        [key: string]: unknown;
    },
>
- Defined in src/cloud/api/tasks.ts:22

Function getTask

Parameters

taskId: string

Settings