Managing jobs
Use the jobs resource to get information about and remove jobs and schedules. Jobs contain information about executing report designs and report documents. Schedules contain information about when to run jobs. Jobs are created by
POST visuals/{visualId}/schedule/now resource requests or generated by schedules. Schedules are created by POST visuals/{visualId}/schedule/once and POST visuals/{visualId}/schedule/recurring resource requests.
The following sections provide an example of using each jobs resource as a curl command.
GET jobs
The following URI requests the status of all completed jobs:
GET /ihub/v1/jobs HTTP/1.1
Host: myserver.mycompanyname.com:5000
AuthId: <authId>
This curl example requests the status of all completed jobs in the default volume:
curl -i http://%RESTHost%:5000/ihub/v1/jobs ‑H "AuthId:%RESTAuthId%"
GET jobs/{jobId}/status
The following request gets the status of job 310100000100:
GET /ihub/v1/jobs/310100000100/status HTTP/1.1
Host: myserver.mycompanyname.com:5000
AuthId: <authId>
This curl example requests the status of the job with the job ID 310100000100 in the default volume:
curl -i http://%RESTHost%:5000/ihub/v1/jobs/310100000100/status ‑H "AuthId:%RESTAuthId%"
DELETE jobs/{jobId}
The following HTTP request deletes job 120100000100:
DELETE /ihub/v1/jobs/120100000100?type=delete HTTP/1.1
Host: myserver.mycompanyname.com:5000
Content-Type: application/json
AuthId: <authId>
This curl DELETE example deletes the job with the job ID 120100000100 in the default volume:
curl -i http://%RESTHost%:5000/ihub/v1/jobs/120100000100 ‑X DELETE ‑H "AuthId:%RESTAuthId%"