Spatial Features API

Retrieve Queryable Properties for a Collection

This resource 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. The response includes information such as:

  • Field Names: The names of the attributes in the collection.
  • Descriptions: A description of each attribute to clarify its purpose and usage.
  • Formats: The data types or formats (e.g., string, number, geospatial) of each attribute.
  • Geospatial Data Types: Specific spatial types for attributes that support geospatial queries.

This metadata is essential for clients to build dynamic query interfaces and validate their requests against the collection's schema.

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:
    • HTTP bearer
    • API key in header Authorization

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 of queryable properties

$schemastring
$idstring
typestring
titlestring
descriptionstring
propertiesobject
additionalPropertiesboolean

Changes

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