Templates API Overview

The Templates API is a RESTful API that allows for accessing data of Product Data Templates (PDTs) and Properties. The aim of the API is to export data which is approved by experts and is structured according to standards.

You can use the Templates API to:

  • Retrieve structured data
  • Expose PDTs based on which products and requirements can be created
  • Check for content updates

Key terminology and definitions

Template (also called Product Data Template - PDT) - Defines attributes for information exchange (example usages: products, requirements). List of properties for specific construction object grouped by property set uses. Prepares the needed attributes for creation of product or requirement.

Construction object - Item from construction industry. By connecting each template and product to the correct construction object ensures they can be grouped together. Example: flushing device.

Property - Piece of information to exchange. All product characteristics are defined as properties.

Property set use - Can be used for filtering of properties in PDTs. When adding properties to PDT each property can be linked to 0..* property set uses in order to be more easily discoverable in this PDT.

Document - Represent a document that is the source of information. For example: ISO 1825 - rubber hoses and hose assemblies for aircraft ground fueling and defueling – specification.

Unit - Unit of measurement for numeric values. For example meter, km/h, etc...

Value (also called Predefined value) - Predefined values can be suggested for each property. For example: Electricity consumption can be A+, A++, A+++, etc…

Versioning and GUIDs - All identifiers are formatted according to IFC guid specification. The entities that contain both “guid” and “versionGuid” have tracking for each version. When a new change is approved for one entity, the “versionGuid” is changed but the “guid” remains the same. Templates API also allows to check whether a new version has been approved for all entities.

Translation - The names of the entities in Templates API can be translated in different languages. The endpoints that accept optional parameter “culture” return both “name” and “defaultName”. The “defaultName” is the translation in International English (en) and it is always non-empty. The name parameter is the name in the language that has been passed in the “culture” parameter. It can be null if there is no translation in this language.