Task Results

The task results JSON document describes the results of all tasks once a job execution has finished (reached a terminal state).

Task Results Specification Version 1.0

A valid task results is a JSON document with the following structure:

{
   "version": STRING,
   "tasks": [{
      "task_id": STRING,
      "type": STRING,
      "was_launched": BOOLEAN,
      "launched": STRING,
      "was_started": BOOLEAN,
      "started": STRING,
      "was_timed_out": BOOLEAN,
      "ended": STRING,
      "status": STRING,
      "exit_code": INTEGER
   }]
}

version

Type: String
Required: No

---

Defines the version of the configuration specification used. This allows updates to be made to the specification while maintaining backwards compatibility by allowing Scale to recognize an older version and convert it to the current version. The default value, if not included, is the latest version (currently 1.0).

tasks

Type: Array
Required: No

---

Array of objects that describe each task in the execution. Each task object has the following fields:

• task_id

  Type: String
  Required: Yes

  ---

  Defines the unique Scale ID for the task.

• type

  Type: String
  Required: Yes

  ---

  Defines the type of the task and only has the following valid values: pull, pre, main, or post.

• was_launched

  Type: Boolean
  Required: Yes

  ---

  Indicates whether the task was launched.

• launched

  Type: String
  Required: No

  ---

  ISO-8601 formatted datetime describing when the task was launched.

• was_started

  Type: Boolean
  Required: No

  ---

  Indicates whether the task started running.

• started

  Type: String
  Required: No

  ---

  ISO-8601 formatted datetime describing when the task started running.

• was_timed_out

  Type: Boolean
  Required: No

  ---

  Indicates whether the task timed out.

• ended

  Type: String
  Required: No

  ---

  ISO-8601 formatted datetime describing when the task ended.

• status

  Type: String
  Required: No

  ---

  Describes the final status of the task. The valid values are FAILED, COMPLETED, and CANCELED.

• exit_code

  Type: Integer
  Required: No

  ---

  Describes the exit code returned by the task execution.