Retrieve Schema for a Collection
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 (e.g., string, integer, double) and 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
- Base URL: https://api.cloud.precisely.com
- URL: https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/{collectionId}/schema
- Auth: one of:
- HTTP bearer
- API key in header Authorization
Path parameters
Unique identifier of the collection.
Headers
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 collection schema
Changes
No recorded changes to this operation across all 1 revision of this API.