Atlassian · Schema

TaskProgressBeanObject

Details about a task.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
description	string	The description of the task.
elapsedRuntime	integer	The execution time of the task, in milliseconds.
finished	integer	A timestamp recording when the task was finished.
id	string	The ID of the task.
lastUpdate	integer	A timestamp recording when the task progress was last updated.
message	string	Information about the progress of the task.
progress	integer	The progress of the task, as a percentage complete.
result	object	The result of the task execution.
self	string	The URL of the task.
started	integer	A timestamp recording when the task was started.
status	string	The status of the task.
submitted	integer	A timestamp recording when the task was submitted.
submittedBy	integer	The ID of the user who submitted the task.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TaskProgressBeanObject",
  "title": "TaskProgressBeanObject",
  "additionalProperties": false,
  "description": "Details about a task.",
  "properties": {
    "description": {
      "description": "The description of the task.",
      "type": "string"
    },
    "elapsedRuntime": {
      "description": "The execution time of the task, in milliseconds.",
      "format": "int64",
      "type": "integer"
    },
    "finished": {
      "description": "A timestamp recording when the task was finished.",
      "format": "int64",
      "type": "integer"
    },
    "id": {
      "description": "The ID of the task.",
      "type": "string"
    },
    "lastUpdate": {
      "description": "A timestamp recording when the task progress was last updated.",
      "format": "int64",
      "type": "integer"
    },
    "message": {
      "description": "Information about the progress of the task.",
      "type": "string"
    },
    "progress": {
      "description": "The progress of the task, as a percentage complete.",
      "format": "int64",
      "type": "integer"
    },
    "result": {
      "description": "The result of the task execution."
    },
    "self": {
      "description": "The URL of the task.",
      "format": "uri",
      "type": "string"
    },
    "started": {
      "description": "A timestamp recording when the task was started.",
      "format": "int64",
      "type": "integer"
    },
    "status": {
      "description": "The status of the task.",
      "enum": [
        "ENQUEUED",
        "RUNNING",
        "COMPLETE",
        "FAILED",
        "CANCEL_REQUESTED",
        "CANCELLED",
        "DEAD"
      ],
      "type": "string"
    },
    "submitted": {
      "description": "A timestamp recording when the task was submitted.",
      "format": "int64",
      "type": "integer"
    },
    "submittedBy": {
      "description": "The ID of the user who submitted the task.",
      "format": "int64",
      "type": "integer"
    }
  },
  "required": [
    "elapsedRuntime",
    "id",
    "lastUpdate",
    "progress",
    "self",
    "status",
    "submitted",
    "submittedBy"
  ],
  "type": "object"
}