This resource returns the queryable attributes for a specific collection identified by its unique ID. These attributes are a subset of the collection's full set of attributes which are returned by the schema endpoint (see below).
The queryable attributes provide detailed metadata for those attributes in the collection that can be used in filter queries. These attributes are indexed for performance and typically include the id of the feature, the geometry and in some cases other fields.
- 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 of each attribute, such as string, number, or geospatial.
- 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.
Request format
The request parameters are sent in the URL path.
https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/{collectionId}/queryablesPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
| collectionId * | string | Required |
Unique identifier of the collection. Example: |
Example
Request:
https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/pas_usa/queryablesResponse:
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$id": "https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/pas_usa/queryables",
"type": "object",
"title": "pas_usa",
"description": "Property Attributes Assessment",
"properties": {
"owner_name2": {
"title": "owner_name2",
"description": "Property Owner2 full Name or DBA name",
"format": "string"
},
"owner_name": {
"title": "owner_name",
"description": "Property Owner full Name",
"format": "string"
},
"pbkey": {
"title": "pbkey",
"description": "Unique ID for an addressable location. Not always available.",
"format": "string"
},
"Obj": {
"title": "Obj",
"description": "Geometry",
"format": "geospatial"
},
"paid": {
"title": "paid",
"description": "Unique and persistent ID for a tax record. This ID serves as the unique record ID for the Property Attributes Assessment. Use this field to link to the Precisely Property Historical Sales Product.",
"format": "string"
},
"prop_apn": {
"title": "prop_apn",
"description": "Formatted assessor's parcel number (APN) or parcel identification number - an identifier assigned by the assessing agency to simplify the identification of parcels. APN formatting and composition vary by agency, but the APN is usually composed of map-book, page, and parcel numbers. Some jurisdictions use section-township-range values as part of the APN.",
"format": "string"
}
},
"additionalProperties": false
}