Home » Define API release notes

Define API release notes

We offer an API service that enables integration of Define with any external system or digital solution. Our Templates API (REST) allows access to the data templates and the properties developed in Define, thus enabling the export of high-quality, trusted data approved by experts and structured according to standards.

Current API version: v.2

Latest updates and release notes:

04.08.2022

A new Templates API version v2.21.0 was released.

Templates API now exposes information related to Purposes and Milestones – feature in Define that was released in July 2022. In short now developers can:

  1. Get list of all Purposes or Milestones
  2. Get details for a given Purpose or Milestone
  3. Get list of a all Purposes or Milestones related the properties inside of a Data Template
  4. Get list of properties in a Data Template, related to a given Purpose or Milestone
  5. Get list of Data templates related to a given Purpose or Milestone (Data Templates that have properties that are related to the given Purpose or Milestone)

Technical details:

Whole group of endpoints for requiring information about Purposes

  1. New endpoint – Get Purpose list | link
    • Use this endpoint to get a list with all approved Purposes in the context or return filtered list by provided purpose name, i.e. ‘LCA’ will return all purposes containing ‘lca’ in their name
  2. New endpoint –  Get Purpose details | link
    • Use this endpoint to receive the details for a specific Purpose
  3. New endpoint –  Get template’s purposes by Template version guid (Get purposes of template.) | link
    • Use this endpoint to receive a list of all purposes that have relation to the given Data Templates
  4. New endpoint –  Get Data Template’s properties by given Purpose (Get properties of purpose) | link
    • Use this endpoint to receive a list of properties belonging to a given Data Template and a given Purpose
  5. New endpoint –  Get Data Template’s purposes for a property (Get purposes of property) | link
    • Use this endpoint to receive a list with purposes related to a given property within a given Data Template
  6. New endpoint –  Get list of Data Templates by given Purpose | link
    • Use this endpoint to receive a list with all approved Data Templates that have at least one property specified with the given purpose

Whole group of endpoints for requiring information about Milestones (analogical to the Purposes)

  1. New endpoint – Get Milestones list | link
    • Use this endpoint to get a list with all approved Milestones in the context or return filtered list by provided milestone name, i.e. ‘RIBA’ will return all milestones containing ‘riba’ in their name
  2. New endpoint –  Get Milestone details | link
    • Use this endpoint to receive the details for a specific Milestone
  3. New endpoint –  Get template’s milestones by Template version guid (Get milestones of template.) | link
    • Use this endpoint to receive a list of all milestones that have relation to the given Data Templates
  4. New endpoint –  Get Data Template’s properties by given Milestone  (Get properties of milestone) | link
    • Use this endpoint to receive a list of properties belonging to a given Data Template and a given Milestone
  5. New endpoint –  Get Data Template’s milestones for a property (Get milestones of property) | link
    • Use this endpoint to receive a list with milestones related to a given property within a given Data Template
  6. New endpoint –  Get list of Data Templates by given Milestone (Get templates of milestone) | link
    • Use this endpoint to receive a list with all approved Data Templates that have at least one property specified with the given milestone

02.06.2022

A new Templates API version v2.21.0 was released.

Now the following capabilities for getting data from Define via the API are available:

  • Getting data related to Reference documents (Standards) – list with documents in the context, details of a document, related properties to a document, related data templates to a document
  • Getting data related to Construction objects – list of objects in the context, details of a construction object, related data templates to a construction object

Technical details:

The whole group 4. Search Data Templates via Reference document

  1. New endpoint – Get all documents by name | link
    • Use this endpoint to get a list with all reference documents (standards) in the context, OR to get a filtered list by provided document name, i.e. ‘window’ will return all documents containing ‘window’ in their name
  2. New endpoint –  Get reference document’s details | link
    • Use this endpoint to receive the details for a reference document
  3. New endpoint – Get templates by reference document version guid | link
    • Use this endpoint to receive a list of data templates that are connected to a given reference document (standard)
  4. New endpoint – Get properties by reference document version guid | link
    • Use this endpoint to receive a list with all properties that are linked to a reference document (standard)

The whole group 6. Search in Data Template by CO

  1. New endpoint – Get construction objects by name | link
    • Use this endpoint to get a list with all construction objects or to get a filtered list by provided name, i.e. ‘Window’ will return all objects containing ‘window’ in their name
  2. New endpoint – Get construction object details | link
    • Use this endpoint to receive the details for a construction object
  3. New endpoint – Get templates by construction object version guid | link
    • Use this endpoint to receive a list of data templates that are connected to a given construction object
  4. New endpoint – Get construction object by template version GUID | link
    • Use this endpoint to receive the construction object for a Data Template

12.05.2022

The Templates API now supports the mapping functionality released last week (IFC, Revit properties, etc). Two new endpoints were developed to fetch all mapped properties in a specific Data Template.

Technical details:

  1. New endpoint – Get mapped properties by template version guid | link
    • Use this endpoint to get a list with properties in the DT that have mappings
  2. New endpoint – Get property mappings by template version and property concept guid | link
    • Use this endpoint after the previous one to return the mappings per each property

