Start processing a batch job
Adds a batch job to the processing queue to compute the results.
The result will be stored in the format specified in the process. To specify the format use a process such as save_result.
The job status is set to queued, if processing does not start instantly. The same applies if the job status is canceled, finished, or error, which restarts the job and discards previous results if the back-end does not reject the request with an error. Clients SHOULD warn users and ask for confirmation if results may get discarded.
- Once the processing starts the status is set to running.
- Once the data is available to download the status is set to finished.
- Whenever an error occurs during processing, the status MUST be set to error.
This endpoint has no effect if the job status is already queued or running. In particular, it does not restart a running job. To restart a queued or running job, processing MUST have been canceled.
Back-ends SHOULD reject queueing jobs with openEO error PaymentRequired, if the back-end is able to detect that the budget is too low to fully process the request. Alternatively, back-ends MAY provide partial results once reaching the budget. If none of the alternatives is feasible, the results are discarded. Thus, client SHOULD warn users that reaching the budget may lead to partial or no results at all.
Response
The creation of the resource has been queued successfully.