OData API

EOF for Copernicus

ESA EO Framework (EOF) – CSC – Common Entity Definition Document

The purpose of this document is to provide a common definition for basic entities managed by Copernicus Space Component Ground Segment service elements. These definitions are used to derive the RESTful Application Programming Interfaces (API) of the GS elements through which production, archival and distribution of Copernicus Sentinel mission data products may be coordinated.

This specification drives the definition of the OData v4 standard for RESTful APIs for the GS elements, evolving from the v2 standard successfully adopted within the Copernicus Sentinel Data Distribution Service (DHuS) put in place by ESA for the initial missions operations. OData entities and enumerations are detailed, including applicability to GS elements and commonalities. In addition, a generic Reporting interface is described, intended for the collection of reporting parameters which are expected from each GS element.

The document is intended to compliment the lower-level ‘per-GS element’ ICDs, which describe in more detail the specifics of the OData APIs as applicable to each GS element and any intended sequencing expected to achieve the API objectives. This document is intended to capture the common definition for the basic entities, and is presented as a guideline for the evolution of the lower level ICDs. In case the APIs within the lower-level ICDs are considered to be further evolved the definitions in this document should be preferred in order to ensure a harmonized approach in the overall GS management avoid any ad-hoc implementation of the interfacing between GS elements.

ESA EO Framework (EOF) – CSC – CADU Interface Delivery Point Specification

The purpose of this document is to specify https RESTful Application Programming Interfaces (APIs) through which CADU data may be discovered and downloaded by authorised users following the patterns and principles defined in the other CSC GS interface delivery points.

The CADU Interface delivery Points (CADIP) describes a standard pick-up point for all Sentinel CADU data collected or generated by the Acquisition Services Ground Stations to be interfaced by the CSC Production Services. This specification uses the latest OData v4 standard for REST-ful APIs.
The API interface is intended to be compliant with the OData v4 standard, however, it is not necessary to fully implement the OData v4 standard.

Compliance to the ICD can be considered as an API contract with a set of API OData v4 style calls, which have to be supported, that shall follow OData query conventions such as URL syntax, filter syntax, content accessing conventions, etc.

ESA EO Framework (EOF) – CSC – Auxiliary Data Interface Delivery Point Specification

The Auxiliary Data Interface Delivery Point (AUXIP) is the pick-up point for Sentinel Auxiliary products. The AUXIP allows clients to straightforwardly discover and retrieve available products through standard interfaces, in this case an OData RESTful API. Clients of the AUXIP are intended to be downloaders whose principal use case requires systematic (or at least regular) retrieval of published Sentinel Auxiliary data products. Examples of AUXIP clients include Production services (both systematic and on-demand), which use the Auxiliary data for the generation of products, Long Term Archives (LTAs), Sentinel Data Hubs (which in turn make the Auxiliary products available to end users), end-to-end Operations Performance monitoring, Reference System, and possibly clients requiring data for Instrument and Product Performance investigations.

The AUXIP is the point of retrieval for newly published Sentinel Auxiliary data products and, as such, it is managed by the various services delivering Auxiliary data. These include the Auxiliary Data Gathering Service the POD Service and the Cal/Val Service. Auxiliary products are supplied on a rolling archive, retention period for the Auxiliary data is specified in the technical specifications for each service, the main purpose of the rolling archive is to provide a buffer allowing the recovery of data in case of unavailability. The API and standard use scenario allow authorized users to discover, with a simple set of filters, the list of products which need to be retrieved in batches, for example since the last check, and then to perform the downloads.

In common with the other Interface Delivery Points, data published by authorized services are to be also registered with the Traceability Service to ensure a long term record the authenticity of all data within the CSC GS.

ESA EO Framework (EOF) – CSC – Production Interface Delivery Point Specification

The purpose of this document is to specify an https RESTful Application Programming Interface (API) through which Sentinel (or Auxiliary) data products may be discovered and downloaded by authorised users from a Production Interface delivery Point (PRIP). PRIPs are intended as the standard pick-up points for systematically-produced Sentinel data products from within the PDGSs, replacing the diverse interfaces currently in place inside each Sentinel PDGS. The API is (optionally) extended to manage on-demand production, whereby an order triggers a production that is delivered through the Interface delivery Point. In this case the API is referred to within this document as the On-Demand Production Interface delivery Point (ODPRIP).

The specification of this API is intended for:

The discovery and download of systematically produced data products
The discovery of the processing services available for a given type of parent product
The submission of on-demand processing requests for pre-identified parent products
Monitoring of on-demand processing requests

ESA EO Framework (EOF) – CSC – Long Term Archive Interface Control Document

The purpose of this document is to specify the interfaces of the Long Term Archive (LTA) within the Copernicus Space Component (CSC) Ground Segment (GS) as part of the overall CSC ESA Operations Framework.

In particular this document aims to specify an https RESTful Application Programming Interface (API) of the LTA through which Copernicus Sentinel data products may be queried and downloaded by authorised users. This specification uses the latest OData v4 standard for RESTful.

EOF for Destination Earth Platform and Digital Twin Earth

No documents available in this category.

EOF for ESA EO Science missions (Coming Soon)

Need Support?

Can’t find the answer you’re looking for?
Don’t worry we’re here to help!