The bim+ API provides an interface for accessing the building information and models. It connects the building project information to a vast number of developers providing innovative Apps / applications that can operate on the building models and information.There are four types of database operation defined for manipulating the building content. i.e Create, Read, Update, Delete (CRUD) can be performed against the resources(URI, which are building information in our case) which are essentially the building blocks of REST.
The following HTTP methods implement these operations in the persistent level:
Operation |
SQL |
HTTP |
|---|---|---|
Create a resource on the server |
INSERT |
POST |
Retrieve the resource from the server |
SELECT |
GET |
Update the resource on the server |
UPDATE |
PUT |
Delete the resource from the server |
DELETE |
DELETE |
All necessary information for resource manipulation will be sent within a HTTP request. It includes
- Resource identificator (URL)
- Data type / format (HTTP header)
- Authentication information (HTTP header)
- Operation, which will be performed against the resource (HTTP method)
Things to remember:
- The JSON objects which will be used as the bim+ data exchange format will be based on the IFC standard in terms of structure and naming.
- The resource paths contain the team name and the project name to support multi-tenancy.
- The project slug (which should be provided during the creation of a project) should be provided as part of the URL for accessing all the project relevant resources. This is also necessary to verify the user's access rights on the project in an early stage of processing the API call (before any business data will be touched and any business logic will be executed)
bim+ Services
bim+ API provides RESTful services for accessing, creating, modifying and deleting different levels of information in a building model on our bim+ platform.
These are the project relevant services available at the moment:
- Project Service
- Object Service
- ElementType Service
- Division Service
- Attachment Service
- Issue Service
- Pin Service
- Import Service
These are the administration relevant services available at the moment:
For further details see the bim+ api reference
Client request example:
