TerraNexus OGC API Web Interface

To enable standardised and interoperable integration between TerraNexus and remote systems and resources an OGC API Web Interface has been implemented. This interface implements a number of OGC API’s that facilitate the external query and expose worflow operation of TerraNexus via standardised query and transfer protocols. The benefits of these standardised interfaces is that the external systems do not need to know anything about TerraNexus in order to connect with it and leverage it’s power to integrate spatial data from local to global scales.

Note

The TerraNexus OGC API Client/Server infrastructure is currently undergoing very active development and the contents of this documentation may not always be up to date.

OGC APIs Implemented by TerraNexus

Current Implementation Status

OGC API Common

OGC API - Common is a multi-part standard that documents the set of common practices and shared requirements that have emerged from the development of Resource Oriented Architectures and Web APIs within the OGC. Standards developers will use these building-blocks in the construction of other OGC Standards that relate to Web APIs. The result is a modular suite of coherent API standards which can be adapted by a system designer for the unique requirements of their system. As such, this OGC API Standard serves as the “OWS Common” standard for resource-oriented OGC APIs. Consistent with the architecture of the Web, this specification uses a resource architecture that conforms to principles of Representational State Transfer (REST). This OGC API Standard establishes a common pattern that is based on OpenAPI.

Reference Standards

API Endpoints

OGC API Features

OGC API - Features is a multi-part standard that offers the capability to create, modify, and query spatial data on the Web and specifies requirements and recommendations for APIs that want to follow a standard way of sharing feature data. The specification is a multi-part document. The Core part of the specification describes the mandatory capabilities that every implementing service has to support and is restricted to read-access to spatial data. Additional capabilities that address specific needs will be specified in additional parts. Envisaged future capabilities include, for example, support for creating and modifying data, more complex data models, richer queries, and additional coordinate reference systems.

Reference Standards

API Endpoints

  • /collections
    • TerraNexus OGC API Collections Landing Page

      • Returns a list of available TerraNexus enabled geospatial data collections.

    • ogcapi.views.collections()

    • Work In Progress…

  • /collections/{collectionID}
    • TerraNexus OGC API Specific Collection Landing Page

      • Returns a the details of the specified TerraNexus enabled geospatial data collection.

    • Work In Progress…

  • /collections/{collectionID}/items
    • TerraNexus OGC API Collection Items Landing Page

      • Returns a list of Items/Features of the specified TerraNexus enabled data collection.

    • Work In Progress…

  • /collections/{collectionID}/items/{itemID}
    • TerraNexus OGC API Collection Item Details Page

      • Returns the details of the specified Item/Feature from the specified TerraNexus data collection.

    • Work In Progress…

  • /collections/{collectionID}/queryables
    • TerraNexus OGC API Collection Queryables Details Page

      • Returns the queryable parameters for the specified TerraNexus enabled data collection.

    • To Be Done…

OGC API Processes

The OGC API - Processes standard supports the wrapping of computational tasks into executable processes that can be offered by a server through a Web API and be invoked by a client application. The standard specifies a processing interface to communicate over a RESTful protocol using JavaScript Object Notation (JSON) encodings. Typically, these processes execute well-defined algorithms that ingest vector and/or coverage data to produce new datasets.

Reference Standards

API Endpoints

  • /processes
    • TerraNexus OGC API Processes Landing Page

      • Returns a list of all OGC API Processes implemented by TerraNexus.

    • Implemented

  • /processes/{processID}
    • TerraNexus OGC API Process Details Page

      • Returns the details for the specified OGC API Process.

    • Implemented

  • /processes/{processID}/callback
    • TerraNexus OGC API Process Asynchronous Callback Landing Page

      • Returns a list of all Asynchronous Callback endpoints registered to the specified OGC API Process.

    • Implemented

  • /processes/{processID}/callback/{callbackID}
    • TerraNexus OGC API Process Asynchronous Callback Details Page

      • Returns the details of the specified Asynchronous Callback for the specified OGC API Process.

    • Implemented

  • /jobs/
    • TerraNexus OGC API Process Jobs Landing Page

      • Returns the list of OGC API Processing Jobs currently registered on the TerraNexus OGC API Server.

    • Implemented

  • /jobs/{jobID}
    • TerraNexus OGC API Process Job Details Page

      • Returns the details for the specified OGC API Job.

    • Implemented

OGC API DGGS

The draft OGC API - Discrete Global Grid Systems standard specifies an API for accessing data organised according to a Discrete Global Grid System (DGGS). A DGGS is a spatial reference system that uses a hierarchical tessellation of cells to partition and address the globe. DGGS are characterized by the properties of their cell structure, geo-encoding, quantization strategy and associated mathematical functions.

Reference Standards

API Endpoints

Core - DGGS Definition
  • /dggs
    • TerraNexus OGC API DGGS Landing Page

      • Returns a list of all TerraNexus DGGS instances.

    • Implemented

  • /dggs/{dggsID}
    • TerraNexus OGC API DGGS Details Page

      • Returns the details for the specified TerraNexus DGGS.

    • Implemented - being improved…

  • /dggs/{dggsID}/zones/{zoneID}
    • TerraNexus OGC API DGGS Zone Details Page

      • Returns the details for the specified Zone of the specified TerraNexus DGGS.

    • To Be Done…

  • /collections/{collectionId}/dggs
    • TerraNexus OGC API DGGS Landing Page - implemented at the Collection Level

      • Returns a list of all TerraNexus DGGS instances.

    • Implemented

  • /collections/{collectionId}/dggs/{dggsID}
    • TerraNexus OGC API DGGS Details Page - implemented at the Collection Level

      • Returns the details for the specified TerraNexus DGGS.

    • Implemented - being improved…

  • /collections/{collectionId}/dggs/{dggsID}/zones/{zoneID}
    • TerraNexus OGC API DGGS Zone Details Page - implemented at the Collection Level

      • Returns the details for the specified Zone of the specified TerraNexus DGGS.

    • To Be Done…

DGGS Data Retrieval
  • /dggs/{dggsID}/zones/{zoneID}/data
    • TerraNexus OGC API DGGS Zone Data Holdings Landing Page

      • Returns a data holdings mapped to the specified Zone of the specified TerraNexus DGGS.

    • To Be Done…

  • /collections/{collectionID}/dggs/{dggsID}/zones/{zoneID}/data
    • TerraNexus OGC API Collection Zone Specific DGGS Data Holdings Landing Page

      • Returns a data holdings for a specified data collection mapped to the specified Zone of the specified TerraNexus DGGS.

    • To Be Done…

DGGS Zone Query
  • /dggs/{dggsID}/zones
    • TerraNexus OGC API Zone Query Landing Page

      • Returns a list of all Zones for the specified TerraNexus DGGS that have data mapped to them.

    • To Be Done…

  • /collections/{collectionID}/dggs/{dggsID}/zones
    • TerraNexus OGC API Collection Zone Query Landing Page

      • Returns a list of all Zones for the specified TerraNexus DGGS that have data from the specified data Collection mapped to them.

    • To Be Done…