Skip to content

Workspace Registration Concepts

Angelos Tzotsos edited this page Jul 22, 2024 · 2 revisions

Registration Scenarios

The EOEPCA building blocks support several types of data and services to be discovered visualized and downloaded through the workspace components:

  • Datasets
  • Collections
  • Application Packages
  • Processing Services
  • Catalogue Services
  • other Services

The Workspace API has defined several registration endpoints for users to be able to register all the above categories in their own workspace. More specifically the Workspace API offers the following endpoints:

/register/

Register endpoint is used to register data by reference to a url. The endpoint accepts the following payload:

{
  "type": "string",
  "url": "string",
  "parent_identifier": "string"
}

type can be one of

  1. stac-item pointing to a static STAC Catalogue to be harvested and the included STAC Items to be registered both to Resource Catalogue and Data Access components.
  2. ades pointing to an ADES instance to register in the Resource Catalogue
  3. application pointing to an application package to register in the Resource Catalogue
  4. oaproc pointing to an OGC API - Processes endpoint to register in the Resource Catalogue
  5. catalogue pointing to an OGC API - Records, OGC CSW, OpenSearch or STAC API endpoint to register in the Resource Catalogue
  6. xml pointing to an ISO 19115 records to register in the Resource Catalogue

The url parameter is the URL of the dataset or service to be registered The parent_identifier is the identifier of the collection that the dataset or service belongs to.

/deregister/

Deregister endpoint is used to remove data from the Resource Catalogue and Data Access. The endpoint accepts the following payload:

{
  "type": "string",
  "identifier": "string",
  "url": "string"
}

The url parameter is the URL of the dataset or service to be unregistered. The identifier parameter is the identifier of the dataset or service to be unregistered

/register-json/

Register-json endpoint is used to register datasets or collections by value. The endpoint accepts a JSON payload representing one of the following:

  1. OGC API - Records record object
  2. OGC API - Records collection object
  3. STAC Item
  4. STAC Collection
  5. STAC Catalog

/register-collection/

Register-collection endpoint is used to register collections by value. The endpoint accepts a JSON payload representing an OGC API - Records Collection or a STAC Collection object

This endpoint is deprecated by the above register-json endpoint.