13.04.2022

This release enhances the workflows from 1 April 2022. Developer users can now get details on classifications by their version GUID. Also Czech language is supported now in the API. The content translated in this language can be accessed via culture code “cs-CZ” in the API endpoints.

Technical details:

  1. New endpoint – Get classification details | link
  2. Added Czech language to the API – no change to the endpoints or their request-responses model, this is implemented solely in the backend and should not affect the clients who have integrated with Templates API.

01.04.2022

This release enhances the workflows from 8 March 2022. The API can now return the list of all classifications in a context and provide option to search Data Templates by classification codes. Another enhancement is to get all the classifications for a specific Data Template.

Technical details:

  1. New endpoint – Get classifications list | link
    • Returns list with all classifications in the context
  2. New endpoint – Get classifications that have codes mapped to a template | link
    • Returns the classifications related to a Template
  3. Extended endpoint – Get Templates List – filtered by matching classification code | link
    • Added 3 optional parameters to return templates which are classified by the provided classification code.- ClassificationVersionGuid – if provided, ClassificationCodeVersionGuid becomes required parameter
      ClassificationCodeVersionGuid – if provided, ClassificationVersionGuid becomes required parameter
      include-nested – optional, if missed, the default values is false(default) – returns templates that match only the provided code, true – returns templates that match this code and all child codes
    • Note: The two parameters ClassificationVersionGuid  and ClassificationCodeVersionGuid go together – one cannot be provided without the other

24.03.2022

Developers can get information about all versions for a concept. They can also start extracting information from a list of all properties and work with this list or a sole property.

Technical details:

  1. New endpoint – Get properties by name | link
    • New endpoint in Templates API that returns properties filtered by property full name, based on the passed culture (if no culture info is provided, take the default one)
  2. New endpoint – Get templates by property version guid  | link
    • New endpoint to fetch templates data for a property by property version GUID
  3. New endpoint – Get referenced document by property version guid | link
    • New endpoint to return document, referenced for a property. A property can be without document or with only one
  4. New endpoint – Get concept versions by concept version guid  | link
    • New endpoint to get all concept versions by concept version guid which is approved (and shared)

23.02.2022

We have enriched the information that can be read for property’s unit and measure as well as more details on the properties within a data template.

Technical details:

  1. New endpoint – Get unit details by version guid | link
  2. Modified and Extended endpoint – Get properties of template | link
    • The logic for taking the data is the same as with the existing endpoint.
      We have only added:
      – all the translations for property in default English and in the given language code
      – flag whether the property has predefined values
      – in the property set uses (property tags) are added version guid and default name in default English
  3. Extended endpoint – Get measure details | link
    • New endpoint to return document, referenced for a property. A property can be without document or with only one

24.01.2022

Now the API can find property dependencies in a Data Template, very useful for cases with EPD properties (Environmental Product Declarations). In addition, users can get information on what the property’s measure and unit are.

Technical details:

  1. Implement changes in endpoint about property dependencies | link
  2. Get property measures | link
  3. Get units of a measure | link

16.12.2021

Get detailed information on a property by its GUID.

Technical details:

  1. Get property details by version GUID | link

24.03.2021

Developers can get information about all versions of a concept. They can also start extracting information from a list of all properties and work with this list or a single property.

Technical details:

  1. New endpoint – Get properties by name | link
    • New endpoint in Templates API that returns properties filtered by property full name, based on the passed culture (if no culture info is provided, take the default one)
  2. New endpoint – Get templates by property version guid | link
    • New endpoint to fetch templates data for a property by property version GUID
  3. New endpoint – Get referenced document by property version guid | link
    • New endpoint to return document, referenced for a property. A property can be without document or with only one
  4. New endpoint – Get concept versions by concept version guid | link
    • New endpoint to get all concept versions by concept version guid which is approved (and shared)

15.03.2021

Now users can retrieve information about Tags in Define and search properties and templates by tag.

Technical details:

  1. New endpoint – Get property tags by name | link
    • Gets the list of all tags
    • Returns filtered list by tag name
  2. New endpoint – Get property tag by property tag version guid | link
    • Gets details of a tag
  3. New endpoint – Get properties by property tag version guid and optional template version guid | link
  4. New endpoint – Get templates by property tag version guid | link

08.03.2021

Now users can search via the API information about Classifications and Classifications Codes in Define. Additional options to search data templates by classification codes, get lists and details on classifications will be made available in upcoming releases.

Technical details:

  1. New endpoint – Get classification codes that are mapped to a template | link
    • Expose information about Template’s Classifications
    • Known issue: the typo in the endpoint name.
  2. New endpoint – Get classification code details by classification group version guid and classification code version guid | link
    • Get information about a classification code and its direct children codes
  3. New endpoint – Get classification codes by search terms (name, classNumber) | link
    • Get/Search classification codes in a classification by name and/or class number