Property definitions

List Property Definitions

Retrieves a paginated list of property definitions. Property definitions describe the schema of properties on layer features within a dataset. Omit dataset_id to list property definitions across all datasets you have access to — useful for resolving the property-definition UUIDs keying a layer feature’s properties, since inherited datasets mean those UUIDs are not always defined on the layer feature’s own dataset_id.

Endpoint: GET /propertyDefinitions

Authentication: Required (API Key)

⚠️ Deprecation notice — display_order

The display_order response field and the display_order sort option (_sortBy=±display_order) are deprecated and will be removed in a future release. display_order is no longer a stored attribute of a property definition; the value returned is derived for backwards compatibility from the property’s position in its dataset’s layout_definition.

To order property definitions for display, read the dataset’s layout_definition (returned by the Datasets API) and follow the order of its items. See List Datasets for the structure.

Query Parameters

Parameter	Type	Required	Description
dataset_id	integer[]	No	Filter by one or more dataset IDs. Omit to list across all datasets you have access to.
type	string[]	No	Filter by property definition types (e.g. STRING, FLOAT, OPTION, RELATIONSHIP).
_page	integer	No	Page number (positive integer, defaults to 1)
_pageSize	integer	No	Number of items per page (positive integer, defaults to 10, max 10,000)
_sortBy	string	No	Sort order. Format: +field or -field. Sortable fields: id, display_order (deprecated, see notice above). Default: +display_order

Response Format

{
    "data": [
        {
            "id": "string (UUID)",
            "dataset_id": "integer",
            "name": "string",
            "description": "string",
            "display_order": "integer (deprecated)",
            "type": "string",
            "config": {}
        }
    ],
    "pagination": {
        "page": "integer",
        "pageSize": "integer",
        "rowCount": "integer",
        "pageCount": "integer"
    }
}

Response Fields

• id: UUID of the property definition
• dataset_id: Integer ID of the dataset this property definition belongs to
• name: Name of the property definition
• description: Description of the property definition (can be null)
• display_order: Deprecated. Integer indicating the display order, derived from the property’s position in the dataset’s layout_definition. Use the dataset’s layout_definition instead (see List Datasets).
• type: Type of the property definition (e.g. STRING, FLOAT, OPTION, RELATIONSHIP)
• config: Configuration object specific to the property definition type

Example Requests

List property definitions for a dataset:

curl -X GET "https://api.sitemark.com/propertyDefinitions?dataset_id=1234&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by type:

curl -X GET "https://api.sitemark.com/propertyDefinitions?dataset_id=1234&type=STRING&type=FLOAT" \
  -H "Authorization: ApiKey your-api-key-here"

List property definitions across all accessible datasets:

curl -X GET "https://api.sitemark.com/propertyDefinitions?_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Error Responses

Status Code	Description
401	Unauthorized - Invalid or missing API key
400	Bad Request - Invalid query parameters
500	Internal Server Error