This resource provides the schema for a specified feature collection. The schema defines the structure of the collection and includes details such as field names, data types, formats, and descriptions.
The collection id is a unique identifier used to reference a specific dataset. When you provide a collection id, the response includes:
- Field Names: Names of each attribute in the collection.
- Data Types & Formats: The expected data type (such as string, integer, or double) and the format for each field.
- Descriptions: Explanatory details for each attribute to clarify its purpose.
- Geospatial Data Types: Specific spatial types for any geospatial attributes, along with the default coordinate reference system.
This information is essential for validating client queries and constructing dynamic interfaces.
Request format
The request parameters are always sent as an HTTP query string.
https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/{collectionId}/schemaRequest parameters
| Name | Type | Required | Description |
|---|---|---|---|
| collectionId * (path) |
string | Required |
Unique identifier of the collection. Example: |
Example
Request:
https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/pas_usa/schemaResponse:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/pas_usa/schema",
"type": "object",
"title": "pas_usa",
"description": "Property Attributes Assessment",
"properties": {
"parent": {
"title": "parent",
"description": "For secondary (child) address records (e.g. units, apartments, or suites), the Precisely ID of the parent address. Only present when applicable.",
"format": "string"
},
"new_const": {
"title": "new_const",
"description": "Property flagged as new construction.",
"format": "string"
},
... and so on ...
"appraised_val_imp": {
"title": "appraised_val_imp",
"description": "The appraised improvement values as provided by the county or local tax/assessment authority",
"format": "long"
}
}
}