The OGC API Resource Tree
This page presents the OGC API resource paths as an HTML tree.
This tree presents a mix of adopted, in-developement and experimental endpoints.
Associated with each path element, in square brackets, is an indication of the operations that each HTTP method might perform at that end point. Again, this is a mix of speculation and specification.
-
/
[GET:
Get the landing page for this data store.]
- /api
[GET:
Get the API description.]
- /conformance
[GET:
Get the list of implemented conformance classes for this
OGC API deployment.]
- /schema
[GET:
Get the schema for a set of collections in this data store.]
-
/map
[GET:
Get a map layer consisting of multiple collections
in their default styles.]
- /legend
[GET:
Get a legend graphic for this map.]
-
/styles
[GET:
Get the list of available styles.]
[POST:
Add a new style to this data store.]
-
/{styleID}
[GET:
Get the definition of this style.]
[PUT:
Redefine this style.]
[DELETE:
Remove this style.]
- /legend
[GET:
Get a legend graphic for this style.]
-
/map
[GET:
Get a map layer consisting of multiple
collections in this style.]
- /legend
[GET:
Get a legend graphic for this map.]
-
/tileMatrixSets
[GET:
Get the list of available tile-matrix sets.]
- /{tileMatrixSetID}
[GET:
Get the definition of this tile-matrix set.]
-
/search
[GET:
Get the list of available multi-collection stored queries.]
[POST:
Execute an ad-hoc multi-collection query.]
-
/{storedQueryID}
[GET:
Execute this multi-collection stored query.]
[POST:
Execute this multi-collection stored query using
application/x-www-form-urlencoded.]
[PUT:
Create or redefine this multi-collection stored query.]
[DELETE:
Remove this multi-collection stored query.]
-
/parameters
[GET:
Get the list of parameters for this multi-collection
stored query.]
-
/{parameterID}
[GET:
Get the definition of this parameter for this
multi-collection stored query.]
-
/processes
[GET:
Get the list of available processes.]
[POST:
Add (deploy) a new process.]
-
/{processID}
[GET:
Get a description of this process.]
[PUT:
Redefine this process.]
[DELETE:
Remove (undeploy) this process.]
/execution
[GET:
Execute the process (KVP-encoded request).]
[POST:
Execute the process (JSON-encoded request).]
-
/jobs
[GET:
Get the list of jobs.]
-
/{jobID}
[GET:
Get the status of this job.]
[DELETE:
Cancel/remove this job.]
-
/results
[GET:
Get the results of this job.]
[DELETE:
Delete the results of this job.]
/{resultID}
[GET:
Get this result of this job.]
[DELETE:
Delete this result of this job.]
-
/collections
[GET:
Get the list of available collections.]
[POST:
Create a new collection.]
-
/{collectionID}
[GET:
Get information about this collection.]
[PUT:
Redefine this collection.]
[DELETE:
Delete this collection.]
-
/items
[GET: Get features
from this collection.][POST: Add a feature to
this collection.][PUT: Replace features in
this collection.][PATCH: Modify features in
this collection.][DELETE: Remove features from
this collection.]
- /{featureID}
[GET: Get this
feature.][PUT:
Replace this feature.][PATCH: Modify this
feature.][DELETE:
Delete this feature.]
-
/images (aka scenes)
[GET:
Get the list of source images for this collection
if this collection is a
coverage.]
[POST:
Add a new source image to this coverage.
- /{imageID}
[GET:
Get information about this source image including
a download link.]
[PUT:
Replace this source image from this coverage.]
[DELETE :
Remove this source image from this coverage.]
-
/coverage
[GET:
Get the coverage of this collection.]
- /domainset
[GET:
Get the domain set of this coverage.]
- /rangetype
[GET:
Get the range type of this coverage.]
- /metadata
[GET:
Get the associated metadata of this coverage.]
-
/search
[GET:
Get the list of available stored queries.]
[POST:
Execute an ad-hoc query.]
-
/{storedQueryID}
[GET:
Execute this stored query.]
[POST:
Execute this stored query using
application/x-www-form-urlencoded.]
[PUT:
Create or redefine this stored query.]
[DELETE:
Remove this stored query.]
-
/parameters
[GET:
Get the list of parameters for this stored
query.]
-
/{parameterID}
[GET:
Get the definition of this parameter
for this stored query.]
-
/processes (aka DAPA)
[GET:
Get the list of available processes.]
[POST:
Add (deploy) a new process.]
-
/{processID}
[GET:
Get a description of this process.]
[PUT:
Redefine this process.]
[DELETE:
Remove (undeploy) this process.]
/execution
[GET:
Execute the process (KVP-encoded request).]
[POST:
Execute the process.]
-
/tiles
[GET:
Get a document describing the data tiles that are
available for this collection.]
-
/{tileMatrixSetID}
[GET:
Get a document describing the data tiles that
are available for this collection in this
tile-matrix set.]
-
/{tileMatrix}
-
/{tileRow}
-
/{tileCol}
[GET:
Get a data tile of this collection
at this row and column of
this zoom level of this
tile-matrix set.
-
/map
[GET: Get a
map layer of this collection in its
default style.]
-
/legend
[GET:
Get a legend graphic for this map.]
-
/tiles
[GET:
Get a document describing the tiles that
are available for this map.]
-
/{tileMatrixSetID}
[GET:
Get a document describing the tiles that
are available for this map in this
tile-matrix set.]
-
/{tileMatrix}
-
/legend
[GET:
Get a legend graphic for this
map at this zoom level of
this tile-matrix set.]
-
/{tileRow}
-
/{tileCol}
[GET:
Get a tile of this map
at this row and column of
this zoom level of this
tile-matrix set.
-
/styles
[GET:
Get the list of available styles for this collection.]
[POST:
Add a new style to this collection.]
-
/{styleID}
[GET:
Get the definition of this style for this
collection.]
[PUT:
Redefine this style for this collection.]
[DELETE:
Remove this style for this collection.]
-
/map
[GET:
Get a map layer of this collection
in this style.]
-
/legend
[GET:
Get a legend graphic for this map.]
-
/tiles
[GET:
Get a document describing the tiles
that are available for this map.]
-
/{tileMatrixSetID}
[GET:
Get a document describing the
tiles that are available for this
map in this tile-matrix set.]
-
/{tileMatrix}
-
/legend
[GET:
Get a legend graphic for this
map at this zoom level of
this tile-matrix set.]
-
/{tileRow}
-
/{tileCol}
[GET:
Get a tile of this map
at this row and column of
this zoom level of this
tile-matrix set.
-
/schema
[GET:
Get the schema for this collection based on the value
of type parameter (i.e. type=returnables |
queryables | sortables | create | replace | update).]
-
/{collectionID} (itemType=record)
[GET: Get information
about this catalogue.][PUT: Redefine this
catalogue.][DELETE:
Delete this catalogue.]
-
/items
[GET: Get records
from this catalogue.][POST: Add a record to
this catalogue.][PUT: Replace records in
this catalogue.][PATCH: Modify records in
this catalogue.][DELETE: Remove records from
this catalogue.]
- /{recordID}
[GET: Get this
record.][PUT:
Replace this record.][PATCH: Modify this
record.][DELETE:
Delete this record.]
-
/schema
[GET:
Get the schema for this collection based on
the value of type parameter (i.e.
type=returnables | queryables | sortables |
create | replace | update).]