Skip to content

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.

Filtering by dataset_id returns the definitions a dataset inherits too: for a dataset that implements a parent (see Inherited datasets), the parent’s definitions come back alongside the dataset’s own. They keep the parent’s dataset_id, and a parent shared by several requested datasets is returned once. A parent your API key cannot read is not included. The deprecated display_order is computed per owning dataset, so inherited and own definitions interleave in the default order; follow the dataset’s merged layout_definition to order them.

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.

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
{
"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"
}
}
  • id: UUID of the property definition
  • dataset_id: Integer ID of the dataset this property definition belongs to. For an inherited definition, this is the parent dataset’s id.
  • 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 (see below)
Key Types Meaning
options[] OPTION, MULTI_OPTION The choices, each with a label, a value (a UUID) and a color. A ticket stores the option’s value, not its label.
validation all "REQUIRED" for a required field; enforced only when validation_enforcement.STATUS is set.
validation_enforcement.STATUS all The first ticket status from which a REQUIRED field must be filled (see Required fields).
measure FLOAT The kind of measurement, for example TEMPERATURE (stored in °C) or LENGTH (stored in metres).
precision FLOAT The number of decimals shown for the value.
includeTime DATE, DATE_RANGE true when the value holds a time as well as a date.
applicability all A rule that decides when the field applies. Fields with a rule are refused when you write them.

A field whose config has hidden: true, editable: false or a source can’t be written. Clients can ignore other keys.

List property definitions for a dataset:

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

Filter by type:

Terminal window
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:

Terminal window
curl -X GET "https://api.sitemark.com/propertyDefinitions?_pageSize=50" \
-H "Authorization: ApiKey your-api-key-here"
Status Code Description
401 Unauthorized - Invalid or missing API key
400 Bad Request - Invalid query parameters. See Errors.
429 Too Many Requests - A rate limit was exceeded
500 Internal Server Error