...
Connect with Bimplus. Relation(workflow) between Bimplus portal and Bimplus api
draw.io Diagram |
---|
diagramName | US_Portal_Api.drawio |
---|
diagramDisplayName | US_Portal_Api |
---|
revision | 1 |
---|
|
-
Newwindowlink |
---|
title | Bimplus portal |
---|
url | https://www-stage.bimplus.net |
---|
|
is the first place of contact of the user/developer for using the Bimplus platform(stage version). The production version of the portal can be found under Newwindowlink |
---|
title | shop |
---|
url | https://www.bimplus.net/en/products/ |
---|
|
where you can purchase different editions of Bimplus cloud platform. Newwindowlink |
---|
title | Here |
---|
url | https://www.bimplus.net/en/Home-oxid/bim-Apps/ |
---|
|
you can also find a few critical foundation apps like the Bimplus Explorer, Bimplus Viewer and Bimplus Problem Spotter. The portal takes care of the user registration(developer registration) as well. - The Bimplus API(development version url : https://api-stage.bimplus.net/v2) 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.
...
Become a Bimplus compliant developer/partner. Register and authorize yourself to access the Bimplus resources. Relation between teams and projects
draw.io Diagram |
---|
diagramName | 3-US_Register_Compliance.drawio |
---|
diagramDisplayName | US_Register_Compliance |
---|
revision | 1 |
---|
|
- Please register
Newwindowlink |
---|
title | here |
---|
url | https://www-stage.bimplus.net |
---|
|
for accessing the Bimplus resources and become a Bimplus compliant developer and a partner. You will receive an authentication token after the registration. - A Team is a tenant/company which work on the projects. The team has to be specified and setup through the
Newwindowlink |
---|
title | bimplus |
---|
url | https://www-stage.bimplus.net |
---|
|
portal as so called Newwindowlink |
---|
title | slugs |
---|
url | http://en.wikipedia.org/wiki/Clean_URL |
---|
|
to present a Newwindowlink |
---|
title | clean URL |
---|
url | http://en.wikipedia.org/wiki/Clean_URL |
---|
|
. The team slug will be used to know which tenant database to work on. - Using the authentication token and the team slug, you can start working with the building projects which you are a member of, using our Bimplus api.
- Please find a quick start tutorial
Newwindowlink |
---|
title | here |
---|
url | 1.2+Quick+Start |
---|
|
.
...
Create a team. Create an user. Assign the newly created user to the newly created team. Verify whether he/she is part of the team
draw.io Diagram |
---|
diagramName | 2-US_Team_User.drawio |
---|
diagramDisplayName | US_Team_User |
---|
revision | 1 |
---|
|
The Bimplus provides a few user administration relevant services. They are:
...
Create, modify and access different resources/objects of the building model using the Bimplus api
draw.io Diagram |
---|
diagramName | 2-US_Api_Intro.drawio |
---|
diagramDisplayName | US_Api_Intro |
---|
revision | 1 |
---|
|
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)
...
Create a project, add an object(wall) and view it using the web viewer
draw.io Diagram |
---|
diagramName | US_Create_Project.drawio |
---|
diagramDisplayName | US_Create_Project |
---|
revision | 1 |
---|
|
1. Create a new project
Use the Bimplus Project Service for creating a new project.
...
Get the list of available projects and its properties
draw.io Diagram |
---|
diagramName | US_Project_List.drawio |
---|
diagramDisplayName | US_Project_List |
---|
revision | 1 |
---|
|
- This API call(GET https://api-stage.bimplus.net/v2//projects) should retrieve the list of projects available to the team. In this call, only a few properties of the projects will be visible.
...
Add a thumbnail to the project
draw.io Diagram |
---|
diagramName | US_Thumbnail.drawio |
---|
diagramDisplayName | US_Thumbnail |
---|
revision | 1 |
---|
|
- Thumbnail can be added to a project by using the Bimplus Project Service(POST https://api-stage.bimplus.net/v2//projects//thumbnail). There is also a service available for downloading the thumbnail.
...
Add properties to the project
draw.io Diagram |
---|
diagramName | US_AddProperties.drawio |
---|
diagramDisplayName | US_AddProperties |
---|
revision | 1 |
---|
|
- The project can be updated with the necessary attributes. The list of available Bimplus attributes can be seen here
...
Project topology and object topology tree
draw.io Diagram |
---|
diagramName | 3-US_Topology.drawio |
---|
diagramDisplayName | US_Topology |
---|
revision | 1 |
---|
|
Topology is a hierarchical tree representing all its child nodes. A topology tree consist of components which can have a graphical representation(objects or elements) or components which does not have a graphical representation(nodes). A topology tree can be obtained both on the project as well as on the object level.
...
Find the geometry of an object. Get to know the types of geometry available
draw.io Diagram |
---|
diagramName | 3-US_Geometry.drawio |
---|
diagramDisplayName | US_Geometry |
---|
revision | 1 |
---|
|
The geometrical information(graphical representation) of a building can be accessed through the Bimplus Object Service. There are different types of geometry available for optimizing and viewing on different devices.
...
Get the different properties / structure(normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations
draw.io Diagram |
---|
diagramName | 3-US_ObjectWithDiffProps.drawio |
---|
diagramDisplayName | US_ObjectWithDiffProps |
---|
revision | 1 |
---|
|
Different properties / structure (normal, viewer properties, object in hierarchical tree structure) of the object can be obtained using different property combinations.
...
Get the project layers and element types. Find the relation between them
draw.io Diagram |
---|
diagramName | US_Discipline.drawio |
---|
diagramDisplayName | US_Discipline |
---|
revision | 1 |
---|
|
A group of element types constitute a layer. But an element type cannot belong to two layers. Both the element types and layers are predefined.
...
Filter the building information using different filter criteria
draw.io Diagram |
---|
diagramName | US_Filters.drawio |
---|
diagramDisplayName | US_Filters |
---|
revision | 1 |
---|
|
The "ThreeJS" or the "meshblob" information can be filtered by the layer.
...
Import an existing model in the form of IFC/SketchUp file
draw.io Diagram |
---|
diagramName | US_Import.drawio |
---|
diagramDisplayName | US_Import |
---|
revision | 1 |
---|
|
Projects in the form of IFC/SketchUp files can be imported into the Bimplus platform by using the Bimplus Import Service
...
Create and assign issues to projects. Locate/visualize the issues in the project
draw.io Diagram |
---|
diagramName | US_Issues.drawio |
---|
diagramDisplayName | US_Issues |
---|
revision | 1 |
---|
|
Any problems or remarks can be reported and assigned to a project in the form of issues. To understand the problem better, comments or attachments can be added to the issue.
...
Learn about the issue based rights & roles
draw.io Diagram |
---|
diagramName | 2-US_IssueRightsRoles.drawio |
---|
diagramDisplayName | US_IssueRightsRoles |
---|
revision | 1 |
---|
|
Currently Bimplus has a couple of issue based roles (i.e Author, Responsible). Author is the user who creates an issue and the responsible is the one who solves it. Here are some of the conditions that apply for the Bimplus issue tracking.
...
Add attachments to the whole building as well as to the individual objects
draw.io Diagram |
---|
diagramName | 2-US_Attachment.drawio |
---|
diagramDisplayName | US_Attachment |
---|
revision | 1 |
---|
|
The pictures or any other documents(pdf, ifc etc) can be attached to both the project as well as the individual objects.
...
Find out how many teams I am part of. Remove myself from some of the teams
draw.io Diagram |
---|
diagramName | US_Remove_User.drawio |
---|
diagramDisplayName | US_Remove_User |
---|
revision | 1 |
---|
|
- Please use the Bimplus Team Management Service (GET https://api-stage.bimplus.net/v2/teams) to get the team list in which you are member of.
...
Authentication token for multiple services
draw.io Diagram |
---|
diagramName | 3-US_Cross_Authentication.drawio |
---|
diagramDisplayName | US_Cross_Authentication |
---|
revision | 1 |
---|
|
- Please use the client_id as part of the authentication request. The client_id is a name of another application ,that user wants to use additionally. When user authenticate to another service using SSO, it opens browser UI login page again, it uses cookies and issues token without re-entering credentials. A token will be generated based on the new client_id and cookies which will allow single-signon logins at the same time and increase security because credentials are not entered and transferred many times and the token is only valid for this device and client (Browser, Mobile App).
Obsolete example using internal authentication service, deprecated in 2026:
...
Rights & Roles. Relation between User, Team and Project
draw.io Diagram |
---|
diagramName | 4-US_RightsRoles.drawio |
---|
diagramDisplayName | US_RightsRoles |
---|
revision | 1 |
---|
|
Rights vs Roles
| Account / Team Owner | Project Admin | Project Editor | Project Viewer |
---|
Create Project | x |
|
|
|
Admin Project (eg. invite) | x | x |
|
|
Edit Project | x | x | x |
|
Delete Project | x | x |
|
|
View Project | x | x | x | x |
|
|
|
|
|
View all Models | x | x | x | x |
Create Model | x | x |
|
|
Admin Model (eg. invite) | x | x |
|
|
Assign User to Model | x | x |
|
|
Edit Model | x | x |
|
|
Import Data | x | x |
|
|
Delete Model | x | x |
|
|
View Model | x | x | x | x |
...