Class LongRunningTaskService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task

Hierarchy

CommonHttpService
- LongRunningTaskService

Index

Constructors

Methods

getTask getTasks initialize

Constructors

constructor

new LongRunningTaskService(getClientInstance): LongRunningTaskService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns LongRunningTaskService
Inherited from CommonHttpService.constructor

Methods

getTask

getTask(params): Promise<LongTaskStatusWithLinks>
Returns information about an active long-running task (e.g. space export), such as how long it has been running and the percentage of the task that has completed.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  id: string;
  }
  - id: string
    The ID of the task.
Returns Promise<LongTaskStatusWithLinks>
Returned if the requested task is returned.

Path
GET /wiki/rest/api/longtask/{id} @scopes-current read:confluence-space.summary @scopes-beta read:content.metadata:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task#api-wiki-rest-api-longtask-id-get

getTasks

getTasks(params?): Promise<LongTaskStatusArray>
Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      key?: string;
      limit?: number;
      start?: number;
  } = {}
  - Optionalkey?: string
    The key of the tasks.
  - Optionallimit?: number
    The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits.
  - Optionalstart?: number
    The starting index of the returned tasks.
Returns Promise<LongTaskStatusArray>
Returned if the requested tasks are returned.

Path
GET /wiki/rest/api/longtask @scopes-current read:content.metadata:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task#api-wiki-rest-api-longtask-get

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize