TerraNexus OGC API Web Interface

Note

This page is auto-generated from _static/api_definition.json by generate_ogcapi_docs.py. Do not edit manually.

API Overview

API Version: 0.1.0

Server(s):

• https://terranexus.pangaeainnovations.com/ogcapi — TerraNexus Test OGC API server

This API implements the following OGC API standards:

• OGC API Common — OGC API Common Components of this API

• OGC API DGGS – Core — Listing and execution of OGC API DGGS – Core Conformance Class

• OGC API DGGS – Data Retrieval — Listing and execution of OGC API DGGS – Data Retrieval Conformance Class

• OGC API DGGS – Zone Query — Listing and execution of OGC API DGGS – Zone Query Conformance Class

• OGC API Processes — Listing and execution of OGC API Process Resources

• OGC API Features — Listing and execution of OGC API Features Collection Resources

API Capabilities

Capability	Supported	Description
Async	✅	This API supports asynchronous operations with task tracking
Streaming	✅	Large datasets can be streamed using chunked transfer encoding. Formats: application/json, application/x-ndjson
Websocket	✅	Real-time updates available via WebSocket connections. Endpoints: /ws/ogcapi/, /ws/processes/, /ws/dggs/

Authentication

The API supports the following authentication schemes:

Scheme	Type	Details
bearerAuth	http	Scheme: bearer. Format: JWT
apiKey	apiKey	In: query. Parameter: token

API Endpoints

Method	Path	Summary
🟢 GET	/	TerraNexus OGC API Landing Page
🟢 GET	/api	OGC API Definition/OpenAPI Specification
🟢 GET	/collections	List all available feature collections. OGC API - Features endpoint…
🟢 GET	/collections/{collectionID}	Get metadata for a specific collection. OGC API - Features collecti…
🟢 GET	/collections/{collectionID}/queryables	Get queryable properties for a collection. OGC API - Features endpo…
🟢 GET	/conformance	OGC API Conformance Classes
🟢 GET	/collections/{collectionID}/items	Retrieve a list of Features from a Feature Collection (async stream…
🟢 GET	/collections/{collectionID}/items/{itemID}	Retrieve an individual Feature from a Feature Collection (async str…
🟢 GET	/collections/{collectionID}/dggs	List DGGS available for a specific collection. This endpoint provid…
🟢 GET	/collections/{collectionID}/dggs/{dggrsID}	Details of the Selected DGGS Enabled Collection for the selected DG…
🟢 GET	/collections/{collectionID}/dggs/{dggrsID}/zones/{zoneID}	OGC API - DGGS Collection Zone Information Endpoint Returns detaile…
🟢 GET	/dggs	List of DGGS instances available through the API. OGC API - DGGS Re…
🟢 GET	/dggs/{dggrsID}	Get structural definition and links for a specific DGGS Reference S…
🟢 GET	/dggs/{dggrsID}/definition	Get full DGGS definition document for a specific DGGRS. Returns det…
🟢 GET	/dggs/{dggrsID}/zones/{zoneID}	DGGS Zone Information endpoint Returns detailed information about a…
🟢 GET	/collections/{collectionID}/dggs/{dggrsID}/zones/{zoneID}/data	Retrieve collection DGGS zone data (async streaming)
🟢 GET	/dggs/{dggrsID}/zones/{zoneID}/data	Retrieve DGGS zone data (async streaming)
🟢 GET	/collections/{collectionID}/dggs/{dggrsID}/zones	OGC API - DGGS Collection Zones List endpoint. Returns a list of DG…
🟢 GET	/dggs/{dggrsID}/zones	List DGGS zones (async)
🟢 GET	/jobs	Function Details List of all OGC API Process Jobs currently registe…
🟢 GET	/jobs/{jobID}	Function Details DGGS Specific OGC API Process Job Details Page. GE…
🔴 DELETE	/jobs/{jobID}	Function Details DGGS Specific OGC API Process Job Details Page. GE…
🟢 GET	/jobs/{jobID}/results	Function Details Result Status of the selected OGC API Process Job
🟢 GET	/jobs/{jobID}/results/{resultID}	Function Details Result Status of the selected OGC API Process Job
🟢 GET	/processes	Function Details TerraNexus OGC API Processes Landing Page - GET Re…
🔵 POST	/processes	Function Details TerraNexus OGC API Processes Landing Page - GET Re…
🟢 GET	/processes/{processID}	Function Details TerraNexus OGC API Process Details Page GET reques…
🟠 PUT	/processes/{processID}	Function Details TerraNexus OGC API Process Details Page GET reques…
🔴 DELETE	/processes/{processID}	Function Details TerraNexus OGC API Process Details Page GET reques…
🟢 GET	/processes/{processID}/callback	Function Details Listing of OGC API Process Callbacks registered on…
🟢 GET	/processes/{processID}/callback/{callbackID}	Function Details details of the specified OGC API Process Callback.
🟢 GET	/processes/{processID}/callback/{callbackID}/failed	Function Details “Failed” endpont of the specified OGC API Process …
🟢 GET	/processes/{processID}/callback/{callbackID}/in-progress	Function Details “in-Progress” endpont of the specified OGC API Pro…
🟢 GET	/processes/{processID}/callback/{callbackID}/success	Function Details “Success” endpont of the specified OGC API Process…
🔵 POST	/processes/{processID}/execution	Function Details TerraNexus OGC API Process Execution Page POST req…
🔵 POST	/token	Takes a set of user credentials and returns an access and refresh J…
🔵 POST	/token/refresh	Takes a refresh type JSON web token and returns an access type JSON…
🔵 POST	/token/verify	Takes a token and indicates if it is valid. This view provides no i…

OGC API Common

OGC API Common Components of this API

🟢 GET /

Operation ID: listlanding_pages

TerraNexus OGC API Landing Page

Parameters

Name	In	Type	Required	Description
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	Links to the API capabilities and the Resources shared by this API.
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /api

Operation ID: listapi_definitions

OGC API Definition/OpenAPI Specification

Parameters

Name	In	Type	Required	Description
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	The OpenAPI definition of the API.
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /collections

Operation ID: listcollections

List all available feature collections.

OGC API - Features endpoint for collections discovery.

Query Parameters:

f (str): Response format - ‘json’ or ‘html’ (default: ‘json’)

Parameters

Name	In	Type	Required	Description
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000

Responses

Code	Description
200	The Collections Landing Page listing all collections supported by the server
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /collections/{collectionID}

Operation ID: retrievecollection_landing_page

Get metadata for a specific collection.

OGC API - Features collection landing page.

Path Parameters:

collectionID (str): Collection identifier

Query Parameters:

f (str): Response format - ‘json’ or ‘html’ (default: ‘json’)

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	The Collections Detials Page for a specific collection supported by the server
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /collections/{collectionID}/queryables

Operation ID: listcollection_queryables_lists

Get queryable properties for a collection.

OGC API - Features endpoint for discovering queryable properties.

Path Parameters:

collectionID (str): Collection identifier

Query Parameters:

f (str): Response format - ‘json’ or ‘html’

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000

Responses

Code	Description
200	The HTTP 200 OK success status response code indicates that the request has succeeded. A 200 response is cacheable by…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /conformance

Operation ID: listconformances

OGC API Conformance Classes

Parameters

Name	In	Type	Required	Description
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	The URIs of all conformance classes supported by the server
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

OGC API Features

Listing and execution of OGC API Features Collection Resources

🟢 GET /collections/{collectionID}/items

Retrieve a list of Features from a Feature Collection (async streaming)

Operation ID: retrieveFeatureCollectionAsync

Asynchronous streaming endpoint for retrieving a list of Features associated with a specific Feature Collection

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅	Collection Identifier
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000
offset	query	integer		The optional offset parameter offsets the number of items that are presented in the response document.. Default: 1000
datetime	query	string		Either a date-time or an interval, half-bounded or bounded. Date and time expressions

Responses

Code	Description
200	The HTTP 200 OK success status response code indicates that the request has succeeded. A 200 response is cacheable by…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /collections/{collectionID}/items/{itemID}

Retrieve an individual Feature from a Feature Collection (async streaming)

Operation ID: retrieveFeatureAsync

Asynchronous streaming endpoint for retrieving data associated with a specific Feature

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅	Collection Identifier
itemID	path	string	✅	Feature Identifier
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	The HTTP 200 OK success status response code indicates that the request has succeeded. A 200 response is cacheable by…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

OGC API DGGS – Core

Listing and execution of OGC API DGGS – Core Conformance Class

🟢 GET /collections/{collectionID}/dggs

Operation ID: listcollection_dggs_definition_lists

List DGGS available for a specific collection.

This endpoint provides the DGGS reference systems that have been enabled for a specific collection.

Supports content negotiation via: - URL parameter: ?f=json or ?f=html - Accept header: application/json, text/html

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000

Responses

Code	Description
200	The Collections Detials + DGGS Listing Page for a specific collection supported by the server
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /collections/{collectionID}/dggs/{dggrsID}

Operation ID: retrievecollection_dggs_definition

Details of the Selected DGGS Enabled Collection for the selected DGGS Instance.

This endpoint provides the structural definition and links to OGC API Resources implemented on this server for the selected DGGS Reference System as applied to a specific collection.

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅
dggrsID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	The Collections Detials + DGGS Details Page for a specific collection and specified DGGS supported by the server
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /collections/{collectionID}/dggs/{dggrsID}/zones/{zoneID}

Operation ID: retrievecollection_dggs_zone_info

OGC API - DGGS Collection Zone Information Endpoint

Returns detailed information about a specific zone within a collection’s DGGS.

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅
dggrsID	path	string	✅
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000
offset	query	integer		The optional offset parameter offsets the number of items that are presented in the response document.. Default: 1000
datetime	query	string		Either a date-time or an interval, half-bounded or bounded. Date and time expressions
filter	query	string		The filter parameter specifies an expression in a query language (e.g. CQL2) for which an entire feature will be retu…
filter-lang	query	string		The filter-lang parameter specifies the query language for the filter query parameter.
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	DGGS Zones Landing Page Response.
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /dggs

Operation ID: listdggs_definition_lists

List of DGGS instances available through the API.

OGC API - DGGS Requirement Class: /req/dggrs-list

Supports content negotiation via: - URL parameter: ?f=json or ?f=html - Accept header: application/json, text/html, application/geo+json

Parameters

Name	In	Type	Required	Description
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000

Responses

Code	Description
200	The DGGS API Landing Page listing URIs of all DGGS infrastructures supported by the server
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /dggs/{dggrsID}

Operation ID: retrievedggs_definition

Get structural definition and links for a specific DGGS Reference System.

This endpoint returns the key parameters and structure of the selected DGGS Reference System as specified by OGC Abstract Specification Topic 21 v2.0.

Parameters

Name	In	Type	Required	Description
dggrsID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	The DGGS Reference System Definition.
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /dggs/{dggrsID}/definition

Operation ID: listdggs_definition_docs

Get full DGGS definition document for a specific DGGRS.

Returns detailed structural definition and metadata for the selected DGGS Reference System. This describes the key parameters and structure following OGC Abstract Specification Topic 21 v2.0 - Part 1 (ISO/19170-1:2021).

The response includes: - dggsRsDescription: Informative description and canonical source - dggsRsStructure: Key structural elements including:

• referenceSystemType

• gridConstraint

• zoneGeometry

• surfaceInterpolation

• refinementStrategy

• refinementRatio

• dggsRsZoneClasses (zone hierarchy)

• links: Related OGC API resources

• collections: Collections indexed by this DGGS

Parameters

Name	In	Type	Required	Description
dggrsID	path	string	✅

Responses

Code	Description
200

🟢 GET /dggs/{dggrsID}/zones/{zoneID}

Operation ID: retrievedggs_zone_info

DGGS Zone Information endpoint

Returns detailed information about a specific zone in a DGGS instance.

Parameters

Name	In	Type	Required	Description
dggrsID	path	string	✅
collections	query	array[string]		The collections that should be included in the response. The parameter value is a comma-separated list of collection …
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000
offset	query	integer		The optional offset parameter offsets the number of items that are presented in the response document.. Default: 1000
datetime	query	string		Either a date-time or an interval, half-bounded or bounded. Date and time expressions
filter	query	string		The filter parameter specifies an expression in a query language (e.g. CQL2) for which an entire feature will be retu…
filter-lang	query	string		The filter-lang parameter specifies the query language for the filter query parameter.
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	DGGS Zones Landing Page Response.
204	The HTTP 204 No Data success status response code indicates that a request has succeeded, but that no data was return…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

OGC API DGGS – Data Retrieval

Listing and execution of OGC API DGGS – Data Retrieval Conformance Class

🟢 GET /collections/{collectionID}/dggs/{dggrsID}/zones/{zoneID}/data

Retrieve collection DGGS zone data (async streaming)

Operation ID: retrieveCollectionDGGSZoneDataAsync

Asynchronous streaming endpoint for retrieving collection data within a DGGS zone

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅	Collection Identifier
dggrsID	path	string	✅	DGGS Reference System Identifier
zoneID	path	string	✅	DGGS Zone Identifier
f	query	string (enum: geotiff, geojson, png, json, html)		The format of the zone data response (e.g. GeoJSON, GeoTIFF).. Values: geotiff, geojson, png, json, html
properties	query	string		Select specific data record fields (measured/observed properties) to be returned.
subset	query	array[string]		Retrieve only part of the data by slicing or trimming along one or more axis
datetime	query	string		Either a date-time or an interval, half-bounded or bounded. Date and time expressions
filter	query	string		The filter parameter specifies an expression in a query language (e.g. CQL2) for which an entire feature will be retu…
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000
stream	query	boolean		Enable streaming response
filter-lang	query	string		The filter-lang parameter specifies the query language for the filter query parameter.
sortby	query	array[string]		Specifies a comma-separated list of property names by which the response shall

Responses

Code	Description
200	DGGS zone data returned as a response.
204	The HTTP 204 No Data success status response code indicates that a request has succeeded, but that no data was return…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /dggs/{dggrsID}/zones/{zoneID}/data

Retrieve DGGS zone data (async streaming)

Operation ID: retrieveDGGSZoneDataAsync

Asynchronous streaming endpoint for retrieving data associated with a specific DGGS zone

Parameters

Name	In	Type	Required	Description
dggrsID	path	string	✅	DGGS Reference System Identifier
zoneID	path	string	✅	DGGS Zone Identifier
f	query	string (enum: geotiff, geojson, png, json, html)		The format of the zone data response (e.g. GeoJSON, GeoTIFF).. Values: geotiff, geojson, png, json, html
properties	query	string		Select specific data record fields (measured/observed properties) to be returned.
subset	query	array[string]		Retrieve only part of the data by slicing or trimming along one or more axis
datetime	query	string		Either a date-time or an interval, half-bounded or bounded. Date and time expressions
filter	query	string		The filter parameter specifies an expression in a query language (e.g. CQL2) for which an entire feature will be retu…
filter-lang	query	string		The filter-lang parameter specifies the query language for the filter query parameter.
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000
stream	query	boolean		Enable streaming response for large datasets
collections	query	array[string]		The collections that should be included in the response. The parameter value is a comma-separated list of collection …
sortby	query	array[string]		Specifies a comma-separated list of property names by which the response shall

Responses

Code	Description
200	DGGS Zone data resource response.
204	The HTTP 204 No Data success status response code indicates that a request has succeeded, but that no data was return…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

OGC API DGGS – Zone Query

Listing and execution of OGC API DGGS – Zone Query Conformance Class

🟢 GET /collections/{collectionID}/dggs/{dggrsID}/zones

Operation ID: listcollection_dggs_zones_lists

OGC API - DGGS Collection Zones List endpoint.

Returns a list of DGGS zones that contain data for the specified collection. Supports various query parameters for filtering and pagination.

Parameters

Name	In	Type	Required	Description
collectionID	path	string	✅
dggrsID	path	string	✅
zone-level	query	integer		Filter zones by resolution level
zones	query	array[string]		A list of identifiers for specific zones of a Discrete Global Grid Systems. These identifiers usually include a compo…
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000
offset	query	integer		The optional offset parameter offsets the number of items that are presented in the response document.. Default: 1000
datetime	query	string		Either a date-time or an interval, half-bounded or bounded. Date and time expressions
filter	query	string		The filter parameter specifies an expression in a query language (e.g. CQL2) for which an entire feature will be retu…
filter-lang	query	string		The filter-lang parameter specifies the query language for the filter query parameter.
f	query	string (enum: json, html, geojson, geotiff, png, uint64)		The format of the response. If no value is provided, the accept header is used to determine the format. Accepted valu…. Values: json, html, geojson, geotiff, png, uint64

Responses

Code	Description
200	Collection Specific DGGS Zones Landing Page Response.
204	The HTTP 204 No Data success status response code indicates that a request has succeeded, but that no data was return…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /dggs/{dggrsID}/zones

List DGGS zones (async)

Operation ID: listDGGSZonesAsync

Asynchronous endpoint for retrieving DGGS zone list with streaming support

Parameters

Name	In	Type	Required	Description
dggrsID	path	string	✅	DGGS Reference System Identifier
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000
offset	query	integer		The optional offset parameter offsets the number of items that are presented in the response document.. Default: 1000
datetime	query	string		Either a date-time or an interval, half-bounded or bounded. Date and time expressions
parent-zone	query	string		Filter zones by parent zone ID
zone-level	query	integer		Filter zones by resolution level
collections	query	array[string]		The collections that should be included in the response. The parameter value is a comma-separated list of collection …
zones	query	array[string]		A list of identifiers for specific zones of a Discrete Global Grid Systems. These identifiers usually include a compo…
filter	query	string		The filter parameter specifies an expression in a query language (e.g. CQL2) for which an entire feature will be retu…
filter-lang	query	string		The filter-lang parameter specifies the query language for the filter query parameter.

Responses

Code	Description
200	DGGS Zones Landing Page Response.
204	The HTTP 204 No Data success status response code indicates that a request has succeeded, but that no data was return…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

OGC API Processes

Listing and execution of OGC API Process Resources

🟢 GET /jobs

Operation ID: listprocess_jobs_lists

Note

Function Details

List of all OGC API Process Jobs currently registered to the TerraNexus OGC API Server GET request = Returns the list of all registered jobs POST request = Registers a new Job to this Process

Parameters

Name	In	Type	Required	Description
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
processID	query	array[string]
dggrsID	query	array[string]
collectionID	query	array[string]
type	query	array[string (enum: process)]
datetime	query	string		Either a date-time or an interval, half-bounded or bounded. Date and time expressions
minDuration	query	array[integer]
maxDuration	query	array[integer]
status	query	array[statusCode]
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000

Responses

Code	Description
200	Jobs List Landing Page response
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /jobs/{jobID}

Operation ID: retrieveprocess_job_details

Note

Function Details

DGGS Specific OGC API Process Job Details Page.

GET request = Returns Status of the selected Job POST request = Registers an update to this process DELETE request = Cancel and Dismiss the selected Job from the Server.

Parameters

Name	In	Type	Required	Description
jobID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	The status response for a job supported by the server
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🔴 DELETE /jobs/{jobID}

Operation ID: destroyprocess_job_details

Note

Function Details

DGGS Specific OGC API Process Job Details Page.

GET request = Returns Status of the selected Job POST request = Registers an update to this process DELETE request = Cancel and Dismiss the selected Job from the Server.

Parameters

Name	In	Type	Required	Description
jobID	path	string	✅

Responses

Code	Description
200	The status response for a job supported by the server
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /jobs/{jobID}/results

Operation ID: listprocess_job_results

Note

Function Details

Result Status of the selected OGC API Process Job

Parameters

Name	In	Type	Required	Description
jobID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	The HTTP 200 OK success status response code indicates that the request has succeeded. A 200 response is cacheable by…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /jobs/{jobID}/results/{resultID}

Operation ID: retrieveprocess_job_result_details

Note

Function Details

Result Status of the selected OGC API Process Job

Parameters

Name	In	Type	Required	Description
jobID	path	string	✅
resultID	path	string	✅

Responses

Code	Description
200

🟢 GET /processes

Operation ID: listprocesses_listings

Note

Function Details

TerraNexus OGC API Processes Landing Page

• GET Request

  • List of OGC API Processes available on the TerraNexus OGC API Server.

  • OGC API Processes - Part 1 - Core Pross and Vretanos [2021]

• POST Request

  • Deploy a new OGC API Process Definition to the TerraNexus OGC API Server.

  • OGC API Processes - Part 2 - Deploy, Replace, Undeploy (DRU) Vretanos [2020]

Parameters

Name	In	Type	Required	Description
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
dggrsID	query	array[string]
collectionID	query	array[string]
limit	query	integer		The optional limit parameter limits the number of items that are presented in the response document.. Default: 1000

Responses

Code	Description
200	Processes List Landing Page response.
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🔵 POST /processes

Operation ID: createprocesses_listing

Note

Function Details

TerraNexus OGC API Processes Landing Page

• GET Request

  • List of OGC API Processes available on the TerraNexus OGC API Server.

  • OGC API Processes - Part 1 - Core Pross and Vretanos [2021]

• POST Request

  • Deploy a new OGC API Process Definition to the TerraNexus OGC API Server.

  • OGC API Processes - Part 2 - Deploy, Replace, Undeploy (DRU) Vretanos [2020]

Parameters

Name	In	Type	Required	Description
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Request Body

Content types: application/json

Schema: object | object | object | object | object

Responses

Code	Description
201	Process Deployment response.
202	Process Deployment Deferred response.
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /processes/{processID}

Operation ID: retrieveprocess_description

Note

Function Details

TerraNexus OGC API Process Details Page

• GET request

  • Display the details and definition of the specified OGC API Process registered on the TerraNexus OGC API Server.

  • OGC API Processes - Part 1 Core Pross and Vretanos [2021]

• PUT request

  • Update the Process Definition of the specified OGC API Process registered on the TerraNexus OGC API Server.

  • OGC API Processes - Part 2 Deploy, Replace, Undeploy (DRU) Vretanos [2020]

  • Access to this OGC API Endpoint Method is restricted to Authorized Users.

• DELETE request

  • Delete/Undeploy the specified Process from the TerraNexus OGC API Server.

  • OGC API Processes - Part 2 Deploy, Replace, Undeploy (DRU) Vretanos [2020]

  • Access to this OGC API Endpoint Method is restricted to Authorized Users.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
200	Processes Description response for a Specified Discrete Global Grid System
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟠 PUT /processes/{processID}

Operation ID: updateprocess_description

Note

Function Details

TerraNexus OGC API Process Details Page

• GET request

  • Display the details and definition of the specified OGC API Process registered on the TerraNexus OGC API Server.

  • OGC API Processes - Part 1 Core Pross and Vretanos [2021]

• PUT request

  • Update the Process Definition of the specified OGC API Process registered on the TerraNexus OGC API Server.

  • OGC API Processes - Part 2 Deploy, Replace, Undeploy (DRU) Vretanos [2020]

  • Access to this OGC API Endpoint Method is restricted to Authorized Users.

• DELETE request

  • Delete/Undeploy the specified Process from the TerraNexus OGC API Server.

  • OGC API Processes - Part 2 Deploy, Replace, Undeploy (DRU) Vretanos [2020]

  • Access to this OGC API Endpoint Method is restricted to Authorized Users.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Request Body

Content types: application/json

Schema: object | object | object | object | object

Responses

Code	Description
200	The HTTP 200 OK success status response code indicates that the request has succeeded. A 200 response is cacheable by…
202	Process Replacement response.
204	Process Replacement response.
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🔴 DELETE /processes/{processID}

Operation ID: destroyprocess_description

Note

Function Details

TerraNexus OGC API Process Details Page

• GET request

  • Display the details and definition of the specified OGC API Process registered on the TerraNexus OGC API Server.

  • OGC API Processes - Part 1 Core Pross and Vretanos [2021]

• PUT request

  • Update the Process Definition of the specified OGC API Process registered on the TerraNexus OGC API Server.

  • OGC API Processes - Part 2 Deploy, Replace, Undeploy (DRU) Vretanos [2020]

  • Access to this OGC API Endpoint Method is restricted to Authorized Users.

• DELETE request

  • Delete/Undeploy the specified Process from the TerraNexus OGC API Server.

  • OGC API Processes - Part 2 Deploy, Replace, Undeploy (DRU) Vretanos [2020]

  • Access to this OGC API Endpoint Method is restricted to Authorized Users.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html

Responses

Code	Description
204	Process Undeploy response.
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

🟢 GET /processes/{processID}/callback

Operation ID: listprocess_callback_lists

Note

Function Details

Listing of OGC API Process Callbacks registered on TerraNexus. These callbacks provide an asynchronous way to receive results and status information from long running process jobs.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅

Responses

Code	Description
200

🟢 GET /processes/{processID}/callback/{callbackID}

Operation ID: retrieveprocess_callback_details

Note

Function Details

details of the specified OGC API Process Callback.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅
callbackID	path	string	✅

Responses

Code	Description
200

🟢 GET /processes/{processID}/callback/{callbackID}/failed

Operation ID: listprocess_callback_faileds

Note

Function Details

“Failed” endpont of the specified OGC API Process Callback.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅
callbackID	path	string	✅

Responses

Code	Description
200

🟢 GET /processes/{processID}/callback/{callbackID}/in-progress

Operation ID: listprocess_callback_inprogresses

Note

Function Details “in-Progress” endpont of the specified OGC API Process Callback.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅
callbackID	path	string	✅

Responses

Code	Description
200

🟢 GET /processes/{processID}/callback/{callbackID}/success

Operation ID: listprocess_callback_successes

Note

Function Details

“Success” endpont of the specified OGC API Process Callback.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅
callbackID	path	string	✅

Responses

Code	Description
200

🔵 POST /processes/{processID}/execution

Operation ID: createprocess_execution

Note

Function Details

TerraNexus OGC API Process Execution Page

• POST request

  • POST an OGC API Process Execution package to the specified Process on the TerraNexus OGC API Server.

  • Execution can be performed in both _Synchronous_ and _Asynchronous_ modes as defined in OGC API Processes - Part 1 Core Pross and Vretanos [2021]

  • If the execute document follows the OGC API Processes - Part 1 Core schema the execution is a standard Process execution.

  • If the execute docuemt follows the extended format schema described in OGC API Processes - Part 3 Workflows the execution is a Workflow execution.

• Access to this OGC API Endpoint is restricted to Authorized Users.

Parameters

Name	In	Type	Required	Description
processID	path	string	✅
f	query	string (enum: json, html)		Response Format specifier. Values: json, html
response	query	string (enum: collection, landingPage)		Workflow Response Type specifier. Values: collection, landingPage

Request Body

Content types: application/json, application/x-www-form-urlencoded, multipart/form-data

Responses

Code	Description
201	The HTTP 201 Created success status response code indicates that the request has succeeded and has led to the creatio…
400	A client error occurred.
401	The request requires user authentication. The response includes a WWW-Authenticate header field containing a challeng…
403	The server understood the request, but is refusing to fulfill it. While status code 401 indicates missing or bad auth…
404	The requested resource does not exist on the server. For example, a path parameter had an incorrect value.
405	The request method is not supported. For example, a POST request was submitted, but the resource only supports GET re…
406	Content negotiation failed.
500	A server error occurred.

TerraNexus Authentication

TerraNexus API Authentication Components

🔵 POST /token

Operation ID: createTokenObtainPair

Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.

Request Body

Content types: application/json, application/x-www-form-urlencoded, multipart/form-data

Field	Type	Required	Description
username	string	✅
password	string	✅

Responses

Code	Description
201

🔵 POST /token/refresh

Operation ID: createTokenRefresh

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Request Body

Content types: application/json, application/x-www-form-urlencoded, multipart/form-data

Field	Type	Required	Description
refresh	string	✅
access	string

Responses

Code	Description
201

🔵 POST /token/verify

Operation ID: createTokenVerify

Takes a token and indicates if it is valid. This view provides no information about a token’s fitness for a particular use.

Request Body

Content types: application/json, application/x-www-form-urlencoded, multipart/form-data

Field	Type	Required	Description
token	string	✅

Responses

Code	Description
201

Data Schemas

This section documents the data schemas used in API requests and responses.

ECEF-x

Earth Centred Earth Fixed (XYZ) X ordinate

Type: number

ECEF-y

Earth Centred Earth Fixed (XYZ) Y ordinate

Type: number

ECEF-z

Earth Centred Earth Fixed (XYZ) Z ordinate

Type: number

FeatureCollection

Type: object

Property	Type	Required	Description
bbox	object
features	array[object]	✅
type	string (enum: FeatureCollection)	✅

TokenObtainPair

Type: object

Property	Type	Required	Description
password	string	✅
username	string	✅

TokenRefresh

Type: object

Property	Type	Required	Description
access	string
refresh	string	✅

TokenVerify

Type: object

Property	Type	Required	Description
token	string	✅

WWW-AuthenticateChallenge

WWW-Authenticate Header Challenge Schema

Type: object

Property	Type	Required	Description
algorithm	string		Algorithm used to produce the digest. Valid non-session values are: “MD5” (default if not specifi…
auth-scheme	string	✅	The authentication scheme used by the Server.
charset	string		Tells the client the server’s preferred encoding scheme when submitting a username and password. …
domain	string		A quoted, space-separated list of URI prefixes that define all the locations where the authentica…
error	string		The error code to return in the header
error_description	string		Description of the error code: invalid_request = The request is missing a required parameter; inv…
nonce	string		A server-specified quoted string that the server can use to control the lifetime in which particu…
opaque	string		A server-specified quoted string that should be returned unchanged in the Authorization. This is …
qop	string		Quoted string indicating the quality of protection supported by the server. This must be supplied…
realm	string		The “realm” authentication parameter is reserved for use by authentication schemes that wish to i…
scope	string		The “scope” attribute is a space-delimited list of case-sensitive scope values indicating the req…
stale	string		A case-insensitive flag indicating that the previous request from the client was rejected because…
userhash	string		A server may specify “true” to indicate that it supports username hashing (default is “false”)

ZoneId

Description of the zone identifier schema

Type: object

Property	Type	Required	Description
description	string	✅	description of the index schema
idType	string	✅	type of index - e.g. string or integer

additionalParameter

Type: object

Property	Type	Required	Description
name	string	✅
value	array[string | number | integer | array | object | object]	✅

bbox

Type: object

Property	Type	Required	Description
bbox	array[number]	✅
crs	string (enum: http://www.opengis.net/def/crs/OGC/1.3/CRS84, http://www.opengis.net/def/crs/OGC/0/CRS84h)

binaryInputValue

Type: string

chainedInput

Type: object

Property	Type	Required	Description
input	string	✅

collectionDesc

This schema defines the resource returned from /collections/{collectionId}.

Type: object

Property	Type	Required	Description
attribution	string		The attribution should be short and intended for presentation to a user, for example, in a corn…
crs	array[string]		the list of coordinate reference systems supported by the API; the first item is the default coor…
description	string		a description of the members of the collection
extent	object		The extent of the resources in the collection. Only spatial and temporal extents are specified. A…
id	string	✅	identifier of the collection used, for example, in URIs
itemType	string		An indicator about the type of the items in the collection.
links	array[object]	✅
title	string		human readable title of the collection

collectionDescDGGSDesc

This schema defines the resource returned from /collections/{collectionId}.

Type: object

Property	Type	Required	Description
attribution	string		The attribution should be short and intended for presentation to a user, for example, in a corn…
crs	array[string]		the list of coordinate reference systems supported by the API; the first item is the default coor…
description	string		a description of the members of the collection
dggs	dggsDescription	✅	the Description of the specified Discrete Global Grid System supported by the API for this Collec…
extent	object		The extent of the resources in the collection. Only spatial and temporal extents are specified. A…
id	string	✅	identifier of the collection used, for example, in URIs
itemType	string		An indicator about the type of the items in the collection.
links	array[object]	✅
title	string		human readable title of the collection

collectionDescDGGSList

This schema defines the resource returned from /collections/{collectionId}.

Type: object

Property	Type	Required	Description
attribution	string		The attribution should be short and intended for presentation to a user, for example, in a corn…
crs	array[string]		the list of coordinate reference systems supported by the API; the first item is the default coor…
description	string		a description of the members of the collection
dggs	array[object]	✅	the list of Discrete Global Grid Systems supported by the API for this Collection
extent	object		The extent of the resources in the collection. Only spatial and temporal extents are specified. A…
id	string	✅	identifier of the collection used, for example, in URIs
itemType	string		An indicator about the type of the items in the collection.
links	array[object]	✅
title	string		human readable title of the collection

collectionInput

Type: object

Property	Type	Required	Description
input	string	✅

collections

This schema defines the resource returned from /collections path.

Type: object

Property	Type	Required	Description
collections	array[object]	✅
links	array[object]	✅
numberMatched	integer
numberReturned	integer
timeStamp	string (date-time)

confClasses

Type: object

Property	Type	Required	Description
conformsTo	array[string]	✅

descriptionType

Type: object

Property	Type	Required	Description
additionalParameters	object | object
description	string
keywords	array[string]
metadata	array[object]
title	string

dggsCollectionProcessJobList

Type: object

Property	Type	Required	Description
collection	collectionDesc	✅	The specified Collection.
dggs	dggsDescription	✅	the Description of the specified Discrete Global Grid System supported by the API
jobs	array[object]	✅
links	array[object]	✅
processes	array[object | object]	✅

dggsCollectionProcessList

This schema defines the resource returned from /collections/{collectionID}/dggs/{dggrsID}/processes.

Type: object

Property	Type	Required	Description
collection	collectionDesc	✅	the description of the specified Discrete Global Grid System
dggs	dggsDescription	✅	the description of the specified Discrete Global Grid System
links	array[object]	✅
processes	array[object | object]	✅	the list of Processes supported by the API for this Discrete Global Grid System

dggsCollectionZoneDetails

Type: object

Property	Type	Required	Description
collection	object	✅	This schema defines the resource returned from /collections/{collectionId}.
links	array[object]	✅
title	string		Title Description of the Discrete Global Grid System Collection Specific Zone Details Page
zone	object	✅

dggsCollectionZonesListing

Type: object

Property	Type	Required	Description
collection	object	✅	This schema defines the resource returned from /collections/{collectionId}.
links	array[object]	✅
title	string		Title Description of the Discrete Global Grid System Collection Specific Zones Landing Page
zones	array[object]	✅

dggsDataSummary

Type: object

Property	Type	Required	Description
collections	array[object]	✅
links	array[object]	✅
title	string		Title Description of the Discrete Global Grid System Data Holdings Landing Page

dggsDescription

Type: object

Property	Type	Required	Description
DGGRS	object | string | object	✅
dggrsID	string	✅	The unique identifier for the Discrete Global Grid System implementation.
dggsRsZoneClasses	array[object]
links	array[object]	✅
title	string		Title Description of the Discrete Global Grid System

dggsList

Type: object

Property	Type	Required	Description
dggs	array[object]	✅	the list of Discrete Global Grid Systems supported by the API
links	array[object]	✅
title	string		Title Description of the Discrete Global Grid System Landing Page

dggsListitem

This schema defines the resource returned from /dggs.

Type: object

Property	Type	Required	Description
description	string		optional text description of the Discrete Global Grid System.
dggrsID	string	✅	Unique identifier of the Discrete Global Grid System
links	array[object]	✅

dggsProcessJobList

Type: object

Property	Type	Required	Description
dggs	dggsDescription	✅	the Description of the specified Discrete Global Grid System supported by the API
jobs	array[object]	✅
links	array[object]	✅
processes	array[object | object]	✅

dggsProcessList

This schema defines the resource returned from /dggs/{dggrsID}/processes.

Type: object

Property	Type	Required	Description
dggs	dggsDescription	✅	the description of the specified Discrete Global Grid System
links	array[object]	✅
processes	array[object | object]	✅	the list of Processes supported by the API for this Discrete Global Grid System

dggsStructure

Discrete Global Grid System Reference System Structure Definition.

Type: object

Property	Type	Required	Description
basePolyhedron	object
gridConstraint	string (enum: cellAxisAligned, cellConformal, cellEquiAngular, cellEquiDistant, cellEqualSized)	✅	Constraints used to define different categories of DGGS. Each constraint is a constraint on the s…
referenceSystemType	object	✅
refinementRatio	integer	✅	The ratio of child zones to parent zones
refinementStrategy	string (enum: centredChildCell, nestedChildCell, nodeCentredChildCell, edgeCentredChildCell…	✅	The refinement strategy used by the Discrete Global Grid System
surfaceInterpolation	string (enum: spherical, elliptical)	✅	The Surface Interpolation type used to define zone geometries of the Discrete Global Grid System
zoneGeometry	object	✅	Zone Geometry Specification

dggsZone

Type: object

Property	Type	Required	Description
bbox	object
childZones	array[string]		Child zone identifiers
geometry	geometry
level	integer		Resolution level of the zone
parentZone	string		Parent zone identifier
properties	object		Additional zone properties
zoneId	string	✅	Unique identifier for the DGGS zone

dggsZoneDataSummary

Type: object

Property	Type	Required	Description
collections	array[object]	✅
links	array[object]	✅
title	string		Title Description of the Discrete Global Grid System Data Holdings Landing Page
zone	object	✅

dggsZoneDetails

Type: object

Property	Type	Required	Description
collections	array[object]	✅
links	array[object]	✅
title	string		Title Description of the Discrete Global Grid System Zone Details Page
zone	object	✅

dggsZonesListing

Type: object

Property	Type	Required	Description
collections	array[object]	✅
links	array[object]	✅
title	string		Title Description of the Discrete Global Grid System Zones Landing Page
zones	array[object]	✅

exception

JSON schema for exceptions based on RFC 7807

Type: object

Property	Type	Required	Description
detail	string
instance	string
status	integer
title	string
type	string	✅

extent

The extent of the resources in the collection. Only spatial and temporal extents are specified. Additional API standards may add members to represent other extents, for example, thermal or pressure ranges.

Type: object

Property	Type	Required	Description
spatial	object		The spatial extend of the resources in the collection.
temporal	object		Begin and end times of the temporal extent.

generic-http-response

Type: object

Property	Type	Required	Description
code	string	✅
description	string	✅

height

Height relative to Earth Model/Datum. Negative = below, positive = above.

Type: number

jobControlOptions

Type: string

Allowed values: sync-execute, async-execute, dismiss

jobList

Type: object

Property	Type	Required	Description
jobs	array[object]	✅
links	array[object]	✅

landingPage

Type: object

Property	Type	Required	Description
attribution	string		The attribution should be short and intended for presentation to a user, for example, in a corn…
description	string
links	array[object]	✅
title	string		While a title is not required, implementors are strongly advised to include one.

latitude

Latitude (decimal degrees)

Type: number

link

Type: object

Property	Type	Required	Description
href	string	✅	Supplies the URI to a remote resource (or resource fragment).
hreflang	string		A hint indicating what the language of the result of dereferencing the link should be.
length	integer
rel	string	✅	The type or semantics of the relation.
templated	boolean		This flag set to true if the link is a URL template.
title	string		Used to label the destination of a link such that it can be used as a human-readable identifier.
type	string		A hint indicating what the media type of the result of dereferencing the link should be.

listInput

Type: object

Property	Type	Required	Description
list	array[object]	✅

longitude

Longitude (decimal degrees)

Type: number

metadata

Type: object

Property	Type	Required	Description
href	string
role	string
title	string

outputFormat

Type: object

Property	Type	Required	Description
encoding	string
mediaType	string
schema	string (url) | object

process-execute

Type: object

Property	Type	Required	Description
inputs	object[string → object | object | object | array[object]]
outputs	object[string → object]
subscriber	object		Optional URIs for callbacks for this job.

Support for this parameter is not required and the pa…

process-output

Type: object

Property	Type	Required	Description
format	object

process-subscriber

Optional URIs for callbacks for this job.

Support for this parameter is not required and the parameter may be removed from the API definition, if conformance class ‘callback’ is not listed in the conformance declaration under /conformance.

Type: object

Property	Type	Required	Description
failedUrl	string (uri)
inProgressUrl	string (uri)
successUrl	string (uri)	✅

processApplicationPackage

Type: object

Property	Type	Required	Description
executionUnit	array[object]	✅	Resource containing an executable or runtime information for executing the process.
processDescription	object | object | object

processExecutionUnit

Type: object

Property	Type	Required	Description
additionalProperties	True
config	object		Hardware requirements and configuration properties for executing the process.

processInput

Type: object

Property	Type	Required	Description
inputs	array[object]
process	string	✅

processJobList

Type: object

Property	Type	Required	Description
jobs	array[object]	✅
links	array[object]	✅
process	object | object	✅

processList

This schema defines the resource returned from /processes.

Type: object

Property	Type	Required	Description
links	array[object]	✅
processes	array[object | object]	✅	the list of Processes supported by the API

reference

Type: object

Property	Type	Required	Description
$ref	string (uri-reference)	✅

statusCode

Type: string

Allowed values: accepted, running, successful, failed, dismissed

statusInfo

Type: object

Property	Type	Required	Description
created	string (date-time)
finished	string (date-time)
jobID	string	✅
links	array[object]
message	string
processID	string
progress	integer
started	string (date-time)
status	string (enum: accepted, running, successful, failed, dismissed)	✅
type	string (enum: process)	✅
updated	string (date-time)

transmissionMode

Type: string

Allowed values: value, reference

workflow-execute

Type: object

Property	Type	Required	Description
id	string
inputs	array[object]
process	string
subscriber	object		Optional URIs for callbacks for this job.

Support for this parameter is not required and the pa…

workflow-input

Type: object

Property	Type	Required	Description
anyOf	mixed
id	string	✅
useWith	object

zoneClass

Type: object

Property	Type	Required	Description
numberOfZones	integer	✅	Number of zones at the specified refinement level.
refinementLevel	integer	✅	Refinement Level of the DGGS.
zoneEquivalentRadius	object		Zone Equivalent Radius. The radius from the Zone Centroid that represents a circular area (for Su…
zoneErrorBudget	object	✅	Zone Extent Error Budget Definition
zoneExtent	object	✅	Zone Extent Definition

zoneDesc

Type: object

Property	Type	Required	Description
links	array[object]	✅
refinementLevel	integer		Refinement Level of the DGGS.
zoneBoundaryType	string (enum: geodesic, smallCircle, greatCircle, smallEllipse, greatEllipse, projectedLine)		Boundary Type as defined by EA_BoundaryType in ISO 19170-1
zoneCentroid	object | object | array[number, number] | array[number, number, number] | object | array[number, number, number]		Schema for a Direct Position in 2D or 3D
zoneEquivalentRadius	object		Zone Equivalent Radius. The radius from the Zone Centroid that represents a circular area (for Su…
zoneErrorBudget	object		Zone Extent Error Budget Definition
zoneExtent	object		Zone Extent Definition
zoneID	string	✅	Zonal Identifier
zoneType	string (enum: triangle, square, hexagon, pentagon, diamond)
zoneVertices	array[object | object | array[number, number] | array[number, number, number] | object | array[number, number, number]]		Zone Vertices - defined as an array of direct Positions for each vertex of the DGGS Zone.