Sign in

v1

latestOpenAPI 3.0.22026-07-17144042.9 KB
Manage Jobs

Get jobs

Retrieve jobs

get/jobs

Query parameters

status'NOT_READY' | 'SUBMITTED' | 'PENDING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'RESUMING' | 'SUCCEEDED'

Description of possible states:

  • NOT_READY (The job is not ready to be started yet as not all pre-conditions are met. E.g. that could be the input data was not provided by the user yet.)
  • SUBMITTED (The job is ready for execution, but was not started yet.)
  • PENDING (The system is trying to start the job, but it is still waiting for free execution resources.)
  • RUNNING (The job execution is currently in progress.)
  • CANCELLING (The job got the signal that it should be cancelled and is currently in the progress of cancelling all its internal steps and performing the clean up work.)
  • CANCELLED (Terminal state. The job was cancelled. That could be done by the request of the job owner, or because the system had to cancel the job. A job can be resumed if its "resumable" flag is true. See: desiredAction: RESUME)
  • FAILED (Terminal state. The job failed, because one of its internal steps failed. A job can be resumed if its "resumable" flag is true. See: desiredAction: RESUME)
  • RESUMING (The job got the signal to resume execution after it was previously cancelled or has failed. The job currently is preparing to start the execution again.)
  • SUCCEEDED (The job is completed. All its work has been done and all outputs are ready.)

Job Status

Response

Job List

typestring

The type of the job (deprecated)

idstring

The unique identifier of the job. NOTE: The id will always be generated by the service. It can not be defined by the client.

descriptionstring

A human readable description of the purpose of the job

Example response

[
  {
    "description": "This job exports some data from my space into GeoJSON files",
    "source": {
      "type": "Space",
      "id": "sdkeuh7"
    },
    "target": {
      "type": "Files"
    }
  }
]
All 14 operations