Skip to content

Atlassian: Tasks schemas

1 Atlassian schema with complete fields and constraints.

โ† Tasks operations ยท All schemas

Get task โ€” response body

FieldTypePresenceDescription and constraints
$objectRootDetails about a task.
descriptionJSONOptional
description (anyOf 1)stringAlternativeThe description of the task.
description (anyOf 2)nullAlternative
elapsedRuntimeJSONOptional
elapsedRuntime (anyOf 1)JSONAlternative
elapsedRuntime (anyOf 1) (anyOf 1)integerAlternativeThe execution time of the task, in milliseconds.
Format: int64
elapsedRuntime (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
elapsedRuntime (anyOf 2)nullAlternative
finishedJSONOptional
finished (anyOf 1)JSONAlternative
finished (anyOf 1) (anyOf 1)integerAlternativeA timestamp recording when the task was finished.
Format: int64
finished (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
finished (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeThe ID of the task.
id (anyOf 2)nullAlternative
lastUpdateJSONOptional
lastUpdate (anyOf 1)JSONAlternative
lastUpdate (anyOf 1) (anyOf 1)integerAlternativeA timestamp recording when the task progress was last updated.
Format: int64
lastUpdate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lastUpdate (anyOf 2)nullAlternative
messageJSONOptional
message (anyOf 1)stringAlternativeInformation about the progress of the task.
message (anyOf 2)nullAlternative
progressJSONOptional
progress (anyOf 1)JSONAlternative
progress (anyOf 1) (anyOf 1)integerAlternativeThe progress of the task, as a percentage complete.
Format: int64
progress (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
progress (anyOf 2)nullAlternative
resultJSONOptional
result (anyOf 1)JSONAlternativeThe result of the task execution.
result (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the task.
Format: uri
self (anyOf 2)nullAlternative
startedJSONOptional
started (anyOf 1)JSONAlternative
started (anyOf 1) (anyOf 1)integerAlternativeA timestamp recording when the task was started.
Format: int64
started (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
started (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeThe status of the task.
Known values: ENQUEUED, RUNNING, COMPLETE, FAILED, CANCEL_REQUESTED, CANCELLED, DEAD
status (anyOf 2)nullAlternative
submittedJSONOptional
submitted (anyOf 1)JSONAlternative
submitted (anyOf 1) (anyOf 1)integerAlternativeA timestamp recording when the task was submitted.
Format: int64
submitted (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
submitted (anyOf 2)nullAlternative
submittedByJSONOptional
submittedBy (anyOf 1)JSONAlternative
submittedBy (anyOf 1) (anyOf 1)integerAlternativeThe ID of the user who submitted the task.
Format: int64
submittedBy (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
submittedBy (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.