Tasks

Get task

Changed on

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:

get/rest/api/3/task/{taskId}

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/task/{taskId}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work

Path parameters

taskIdstring required

The ID of the task.

Response

Returned if the request is successful.

descriptionstring

The description of the task.

elapsedRuntimeinteger required

The execution time of the task, in milliseconds.

finishedinteger

A timestamp recording when the task was finished.

idstring required

The ID of the task.

lastUpdateinteger required

A timestamp recording when the task progress was last updated.

messagestring

Information about the progress of the task.

progressinteger required

The progress of the task, as a percentage complete.

resultunknown
selfstring uri required

The URL of the task.

startedinteger

A timestamp recording when the task was started.

status'ENQUEUED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCEL_REQUESTED' | 'CANCELLED' | 'DEAD' required

The status of the task.

submittedinteger required

A timestamp recording when the task was submitted.

submittedByinteger required

The ID of the user who submitted the task.

Changes