Model

Overview

The Model API is a model data service that is part of the Trimble Connect ecosystem. The service allows you to execute queries to get access to the model metadata, hierarchies, entities, and properties.

Once you’ve uploaded your BIM models into Trimble Connect, they become intelligent queryable data sources that can be consumed using the Model API. You can tap into the up-to-date data in your models using a modern, performant API. The query capability is supported regardless of source model format and is powered by TrimBIM technology in the Trimble Connect cloud.

Use Cases

The Connect Model API allows you to accomplish a variety of tasks, for example:

• Platform-agnostic access to the granular model data
• Automated quantity take-offs from the model
• Business Intelligence (BI) use cases and reporting

Concepts

When looking at the Connect Model API, it is good to have a basic understanding of some of the terminology:

Regions

Trimble Connect offers regional API endpoints that you can use to make your requests. The resources in each region are independent of similar resources in other regions. Each Trimble Connect project is hosted in a specific region, therefore all data in the project must be accessed through that regional API endpoint (see /regions API).

Model

Model (short for Building Information Model) is the container for all of its data. A Trimble Connect model is identified by its file identifier (see the Connect core File API documentation). A model provides access to its basic metadata and some statistics of its contents. Under the hood, each model has a TrimBIM representation file (.trb) in Connect.

Model Entities

A BIM model contains model entities, each representing, for example, a beam or a slab in the model in question. A model entity has an identifier and some basic and product information, all other data is organized under Property Sets (see below).

Hierarchies

Model Entities are organized in hierarchies. A model can have multiple hierarchies of different Hierarchy types. A Model entity can belong to multiple hierarchies. Examples of hierarchy type are spatial, assembly, and system hierarchies.

Property Sets

Property set metadata is defined in a Property Set Definition. It includes the name of the property set and the definition of the names and types of properties included.

The actual property values for Model entities are stored in Property sets according to their associated definitions. A Model entity can have any number of Property Sets.

Getting Started

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

The user must have at least read access to the model file to execute a query.

API

See the API specification.

Additional Links

• Connect Model API announcement (Community)