Skip to content

Task Result Response

Chris Churas edited this page Oct 17, 2024 · 6 revisions

The result returned by this service.

{
 "id": string // task identifier
 "progress": number // 0 - 100 where 100 means complete
 "message": string // Message if task failed
 "status": string // One of the following: submitted, processing, complete, failed
 "result": object (result)
}

progress

A number between 0 and 100 denoting the progress of the task. 0 means 0% and 100 means 100% complete

message

Holds the error message when the task has failed.

status

The current status of the specified task. Its value should be one of these:

  • submitted
  • processing
  • complete
  • failed

Holds the result of the request. Its format varies depending on the action attribute defined in the app definition. See result for more information.

NOTE: If status endpoint is called this will be set to null