JobStatus Data Type

Response containing the job status for a background job

Properties
name data type constraints description
running boolean required boolean True when the job is running, false if not
progress JobProgress   Get job progress
Properties inherited from GenericResponse
messages array of Message   Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo  

Example

{
  "running" : true,
  "progress" : {
    "finished" : 12345,
    "done" : 12345,
    "total" : 12345,
    "started" : 12345
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}