OPopen-eo
EO Data Discovery

Metadata filters for a specific dataset

Changed on

Lists all supported metadata filters (also called "queryables") for a specific collection.

This endpoint is compatible with the endpoint defined in the STAC API extension filter and OGC API - Features - Part 3: Filtering. For a precise definition please follow those specifications.

This endpoints provides a JSON Schema for each queryable that openEO users can use in multiple scenarios:

  1. For loading data from the collection, e.g. in the process load_collection.
  2. For filtering items using CQL2 on the /collections/{collection_id}/items endpoint (if STAC API - Features is implemented in addition to the openEO API).

Note: Providing the Bearer token is REQUIRED for private collections.

get/collections/{collection_id}/queryables

Request

  • Base URL
    https://openeo.example/api/v1
  • Auth
    • none
    • or HTTP bearer

Path parameters

collection_idstring required

A unique identifier for the collection, which MUST match the specified pattern.

Example:Sentinel-2A

Collection identifier

Response

A JSON Schema defining the queryables.

It is RECOMMENDED to dereference all "$refs".

$schemastring uri

The JSON Schema version. If not given in the context of openEO, defaults to JSON Schema draft-07: http://json-schema.org/draft-07/schema#

The default value for $schema property may have to be added to the JSON Schema object before passing it to a JSON Schema validator.

$idstring uri

ID of your JSON Schema.

patternstring regex

The regular expression a string value must match against.

minimumnumber

The minimum value (inclusive) allowed for a numerical value.

maximumnumber

The maximum value (inclusive) allowed for a numerical value.

minItemsnumber

The minimum number of items required in an array.

maxItemsnumber

The maximum number of items required in an array.

Example response

{
  "type": "string",
  "enum": [
    "a",
    "b"
  ]
}

Changes