ATatlassian
Long-running task

Get long-running task

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

get/wiki/rest/api/longtask/{id}

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/longtask/{id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-space.summary

Path parameters

idstring required

The ID of the task.

Response

Returned if the requested task is returned.

aristring

the ARI for the long task, based on its ID

idstring required
elapsedTimeinteger required
percentageCompleteinteger required
successfulboolean required
finishedboolean required
_linksGenericLinks required
statusstring

Changes

No recorded changes to this operation across all 2 revisions of this API.