OGC API - Processes

OGC API standards define modular API building blocks to spatially enable Web APIs in a consistent way. The OpenAPI specification is used to define the reusable API building blocks with responses in JSON and HTML.

The OGC API family of standards is organized by resource type. The OGC API - Processes standard enables the execution of computing processes and the retrieval of metadata describing the purpose and functionality of the processes. Typically, these processes execute well-defined algorithms that ingest vector and/or coverage data to produce new datasets.

Overview of OGC API - Processes - Part 1: Core

GET /processes
Lists the processes this API offers.

GET /processes/{process-id}
Returns a detailed description of a process.

POST /processes/{process-id}/execution
Executes a process (asynchronous execution will create a new job). Inputs and outputs can be specified in a JSON document that needs to be sent in the POST body.

Job Management end-points

(required for asynchronous execution, but optional for synchronous)

GET /jobs
Returns the running and finished jobs.

GET /jobs/{job-id}
Returns the status of a job.

DELETE /jobs/{job-id}
Cancel a job execution.

GET /jobs/{job-id}/results
Returns the result of a job.