Overview

Collaborate API overview

The Collaborate API is a RESTful API that allows for export of project data. Its aim is to enable contractors to extract their data from the Collaborate application and distribute it to different channels. You can use the Collaborate API to:

  • Automate your management reports related to legal compliance of the products in use and monitor your progress against the company goals

  • Automate the preparation of your FM project handover

Key concepts

  • Region ("region-id") – a geographic entity or department within your company for structuring your projects and managing access

  • Project – a construction project

    • Name ("projectName") – name of the project

    • Id ("project-id") – project number, unique identifier for a project (workplace/location) within your company

  • Product – a manufactured object

    • Name ("name") – name of the product

    • Manufacturer ("manufacturerName") – the company that manufactured the product

    • Identifier – a characteristic describing the product’s unique reference numbers in different databases. Identifiers can be:

      • GTIN number ("gtin") – Global Trade Item Number, a traded product’s identifier, developed by GS1

      • SPN number ("spn") – manufacturer’s article or reference number for this product.

    • Construction object ("constructionObjectName") – a characteristic describing the product’s general type (e.g. window)

    • Classification – a tool for identifying and grouping objects based on common characteristics

      • Name ("name") – name of the classification, e.g. Uniclass 2015

      • Classification code ("classificationCodes"), e.g. Pr_25_71_63_26 - expanded polystyrene (eps) boards

    • SDS (Safety Data Sheet) – a document listing information on occupational safety and health for the use of various substances and products; required for all chemical substances and mixtures under REACH

    • DoP (Declaration of Performance) – a document providing information on the product’s performance; required for construction products covered by a European harmonised standard or with a European Technical Assessment

    • Documents – all documents related to the product and their metadata – document name, type of document (e.g. EPD) and link to the PDF file

  • Deliverer ("companyName") – the company that delivered the product to the project, which could be a wholesaler (delivered the product via Connect), a subcontractor, or the main contractor

  • Responsible ("responsibleCompanyName") – from the main contractor’s perspective, the subcontractor within whose supply chain the product is added to the project. If the product is delivered by a wholesaler, the responsibility lies with the company that has invited the wholesaler to the project.