OGC API Features

Retrieve queryable properties

Returns the queryable properties for a specific collection identified by its unique ID. Queryable properties provide detailed metadata for each attribute available in the collection that can be used to filter queries. Includes field names, descriptions, data types/formats, and geospatial data types. This metadata is essential for clients to build dynamic query interfaces and validate requests.

get/v1/ogcapi/enrich/collections/{collectionId}/queryables

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/{collectionId}/queryables
  • Auth: one of:
    • bearerAuth (a scheme the document does not define)
    • ApiKeyAuth (a scheme the document does not define)

Path parameters

collectionIdstring required

Unique identifier of the collection.

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting.

Example: e02f00d5-e3a9-4fd6-aen1-3e5451abee46

Response

Successful retrieval

$schemastring

URI of the JSON Schema dialect used to describe the queryables

$idstring

URI identifying this queryables document, typically the URL of the collection's queryables endpoint

typestring

JSON Schema type of the queryables object, always 'object'

titlestring

Title of the collection these queryables belong to

descriptionstring

Description of the collection these queryables belong to

propertiesobject

Map of queryable property names to their schema definitions

additionalPropertiesboolean

Indicates whether additional properties beyond those listed are allowed; always false

Changes

No recorded changes to this operation across all 1 revision of this API.