v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB

Data Processing

Batch Jobs

Modify a batch job

Modifies an existing job at the back-end, but maintains the identifier. Changes can be grouped in a single request.

The job status does not change.

Jobs can only be modified when the job is not queued and not running. Otherwise, requests to this endpoint MUST be rejected with openEO error JobLocked.

patch/jobs/{job_id}

Request body

titlestring nullable

A short description to easily distinguish entities.

descriptionstring commonmark nullable

Detailed multi-line description to explain the entity.

CommonMark 0.29 syntax MAY be used for rich text representation.

planstring nullable

The billing plan to process and charge the job or service with.

Billing plans MUST be accepted in a case insensitive manner. Back-ends MUST resolve the billing plan in the following way if billing is supported:

If a value is given and it is not null: Persist the plan that has been provided in the request.
Otherwise, do not change the billing plan.

Billing plans not on the list of available plans MUST be rejected with openEO error BillingPlanInvalid.

budgetnumber nullable

Maximum amount of costs the request is allowed to produce. The value MUST be specified in the currency of the back-end. No limits apply, if the value is null.

log_level'error' | 'warning' | 'info' | 'debug'

Updates the minimum severity level for log entries that the back-end stores for the processing requests.

The back-end does not need to update existing log entries.

Response

Changes to the job applied successfully.