Developer Documentation

Property Set

Connect Property Set Service

Overview

BIM models used in construction contain model objects, each with geometry and properties that describe them in detail. These properties are grouped into property sets, which contain related properties. BIM models are created using specialized authoring applications, specific to construction disciplines, and saved in file formats that include both geometry and property sets.

The Property Set Service allows additional, editable properties from user-defined property set libraries to be linked to BIM models. Linking property sets to model objects requires that these objects be uniquely identified using GUIDs. The service also enables defining access control policies, such as read/write/no access permissions, for different users at the property set level.

The Property Set Service API is versatile and can be used within the Trimble Connect platform ecosystem (with specific conventions) or as a standalone service in a solution-specific context.

The Property Set Service is a data-level service with REST API capabilities, complemented by SDKs for Javascript and .NET.

Use Cases

The Property Set Service can be used within the Trimble Connect platform ecosystem or as a standalone service in a solution-specific context. When used in the Trimble Connect ecosystem, specific API and access control policy conventions must be followed.

In the Trimble Connect ecosystem, the service is typically used to enrich BIM models with custom properties linked to model objects via unique IDs (GUIDs) for connected construction workflows. Example use cases include:

  • Creating property set libraries for various construction processes, such as cast-in-place concrete pour checklists, tracking precast element installations, fabrication coordination, site logistics, or equipment maintenance history.
  • Defining data schemas for custom properties.
  • Linking property sets to BIM model objects.
  • Viewing and editing property values.
  • Managing access control to set property access levels for different user groups.

In a solution-specific context, the Property Set Service can also be used for purposes such as storing property data schemas and values, like file metadata.

Concepts

A Property Set is a collection of individual properties. Property set libraries contain definitions, each with a data schema that specifies property names and data types. Property set instances are created from these definitions and linked to uniquely identifiable external resources. The property set service uses the data schema to ensure data quality by validating that property values match the schema. Access Control is done by defining policies on a library level.

  • Property Set Definition - Describes the structure of a property set, including its name, description, and data schema
  • Property - An individual property with a name, data type, and value
  • PSet - Short for Property Set
  • Library - A container for a collection of property set definitions
  • PSet Instance - A property set created from a property set definition
  • Version - Property set schemas and instances are versioned, with each edit creating a new version, ensuring a history of changes.
  • Link - Property sets can be linked to external resources. Links are pointers, and their content is not interpreted by the service. It is recommended to use FRN notation for links

Property Set API Concepts

Getting Started

You need to complete the steps in the Getting Started guide to be able to call the API.

The authorization to individual Property Set Service resources is defined by Access Control Policies, see the API specification.

API & SDK

For detailed information, see the API specification.

The SDK is available for the following platforms:

Code Samples

Copyright © 2024, Trimble Inc.