GetQueryables: Get CQL2 parameters for a collection

In CDSE: 'Copernicus Data Space Ecosystem' API Wrapper

Get CQL2 parameters for a collection

Description

Returns a list of variable terms that can be used in CQL2 expressions to filter the collection catalog search.

Usage

GetQueryables(
  collection,
  as_data_frame = TRUE,
  client,
  token,
  url = getOption("CDSE.catalog_url")
)

Arguments

collection	character indicating the collection for which the parameters are queried. Must be one of the collections returned by GetCollections.
as_data_frame	logical indicating if the result should be returned as data frame. Default: TRUE
client	OAuth client object to use for authentication.
token	OAuth token character string to use for authentication. Exactly one of either client or token must be specified. It is recommended to use client.
url	character indicating the STAC catalog search endpoint. Default: Copernicus Data Space Ecosystem STAC endpoint

Details

If no parameters found, a NULL value or 0-row data.frame is returned.

Value

A list or a data.frame.

Source

https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/ApiReference.html#tag/catalog_collections/operation/getCatalogCollectionQueryables

See Also

GetCollections, SearchCatalog

Examples

## Not run: 
GetQueryables("sentinel-2-l2a", client = OAuthClient)

## End(Not run)

CDSE documentation built on Sept. 11, 2024, 8:43 p.m.