Skip to content

Wait and get job report

Jump to bottom
Saad Kadhi edited this page Mar 23, 2017 · 3 revisions

This API call is almost the same as Get Job Report API but introduces an asynchronous behavior. It means that this API can wait for a given amount of time until the job completes. It also supports a timeout parameter.

Instead of returning the details of an in-progress job, it will wait until it finishes then returns the report, provided it doesn't timeout.

URL

GET /api/job/<JOB_ID>/waitreport?atMost=<DURATION>

JOB_ID must be a valid job id. DURATION should be a valid duration, default to infinite. The duration format is a string composed by a number and a unit (based on Scala durations), for example:

  • 10seconds
  • 1minute
  • 10minutes
  • 2hours

If atMostquery parameter is not specified, it defaults to Infinite (which can be a very, very long time considering the age of the Universe).

Output

Same output as Get Job Report API.

How to use it

curl http://<CORTEX_SERVER>:<CORTEX_PORT>/api/job/<JOB_ID>/waitreport

Documentation has been moved here

Clone this wiki locally