Specification⚓︎
OpenAPI/Swagger description⚓︎
Endpoints⚓︎
OGC API - Records⚓︎
Landing page⚓︎
GET /catalogue
Description⚓︎
Returns an overview of the service, endpoints, and contact.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The landing page |
application/json |
200 |
The landing page |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
OpenAPI⚓︎
GET /catalogue/openapi
Description⚓︎
Provides an OpenAPI document describing service endpoints, models, perameters, and other API information.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The OpenAPI document |
application/vnd.oai.openapi+json;version=3.0 |
200 |
The OpenAPI document via Swagger |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
Conformance⚓︎
GET /catalogue/conformance
Description⚓︎
Returns a list of supported OGC API conformance classes.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The conformance page |
application/json |
200 |
The conformance page |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
Collections⚓︎
GET /catalogue/collections
Description⚓︎
Returns a list of collections of metadata.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The listing of metadata collections |
application/json |
200 |
The listing of metadata collections |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
Main collection⚓︎
GET /catalogue/collections/metadata:main
Description⚓︎
Returns a description of the main collection of metadata.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The description of the main metadata collection |
application/json |
200 |
The description of the main metadata collection |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
Main collection queryables⚓︎
GET /catalogue/collections/metadata:main/queryables
Description⚓︎
Returns a listing of all queryables of the main collection of metadata.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The main metadata collection’s queryables |
application/json |
200 |
The main metadata collection’s queryables |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
Metadata collection items⚓︎
GET /catalogue/collections/metadata:main/items
POST /catalogue/collections/metadata:main/items
Description⚓︎
Returns metadata items as a result of query.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
|
q |
Free-text search terms to query. |
|
bbox |
The record bounding bounding box to filter on. Expressed as 'minx,minyx,maxx,maxy' in CRS84. |
|
datetime |
The temporal period to filter on. Expressed as 'minx,minyx,maxx,maxy' in CRS84. |
|
startindex |
The page/offset on which to apply on the result set. |
|
limit |
The limit on which to apply on the result set. |
|
filter |
The CQL TEXT filter to apply when querying records. |
JSON Body Parameters⚓︎
| Name | Description | Required |
|---|---|---|
|
JSON payload conforming to an OGC CQL expression |
X |
Metadata collection item⚓︎
GET /catalogue/collections/metadata:main/items/{recordId}
Description⚓︎
Returns a single metadata item.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
application/xml
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The single record result |
application/json |
200 |
The single record result |
application/xml |
200 |
The single record result |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
404 |
Record not found |
application/json |
404 |
Record not found |
text/html |
OGC CSW 3.0 / OpenSearch⚓︎
GET Capabilities / Description Document⚓︎
GET /catalogue/csw
Description⚓︎
Returns the Capabilities XML or OpenSearch description document.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
service |
The OWS service to use. Fixed to 'CSW' in this request. |
X |
version |
The OWS service version to use. One of '3.0.0' or '2.0.2'. |
X |
request |
The OWS request type to use. Fixed to 'GetCapabilities' in this request. |
X |
mode |
The mode flag to use. Fixed to 'opensearch' in this request. |
Content Type⚓︎
- application/xml
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
Capabilities XML |
application/xml |
200 |
The OpenSearch Description Document (if 'mode=opensearch' is specified) |
application/xml |
400 |
Bad request |
application/xml |
GET Domain Values⚓︎
GET /catalogue/csw
Description⚓︎
Returns unique values of properties and API parameters.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
service |
The OWS service to use. Fixed to 'CSW' in this request. |
X |
version |
The OWS service version to use. One of '3.0.0' or '2.0.2'. |
X |
request |
The OWS request type to use. Fixed to 'GetDomain' in this request. |
X |
valuereference |
The property name to query |
|
parametername |
The API parameter to query |
Content Type⚓︎
- application/xml
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
GetDomain response XML |
application/xml |
400 |
Bad request |
application/xml |
GET Records⚓︎
GET /catalogue/csw
Description⚓︎
Returns metadata records based on search request parameters.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
service |
The OWS service to use. Fixed to 'CSW' in this request. |
X |
version |
The OWS service version to use. One of '2.0.2' or '3.0.0'. |
X |
request |
The OWS request type to use. Fixed to 'GetRecords' in this request. |
X |
mode |
The mode to to use. Fixed to 'opensearch' in this request. |
|
typenames |
Metadata record type to query. Fixed to 'csw:Record' in this request. |
X |
elementsetname |
Metadata subset. One of 'brief', 'summary' or 'full' (default). |
X |
outputformat |
The metadata encoding to use. One of 'application/xml' or 'application/json' |
|
outputschema |
The metadata record schema to use. One of 'http://www.opengis.net/cat/csw/3.0' or 'http://www.isotc211.org/2005/gmd' |
|
recordids |
Comma-separated list of 1..n record ids to return |
|
q |
Free-text search terms to query. |
|
bbox |
The record bounding bounding box to filter on. Expressed as 'minx,minyx,maxx,maxy' in CRS84. |
|
time |
The temporal period to filter on. Expressed as 'minx,minyx,maxx,maxy' in CRS84. |
|
start |
The starting temporal period to filter on. Expressed as ISO8601. |
|
start |
The ending temporal period to filter on. Expressed as ISO8601. |
|
startposition |
The page/offset on which to apply on the result set. |
|
maxrecords |
The limit on which to apply on the result set. |
|
eo:cloudCover |
Percentage of cloud cover to filter on (number). |
|
eo:instrument |
Instrument to filter on. |
|
eo:platform |
Platform to filter on. |
|
eo:orbitDirection |
Orbit direction to filter on. One of 'DESCENDING' or 'ASCENDING' |
|
eo:orbitNumber |
Orbit number to filter on. |
|
eo:processingLevel |
The processing level applied to the entry |
|
eo:productType |
Product type to filter on. |
|
eo:productType |
Product type to filter on. |
|
eo:sensorType |
Sensor type to filter on. |
|
eo:snowCover |
Percentage of snow cover to filter on (number). |
|
eo:spectralRange |
Sensor spectral range to filter on. |
Content Type⚓︎
-
application/xml
-
application/atom+xml
-
application/json
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The result set corresponding to a given search |
application/xml |
200 |
The result set corresponding to a given search (if 'mode=opensearch' is specified) |
application/atom+xml |
200 |
The result set corresponding to a given search |
application/json |
400 |
Bad request |
application/xml |
GET Record by Identifier⚓︎
GET /catalogue/csw
Description⚓︎
Returns a single metadata record by identifier.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
service |
The OWS service to use. Fixed to 'CSW' in this request. |
X |
version |
The OWS service version to use. One of '3.0.0' or '2.0.2'. |
X |
request |
The OWS request type to use. Fixed to 'GetRecordById' in this request. |
X |
id |
The mode flag to use. Fixed to 'opensearch' in this request. |
X |
elementsetname |
Metadata subset. One of 'brief', 'summary' or 'full' (default). |
|
outputformat |
The metadata encoding to use. One of 'application/xml' or 'application/json' |
|
outputschema |
The metadata record schema to use. One of 'http://www.opengis.net/cat/csw/3.0' or 'http://www.isotc211.org/2005/gmd' |
Content Type⚓︎
-
application/xml
-
application/json
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
Metadata record document |
application/xml |
200 |
Metadata record document |
application/json |
400 |
Bad request |
application/xml |
GET Record by Identifier in Native format⚓︎
GET /catalogue/csw
Description⚓︎
Returns a single metadata record by identifier in its native metadata format.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
service |
The OWS service to use. Fixed to 'CSW' in this request. |
X |
version |
The OWS service version to use. One of '3.0.0' or '2.0.2'. |
X |
request |
The OWS request type to use. Fixed to 'GetRepositoryItem' in this request. |
X |
id |
The mode flag to use. Fixed to 'opensearch' in this request. |
X |
Content Type⚓︎
-
application/xml
-
application/json
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
Metadata record document |
application/xml |
200 |
Metadata record document |
application/json |
400 |
Bad request |
application/xml |
404 |
Record not found |
application/xml |
SpatioTemporal Asset Catalog⚓︎
Landing page⚓︎
GET /catalogue
Description⚓︎
Returns an overview of the service, endpoints, and contact.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The landing page |
application/json |
200 |
The landing page |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
Metadata collection search⚓︎
GET /catalogue/search POST /catalogue/search
Description⚓︎
Returns metadata items as a result of query.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
|
q |
Free-text search terms to query. |
|
bbox |
The record bounding bounding box to filter on. Expressed as 'minx,minyx,maxx,maxy' in CRS84. |
|
datetime |
The temporal period to filter on. Expressed as 'minx,minyx,maxx,maxy' in CRS84. |
|
startindex |
The page/offset on which to apply on the result set. |
|
limit |
The limit on which to apply on the result set. |
|
filter |
The CQL TEXT filter to apply when querying records. |
JSON Body Parameters⚓︎
| Name | Description | Required |
|---|---|---|
bbox |
The record bounding bounding box to filter on. Expressed as 'minx,minyx,maxx,maxy' in CRS84. |
|
datetime |
The temporal period to filter on. Expressed as 'minx,minyx,maxx,maxy' in CRS84. |
|
limit |
The limit on which to apply on the result set. |
Metadata collection item⚓︎
GET /catalogue/collections/metadata:main/items/{recordId}
Description⚓︎
Returns a single metadata item.
Parameters⚓︎
Query Parameters⚓︎
| Name | Description | Required |
|---|---|---|
f |
The output format of the response. One
of |
Content Type⚓︎
-
application/json
-
application/xml
-
text/html
Responses⚓︎
| Code | Message | Datatype |
|---|---|---|
200 |
The single record result |
application/json |
200 |
The single record result |
application/xml |
200 |
The single record result |
text/html |
400 |
Bad request |
application/json |
400 |
Bad request |
text/html |
404 |
Record not found |
application/json |
404 |
Record not found |
text/html |