https://github.com/opengeospatial/ogcapi-processes
https://github.com/opengeospatial/ogcapi-processes
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/opengeospatial/ogcapi-processes
- Owner: opengeospatial
- License: other
- Created: 2017-03-27T16:12:42.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2026-04-13T13:28:06.000Z (3 months ago)
- Last Synced: 2026-04-13T15:10:49.113Z (3 months ago)
- Language: CSS
- Homepage: https://ogcapi.ogc.org/processes
- Size: 18.5 MB
- Stars: 56
- Watchers: 23
- Forks: 45
- Open Issues: 84
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OGC API - Processes
This GitHub repository contains the OGC API - Processes for processing geospatial information on the web. It focuses on a simple RESTful core specified
as reusable [OpenAPI](http://openapis.org) components with responses in JSON and HTML.
The latest published version of _OGC API - Processes - Part 1: Core_ is found here in [HTML](https://docs.ogc.org/is/18-062r2/18-062r2.html) or [PDF](https://docs.ogc.org/is/18-062r2/18-062r2.pdf).
The latest Editor's Draft version of _OGC API - Processes - Part 1: Core_ (v2.0) is found here in [HTML](https://docs.ogc.org/DRAFTS/18-062r3.html) or [PDF](https://docs.ogc.org/DRAFTS/18-062r3.pdf).
The latest Draft of _OGC API - Processes - Part 2: Deploy, Replace, Undeploy_ is found here in [HTML](http://docs.ogc.org/DRAFTS/20-044.html) or [PDF](http://docs.ogc.org/DRAFTS/20-044.pdf).
The latest Draft of _OGC API - Processes - Part 3: Workflows and Chaining_ is found here in [HTML](https://docs.ogc.org/DRAFTS/21-009.html) or [PDF](https://docs.ogc.org/DRAFTS/21-009.pdf).
The latest Draft of _OGC API - Processes - Part 4: Job Management_ is found here in [HTML](https://docs.ogc.org/DRAFTS/24-051.html) or [PDF](https://docs.ogc.org/DRAFTS/24-051.pdf).
[OGC API standards](https://ogcapi.ogc.org) define modular API building blocks to spatially enable Web APIs
in a consistent way. [OpenAPI](http://openapis.org) is used to define the reusable
API building blocks.
## Overview
The _OGC API - Processes_ enables the execution of computing processes and the retrieval of metadata describing their purpose and functionality.
Typically, these processes combine raster, vector, and/or coverage data with well-defined algorithms to produce new raster, vector, and/or coverage information.
### Part 1: Core
| Method | Endpoint | Description |
|--------|------------------------------------|----------------------------------------------------------------------------|
| GET | `/processes` | Lists the processes this API offers. |
| GET | `/processes/{processID}` | Returns a detailed description of a process. |
| POST | `/processes/{processID}/execution` | Executes a process, synchrously or asynchrously (i.e.: creates a new job). |
| GET | `/jobs` | Returns the running and finished jobs for a process. |
| GET | `/jobs/{jobID}` | Returns the status of a job of a process. |
| DELETE | `/jobs/{jobID}` | Cancel a job execution. |
| GET | `/jobs/{jobID}/results` | Returns the result of a job of a process. |
### Part 2: Deploy, Replace, Undeploy
| Method | Endpoint | Description |
|--------|--------------------------|--------------------------------------|
| POST | `/processes` | Deploy a new process. |
| PUT | `/processes/{processID}` | Replace an existing process. |
| DELETE | `/processes/{processID}` | Undeploy a process. |
### Part 3: Workflows and Chaining
No additional endpoints. Execution reuses the same endpoints as in Part 1 with nested processes and additional parameters.
### Part 4: Job Management
| Method | Endpoint | Description |
|--------|-------------------------|---------------------------------------------------|
| POST | `/jobs` | Create a new job (potentially pending execution). |
| PATCH | `/jobs/{jobID}` | Update an existing job (if pending execution). |
| POST | `/jobs/{jobID}/results` | Trigger execution of an existing job. |
| GET | `/jobs/{jobID}/prov` | Returns provenance details of a completed job. |
## Using the standard
The standard is on the OGC website:
* OGC API - Processes - Part 1: Core
* [Version 1.0.0 (latest approved version)](https://docs.ogc.org/is/18-062r2/18-062r2.html)
Those who want to just see the endpoints and responses can explore [examples of
developer-friendly OpenAPI definitions](https://ogcapi.ogc.org/processes).
The reference version of the OpenAPI components and XML schemas are published
in the [OGC schema repository](http://schemas.opengis.net/ogcapi/processes).
Several implementations of the draft standard exist:
[Implementations of the draft specification / demo services](./implementations.adoc)
## Contributing
The contributor understands that any contributions, if accepted by the OGC Membership, shall be incorporated into OGC API - Processes standards documents and that all copyright and intellectual property shall be vested to the OGC.
The OGC API - Processes Standards Working Group (SWG) is the group at OGC responsible for the stewardship of the standard, but is working to do as much work in public as possible.
* [Open issues](https://github.com/opengeospatial/ogcapi-processes/issues)
* [Copy of License Language](https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/LICENSE)
Pull Requests from contributors are welcomed. However, please note that by sending a Pull Request or Commit to this GitHub repository, you are agreeing to the terms in the Observer Agreement https://portal.ogc.org/files/?artifact_id=92169