Get started with Status Sharing API

Trimble Connect Workflow tools

Trimble Connect Workflow tools enable cloud-based BIM supply chain management. You can control and keep track of assembly and object-level status information for project management, scheduling, and design review purposes.

Download Workflow tools for the Trimble Connect for Windows.

Usage of Trimble Connect Status Sharing API

Status Sharing API allows real-time sharing of the construction statuses of external objects.

External systems can integrate with Trimble Connect using the server-side APIs and Status Sharing API. For example, fabrication ERP systems can publish status data in real time using the Status Sharing API.

If you are a fabricator or equivalent, you probably have an ERP or other system with a status concept. With the Status Sharing API, you can visualize your production status on BIM with a “live feed” and update your system status from the Trimble Connect user interfaces.

RESTful API

The API is a standard RESTful API. It uses GET to retrieve information, PUT to store or update a resource, POST to create a new resource, and DELETE to remove it.

The API Reference can be found here: https://europe.tcstatus.tekla.com/swagger.

Access tokens are region-specific

With the Status Sharing API, all requests including the access_token exchange are done against the region-specific servers in the same regions as core Trimble Connect. So the access_tokens are region-specific.

Accessing the API

You can get the region-specific server URLs by adding the Trimble Connect region name to the beginning of the base URL:

Status values

Status actions are set up per project to match your process.

Possible status values are: 

• None
• Enable
• Commit
• Started
• Paused
• Completed

Allowed status values can be configured per status action.

Code examples

Authenticate with Trimble Identity using Oauth 2.0

See the Getting Started Guide for details. As a result, the Trimble Identity access_token is returned.

Notice the below examples are for the EU region.

Exchange the access_token for a Status Sharing API access token

The status_token is returned in the response

POST https://europe.tcstatus.tekla.com/statusapi/1.0/auth/token
Authorization: Bearer <access_token>

The Status Sharing API can then be invoked using the status_token

1. Query Status Actions in a project: 

   GET https://europe.tcstatus.tekla.com/statusapi/1.0/projects/<project_id>/statusactions
   Authorization: Bearer <status_token>

    

2. Get current statuses for an action: 

   GET https://europe.tcstatus.tekla.com/statusapi/1.0/projects/<project_id>/status
   ?statusActionId=<action_id>
   Authorization: Bearer <status_token>

    

3. Add a Status Action: 

    POST https://europe.tcstatus.tekla.com/statusapi/1.0/projects/<project_id>/statusactions
   Authorization: Bearer <status_token>
   Content-Type: application/json
   {
          "isPublic": true,
          "name": "Test action",
          "allowedValues": "None,Started,Paused,Completed"
   
   }

    

4. Add Status Events for two objects.

   POST https://europe.tcstatus.tekla.com/statusapi/1.0/projects/<project_id>/statusevents
   Authorization: Bearer <status_token>
   Content-Type: application/json
   [{
          "objectId": "ifc-guid1",
          "statusActionId": "<action_id>",
          "value": "Completed",
          "valueDate": "2017-06-01T19:54:30.00Z"
   },
   {
          "objectId": "ifc-guid2",
          "statusActionId": "<action_id>",
          "value": "Paused",
          "valueDate": "2017-06-02T16:30:00.00Z"
   }]

   Note: Object guids must be in the IFC GUID format.