Job Status

Poll job status

All user requests can be Synchronous or Asynchronous.

To get the status of an Asynchronous request take the value for the request message and poll it using the job API call.

Example:

A user assigned a media using the assign media call.

The call returns a message containing a number which is the job Id.

{

  "Message": "544"

}

Poll and wait for the job status using jobs API (full job call description).

Wait for it to return:

"state" : "done" &"progress" : 100

Example:

curl -X GET https://api.volumez.com/jobs/544 \

  -H 'Content-Type: application/json' \

  -H 'Authorization: <IdToken>'

Sample Return: State is running and progress 10%

{"endtime":"0001-01-01T00:00:00Z","id":546,"starttime":"2024-06-25T06:59:13Z","useremail":"amir1@volumez.com","username":"c1ea6793-48dc-4879-8c58-a53d5096a4e5","args":{"RequestID":"2b375c32-d011-4ad9-b1e6-4bdd0eafd07e","allow_reprofiling_media":"false","capacity_group":"default"},"object":"/media/AWS29D8D9AAAC8C865C6","progress":10,"state":"running","status":"","type":"media_assign"}

Sample Return: State is done and progress is 100%

{"endtime":"2024-06-25T06:35:29Z","id":544,"starttime":"2024-06-25T06:35:03Z","useremail":"amir1@volumez.com","username":"c1ea6793-48dc-4879-8c58-a53d5096a4e5","args":{"RequestID":"8f4fc69f-d18f-4f05-9ed7-466d5b64db99","allow_reprofiling_media":"false","capacity_group":"default"},"object":"/media/AWS29D8D9AAAC8C865C6","progress":100,"state":"done","status":"","type":"media_assign"}