persistRunJob

Description

Tells the platform to run the Job specified by jobID, which creates a JobRun and a TaskRun record in the database for each task in the job. These "run" records are unique and allow you to retain an easy-to-reference work history.

See here for more details on Persist.

Example

Request

The request contains just the ID of the PersistJob.

{
  "jobID": 42
}

Reply

The reply includes the JobRunID and the number of tasks in the job.

{
  "jobRunID": 1,
  "taskRunCount": 3
}

Request Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "description":"Create and start a JobRun of the job denoted by JobID.",
  "type":"object",
  "required":[
    "jobID"
  ],
  "additionalProperties":false,
  "properties":{
    "jobID":{
      "title":"Job ID",
      "description":"Identifies the Job record.",
      "type":"integer",
      "minimum":1
    }
  }
}

Reply Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"object",
  "required":[
    "jobRunID",
    "countTaskRuns"
  ],
  "additionalProperties":false,
  "properties":{
    "jobRunID":{
      "title":"JobRun ID",
      "description":"Identifies the JobRun record created and started.",
      "type":"integer"
    },
    "countTaskRuns":{
      "title":"TaskRun Count",
      "description":"The number of TaskRun records created.",
      "type":"integer"
    }
  }
}