Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Help us improve the bim+ API doc by providing your valuable comments. You can find the comment section at the bottom of the page.

bim+ Introduction

  • bim+ is an open, "All-Connect" platform for connecting people, information and BIM models to build faster. bim+ is Open BIM compliant.
  • bim+ provides universal access, sharing and connection of relevant building information; enabling seamless collaboration among all people in the project
  • bim+ is designed, using the latest Internet computing, cloud technologies, mobile devices and social communication.
  • bim+ is the future of the Internet based building Industry.
  • You can find more information about bim+ from our
    Newwindowlink
    titleBimplus website
    urlhttp://www.bimplus.net/
  • What is bim+ ?

    Office Powerpoint
    nameWhat is bimplus.pptx
    width550
    height300
  • Benefits of Bim+

    Office Powerpoint
    nameIntroducing bimplus.pdf
    width550
    height300

bim+ API

bim+ API provides RESTful services for accessing, creating, modifying and deleting different levels of information in a building model on our bim+ platform. 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)

Connect with bim+

  • Newwindowlink
    titleBimplus portal
    urlhttp://www.bimplus.net/
    is the first place of contact of the user/developer for using the bim+ platform. It includes a
    Newwindowlink
    titleshop
    urlhttp://www.bimplus.net/en/Apps/bim-Shop/
    where you can purchase different editions of bim+ cloud platform.
    Newwindowlink
    titleHere
    urlhttp://www.bimplus.net/en/Apps/bim-Apps/
    you can also find a few critical foundation apps like the bim+ Explorer, bim+ Viewer and bim+ Problem Spotter. The portal takes care of the user registration(developer registration) as well.
  • 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.

The following figure describes the relation between the bim+ portal and the API.


Become a bim+ compliant developer/partner

  • Please register
    Newwindowlink
    titlehere
    urlhttp://www.bimplus.net/en/open-account/
    for accessing the bim+ resources and become a bim+ 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
    titlebimplus
    urlhttp://www.bimplus.net/
    portal as so called
    Newwindowlink
    titleslugs
    urlhttp://en.wikipedia.org/wiki/Clean_URL#Slug/
    to present a
    Newwindowlink
    titleclean URL
    urlhttp://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 bim+ api.
  • Please find a quick start tutorial
    Newwindowlink
    titlehere
    url1.1.2+Quick+Start+Guide
    .


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:

These are the administration relevant services available at the moment:

For further details see the bim+ api reference

Client request example:

Composition Setup
Deck of Cards
idbimGetProjectList
Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects 

URLhttps://api.bimplus.net/v2/<team>/projects

Examplehttps://api.bimplus.net/v2/bimplus/projects

Card
labelDescription

Gets the available project list with main properties.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse

Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK