Page History

Note
This web page is under construction.

Composition Setup

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

...

Connect with Bimplus. Relation(workflow) between Bimplus portal and Bimplus api

Gliffy Diagram

size	L
name	US_Portal_Api

Newwindowlink
title Bimplus portal
url http://www.bimplus.net/
is the first place of contact of the user/developer for using the Bimplus platform. It includes a
Newwindowlink
title shop
url http://www.bimplus.net/en/Apps/bim-Shop/
where you can purchase different editions of Bimplus cloud platform.
Newwindowlink
title Here
url http://www.bimplus.net/en/Apps/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.

...

Become a Bimplus compliant developer/partner. Register and authorize yourself to access the Bimplus resources. Relation between teams and projects

Gliffy Diagram

size	L
name	US_Register_Compliance

Please register
Newwindowlink
title here
url http://www.bimplus.net/en/open-account/
for accessing the Bimplus resources and become a Bimplus compliant developer and a partner. You will receive an authentication token after the registration.

...

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

Gliffy Diagram

size	L
name	US_Team_User

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

Gliffy Diagram

size	L
name	US_Api_Intro

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 some objects(walls, columns) and view it using the web viewer

Gliffy Diagram

size	L
name	US_Create_Project

1. Create a new project

Use the Bimplus Project Service for creating a new project.

Deck of Cards

id	bimCreateProject

Card

label	HTTP Method

POST

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

URL: https://api.bimplus.net/v2/<team>/projects

...

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	will be ignored	string (date)	Creation date of the project

Card

Card

label	Description

Creates a new project.

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml


{
"name" : "Your Wonderful Model",
"shortDescr" : "The best building model in the world"
}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "name": "Your Wonderful Model",
    "shortDescr": "The best building model in the world",
    "thumbnail": null,
    "created": "2013-07-11T11:02:11.6567346Z",
    "changed": "2013-07-11T11:02:11.6567346Z",
    "disciplines": null,
    "id": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736"
}

Card

Deck of Cards

2. Create a topology node

...

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: https://api.bimplus.net/v2/<team>/objects

...

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	Object	Children of the object

Card

Card

label	Description

Creates a new object

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "parent": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736",
    "type": "TopologyDivision",
    "attributes": {
        "element": {
            "isparent": false,
            "elementtyp": "e003e080-f21b-4f8a-8c4c-4c9c5026cf50",
            "logparentid": "b65b2534-55fe-4fe7-806a-da5bd1bccf75",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "isobjectvalid": true,
			"name": "First floor"
        }
    }
}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "id": "7f76a497-e322-4b78-b820-1ce85ebc39db",
    "type": "TopologyDivision",
    "attributes": {
        "element": {
            "isparent": false,
            "elementtyp": "e003e080-f21b-4f8a-8c4c-4c9c5026cf50",
            "logparentid": "b65b2534-55fe-4fe7-806a-da5bd1bccf75",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "name": "First floor",
            "isobjectvalid": true
        }
    }
}

Card

Deck of Cards

3. Add a wall to the project

...

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: https://api.bimplus.net/v2/<team>/objects

...

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	Object	Children of the object

Card

Card

label	Description

Creates a new object

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "parent" : "7f76a497-e322-4b78-b820-1ce85ebc39db",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
             "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "id": "921bc1f6-228a-4f79-937a-0251b60436b4",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":0,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Card

Deck of Cards

4. Add a column to the project

...

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: https://api.bimplus.net/v2/<team>/objects

...

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	Object	Children of the object

Card

Card

label	Description

Creates a new object

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "parent" : "7f76a497-e322-4b78-b820-1ce85ebc39db",
    "type": "Column",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "BrickColumn",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115,
			"volume" : 24
        },
        "geometry": {
            "mesh": "{\"C\":0,\"V\":[3843.438,-1048.958,-1565.0,3943.438,-1048.958,-1565.0,3943.438,-948.958,-1565.0,3843.438,-948.958,-1565.0,3843.438,-1048.958,635.0,3943.438,-1048.958,635.0,3943.438,-948.958,635.0,3843.438,-948.958,635.0],\"F\":[4,3,0,1,2,4,4,7,6,5,4,0,3,7,4,4,1,0,4,5,4,2,1,5,6,4,3,2,6,7]}"
        }
    }
}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "id": "de5a8d7e-701f-42ff-9731-f32fb1fb767d",
    "type": "Column",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "elementtyp": "2e308afe-d078-4c20-b53c-76b2da66d848",
            "logparentid": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "name": "BrickColumn",
            "isobjectvalid": true
        },
        "geometry": {
            "mesh": "{\"C\":0,\"V\":[3843.438,-1048.958,-1565.0,3943.438,-1048.958,-1565.0,3943.438,-948.958,-1565.0,3843.438,-948.958,-1565.0,3843.438,-1048.958,635.0,3943.438,-1048.958,635.0,3943.438,-948.958,635.0,3843.438,-948.958,635.0],\"F\":[4,3,0,1,2,4,4,7,6,5,4,0,3,7,4,4,1,0,4,5,4,2,1,5,6,4,3,2,6,7]}"
        }
    }
}

Card

Deck of Cards

5. Verify whether the wall and column is added to the project by seeing the object topology

...

Deck of Cards

id	bimGetProjectProp

Card

label	HTTP Method

GET

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/topology

...

Example: {nolink:https://api.bimplus.net/v2/bimplus/objects/0bc9e4b7-d679-43d7-86e3-0ded12fc0736/topology

Card

Card

label	Description

Get all the project properties of a project using its id.

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "parent": null,
    "name": "Your Wonderful Model",
    "type": "ID_Project",
    "children": [
        {
            "parent": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736",
            "name": "First floor",
            "type": "ID_TopologyDivision",
            "children": [
                {
                    "parent": "7f76a497-e322-4b78-b820-1ce85ebc39db",
                    "name": "Brickwall",
                    "type": "ID_ArchWall",
                    "children": [],
                    "id": "921bc1f6-228a-4f79-937a-0251b60436b4"
                },
                {
                    "parent": "7f76a497-e322-4b78-b820-1ce85ebc39db",
                    "name": "BrickColumn",
                    "type": "ID_ArchColumn",
                    "children": [],
                    "id": "de5a8d7e-701f-42ff-9731-f32fb1fb767d"
                }
            ],
            "id": "7f76a497-e322-4b78-b820-1ce85ebc39db"
        }
    ],
    "id": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736"
}

Card

Deck of Cards

6. See your result visually by using the web viewer.

...

Get the list of available projects and its properties

Gliffy Diagram

size	L
name	US_Project_List

This API call(GET https://api.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

Gliffy Diagram

size	L
name	US_Thumbnail

Thumbnail can be added to a project by using the Bimplus Project Service(POST https://api.bimplus.net/v2//projects//thumbnail). There is also a service available for downloading the thumbnail.

...

Add properties to the project

Gliffy Diagram

size	L
name	US_AddProperties

The project can be updated with the necessary attributes. The list of available Bimplus attributes can be seen here

...

Deck of Cards

id	bimUpdateProject

Card

label	HTTP Method

PUT

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

...

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	will be ignored	string (date)	Creation date of the project
changed	will be ignored	string (date)	Changed date of the project

Card

Card

label	Description

Update or replace a specified existing project with a new one.

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "properties": {
        "MainFloorArea": "456m²",
        "Architect": {
            "name": "NemetschekTech.GmbH",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "city": "Munich",
            "zip": "81829",
            "street": "Konrad-Zuse-Platz1"
        },
        "Customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "city": "New Jersy",
            "zip": "08201"
        }
    }
}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 200 OK

Card

Deck of Cards

See the updated project properties

Deck of Cards

id	bimGetProjectProp

Card

label	HTTP Method

GET

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

...

Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2

Card

Card

label	Description

Get all the project properties of a project using its id.

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml


{
    "name": "Your Awesome Building",
    "shortDescr": "The example project",
    "thumbnail": "/nemetschek/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail/download",
    "created": "0001-01-01T00:00:00",
    "changed": "0001-01-01T00:00:00",
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
    ],
    "properties": {
        "mainfloorarea": "456m²",
        "architect": {
            "name": "NemetschekTech.GmbH",
            "street": "Konrad-Zuse-Platz1",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "zip": "81829",
            "city": "Munich"
        },
        "customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "zip": "08201",
            "city": "New Jersy"
        }
    },
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Card

Deck of Cards

...

Anchor

	storyTopologyTree
	storyTopologyTree

Project topology and object topology tree

Gliffy Diagram

size	L
name	US_Topology

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.

...

Section

Column

Code Block

borderColor	Green
title	Project Topology Tree (GET api.bimplus.net/v2/<team>/projects/<project_id>/topology)
lang	xml


{
"parent": null,
"name": null,
"type": "Project",
"children": \[{
            "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "name": null,
            "type": "ID_TopologyDivision",
            "children": [],
            "id": "195db084-3715-4ebc-b164-3ee47a495b2e"
        }
\],
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Column

Code Block

borderColor	Green
title	Project Tree (GET api.bimplus.net/v2/<team>/projects/<project_id>)
lang	xml


{
"name": "Your Awesome Building",
"shortDescr": "Updating the example project",
"created": "0001-01-01T00:00:00",
"changed": "0001-01-01T00:00:00",
"disciplines": \[{
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
\],
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...

Section

Column

Code Block

borderColor	Green
title	Object Topology Tree (GET api.bimplus.net/v2/<team>/objects/<object_id>/topology)
lang	xml


{
    "parent": null,
    "name": "Updated_Brickwall",
    "type": "ID_ArchWall",
    "children": [],
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75"
}

Column

Code Block

borderColor	Green
title	Object Tree (GET api.bimplus.net/v2/<team>/objects/<object_id>)
lang	xml


{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"type": "Wall",
"attributes": {
"element": {
            "isparent": true,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy
                       2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
"general": {
            "name": "Updated_Brickwall",
            "isobjectvalid": true
        },
"allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
"geometry": {
"mesh": "{\"C\":0,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,
          0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,
          2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,
          0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,
          8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}

...

Section

Column

Code Block

borderColor	Green
title	Project Tree (GET api.bimplus.net/v2/nemetschek/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e)
lang	xml


{
    "name": "Your Awesome Building",
    "shortDescr": "Updating the example project",
    "thumbnail": "/nemetschek/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail/download",
    "created": "0001-01-01T00:00:00",
    "changed": "0001-01-01T00:00:00",
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
    ],
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Column

Code Block

borderColor	Green
title	Project Topology Tree (GET api.bimplus.net/v2/nemetschek/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/topology)
lang	xml


{
    "parent": null,
    "name": "Your Awesome Building",
    "type": "ID_Project",
    "children": [
        {
            "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "name": "Your Awesome Building",
            "type": "ID_TopologyDivision",
            "children": [],
            "id": "c1c6c2bc-f38e-4c01-ae5a-864baaa0b2d0"
        }
    ],
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Section

Column

Code Block

borderColor	Green
title	Object Tree (GET api.bimplus.net/v2/nemetschek/objects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e)
lang	xml


{
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "type": "Project",
    "attributes": {
        "element": {
            "isparent": true,
            "elementtyp": "8d27ae6d-3c9a-4201-8a4d-bf0225861788",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "name": "Your Awesome Building",
            "description": "Updating the example project",
            "isobjectvalid": true
        }
    }
}

Column

Code Block

borderColor	Green
title	Object Topology Tree (GET api.bimplus.net/v2/nemetschek/objects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/topology)
lang	xml


{
    "parent": null,
    "name": "Your Awesome Building",
    "type": "ID_Project",
    "children": [
        {
            "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "name": "Your Awesome Building",
            "type": "ID_TopologyDivision",
            "children": [
                {
                    "parent": "c1c6c2bc-f38e-4c01-ae5a-864baaa0b2d0",
                    "name": "Brickwall",
                    "type": "ID_ArchWall",
                    "children": [],
                    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75"
                }
            ],
            "id": "c1c6c2bc-f38e-4c01-ae5a-864baaa0b2d0"
        }
    ],
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...

Find the geometry of an object. Get to know the types of geometry available

Gliffy Diagram

size	L
name	US_Geometry

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.

...

Code Block

borderColor	Green
title	Get the mesh data from the object tree (GET api.bimplus.net/v2/<team>/objects/<object_id>)
lang	xml


{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"type": "Wall",
"attributes": {
"element": {
            "isparent": true,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy
                       2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
"general": {
            "name": "Updated_Brickwall",
            "isobjectvalid": true
        },
"allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
"geometry": {
"mesh": "{\"C\":0,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,
          0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,
          2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,
          0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,
          8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}

...

Code Block

borderColor	Green
title	Meshblob data (GET api.bimplus.net/v2/<team>/objects/<object_id>/geometries/meshblob)
lang	xml


{
    "elementsCount": 1,
    "objects": [
        {
            "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
            "parent": "00000000-0000-0000-0000-000000000000",
            "type": "Wall",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW3PbRBTWylIsuUmctml6T900t7aua+eetiHOndAQDLS8pBnhyzYVUeQiyR0cGJ545y9QGB
				54YYY3HvkXPPetQLlDuV/2E7uqiEfUMzRDkWc/zfl0tHvO2XPOWhKRJOkPduGOq1VmcLVQmPE8xywVzLJXc+iV+k06nE69QB3Xr
				NpTQ9lcLpPNjExmxzIjufHRbDo1V7OgOGXTmucUrXSqUCtZZvkyrV+pblJ7yq5Zloo10qt0i3pu+QbdzKxe9UxrxSw5RaeemZstunT
				BYk9tr1C16rRCnTh7Qb1ZNW1PoZUNqlwvlqm2ZTxXrJg1t33LmKV2xbQ3nKplUcVjRsrL87FYTFGU2G3yfN316FZmDg/LHrPbzSxRm
				zpmObNiut6LubW1SFsCO9jSzJfdiMb6+luPwsQFFpfH28JFtmm7ZmFP5OrVmu3NOE6xjoRuUq03Sk0kJMyG4h4el6WaWYGsxwAKQGWQ
				SKg/s5pqajoURfxW0apRw5A0TBbrkCTlJ/Z+eJU97IFsFGWjJBtl2ajIBpWN67KxIRs3ZMOUjZdkY1N6cGnxuMwvacelwNj/QX3AzBb
				DZEa6quGa21Qzbv01Jwv0QFO2ra3De03TNXbr4EPBPj3+xfeP7vc3Y1rgvc5uh/hQ1Efl/a4W9r/zHqYF3idQkXzEkQgSEZnQ11QW+R
				WOAtRbAW2AdkASgIn0vYB9gP2ATsABQBfgIADB1w8DjsAQXRiSgiGRrSK8n74dRwHHAMcB3YATAMyjnwT0AE4BegF9gH7AAGAQcBpwB
				nAWkAacA2QA5wFZQA4wxKBNiyf+FrqHWow98C0eBowARgFjgHHABGAScAFwEXAJa7WoiHZzm4NEIa+QOtlGxrS0YMn7g9felEsf5F+e
				Snz8zkfX8q92vr90Z/uNaYL9w9T3nv2wW5Xea1Ro26EgHgQK7VxBLNGgkAzP0PV2o0LHDoUGG/ZyBUE0KOzbodCwxP4dRooZ/CVfezd
				POiO8CBQORCwRKHRFGBkoHIxw05eP3c6TQxF7ESgcjtiLQOFIRKiFgopaabqy1BLdMO0Y+0uJriHzXPfvKLejXPDz7TgnIOA0Id2cUPh
				r5AQn0G1bQKQ4AQH/a8lJTkBAVyI9nND4a+QUJ9AqUHyklxMJ7jjp4wQE5Dbp50Qrf40MhAzz5xgMTepbejpkGNKfnOEEBKQ7OcuJdhG
				PdGgV35dzITt8XzKhAKEiyHlOQEAFkCwnOoS3udCyvsZQ6BUsrQ43s51oO/BLxReDG3u9iYOOqyzb3vBQOrXllquOZZYeHGIj7ARjv4c
				fXaXx8eJoeXQsNzk8QrMTk+v+EaRPwRs0QL8TPgFpVEjTkMaElIc0LqQZSBNCmoU0KaQ5SBeENA/popAWIF0S0iJ2Hyb8x6GIPtHjKDh
				NX+Jp6tcQogSj9SfD7LRgl8NsXrBPhdkZwV7mSekn5qxgV8K6c4J9Oqw7L9jVsO6CYJ8Js4uCLYTYpHBJE61ENIykcEsTDUK0gaRwTRN
				lL4o7KdzTfmUfByiTH9gdlZEMXMRnhygxnCP4tP+Gje/YwLGRFG5r+MD4go3v2cB5kQxc/40xOCBwBqDN/8jkz9m4z8a3mF+EQ0OP/4w
				xaOVf4YkIifYJk75m4xc2PsUTERbtLpPusfE7G1/iI+dPBQ0gCIMQAAA=",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAA
                              DwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        }
    ]
}

...

Code Block

borderColor	Green
title	ThreeJS data (GET api.bimplus.net/v2/<team>/objects/<object_id>/geometries/threejs)
lang	xml


{
    "elementsCount": 1,
    "viewbox": {
        "x": -5081.562,
        "y": 5005.8785,
        "z": 1231.1029999999996,
        "width": 5950,
        "height": 5540.835,
        "depth": 7065.71
    },
    "colors": [
        -9868951
    ],
    "objects": [
        {
            "id": "f5cc3c6c-1fdf-499d-a38d-0582adadc216",
            "type": "RoofLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            0,
                            2,
                            1,
                            3,
                            0,
                            5,
                            3,
                            9,
                            1,
                            1,
                            14,
                            1,
                            5,
                            6,
                            15,
                            12,
                            1,
                            7,
                            4,
                            13,
                            14
                        ],
                        "vertices": [
                            -2106.562,
                            7588.114,
                            -2301.752,
                            -8056.562,
                            7588.114,
                            -2301.752,
                            -8056.562,
                            -880.999,
                            -4742.212,
                            6700,
                            -880.999,
                            -4742.212,
                            7412.539,
                            -1821.578,
                            -5522.212,
                            7412.539,
                            -1821.578
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 7065.71,
                    "height": 150,
                    "volume": 7911354818.818842,
                    "area": 52742365.4587924
                },
                "general": {
                    "name": "<PP>RoofLayer"
                }
            }
        }
    ]
}

...

Get the project layers and element types. Find the relation between them

Gliffy Diagram

size	L
name	US_Discipline

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

Gliffy Diagram

size	L
name	US_Filters

The "ThreeJS" or the "meshblob" information can be filtered by the layer.

...

Import an existing project in the form of IFC/SketchUp file

Gliffy Diagram

size	L
name	US_Import

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

Gliffy Diagram

size	L
name	US_Issues

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.

...

Add attachments to the whole building as well as to the individual objects

Gliffy Diagram

size	L
name	US_Attachment

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

Gliffy Diagram

size	L
name	US_Remove_User

Please use the Bimplus Team Management Service (GET https://api.bimplus.net/v2/teams) to get the team list in which you are member of.

...

Authentication token for multiple logins and cross client authentication using temporary token

Gliffy Diagram

size	L
name	US_Cross_Authentication

Please use the client_id as part of the authentication request. The client_id is a unique identifier for the client which is authorizing the user against the API server. The client_id will be generated from the server during the authentication request(Please see the response of the authentication request). A token can be generated based on the client_id and the user_id which will allow multiple logins at the same time and increase security because the token is only valid for this device(Browser, Mobile App).

...

Deck of Cards

id	bimAuthenticateToken

Card

label	HTTP Method

POST

Card

Card

label	URL / Resource / JSON Structure

Resource: authorize

URL: https://api.bimplus.net/v2/authorize

...

Name	Mandatory / Optional	Type	Description
user_id	mandatory	string	The email address of the user
password	mandatory	string	The user's password
client_id	optional	string	The identifier of the used client
application_id	optional	string	The id of the application

...

Art-No	App	Platform	UID
Editions
AM00050000	Bimplus Starter Edition	Cloud	df2dbfa44a2b89704d38e07175be8298

AM00050050	Bimplus Business Edition	Cloud	2efa4c5a58b189e04f0af8879d6c3fca

AM00050100	Bimplus Enterprise Edition	Cloud	685b24cf716e211e64f126d5347074e3

BTW
AM00050200	Bimplus TeamWorks	Win	f6c5e0004f0ae73c485324a900a28a14

Bimplus Apps
AM0005311	Bimplus Explorer	iPad	c08181961a0cf078d740f402a18610a1
AM0005321	Bimplus MyHouse Photo	iPad	13f8972af21a76036717f0e51db64184
AM0005331	Bimplus Problem Spotter	iPad	13fe742a744959f7f849c30b63bcc4c0
AM0005341	Bimplus Viewer	iPad	c087f3e4f242e974e6ca99f74cc4f6a0

3rd Party Apps

Bimplus Services
AM00055000	Bimplus WebViewer	Browser

...

label	Description

...

Card

Card

label	Description

Authenticate by requesting and receiving a token.

Card

Request

Card

label	Request

Card

label

Code Block

borderColor	Green
title	Headers
lang	xml


Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml


{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

Card

Card

default	true
label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml


{
access_token: "e3271e89d8ea474c82745039bc2bed0d"
expires_in: 2591999
client_id: "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
token_type: "BimPlus"
}

Card

Deck of Cards

Use the client_id "9fd0bb9d-570b-4719-bfae-93e2f879c19a" to generate a token for multiple logins.

Deck of Cards

id	bimAuthenticateToken

Card

label	HTTP Method

POST

Card

Card

label	URL / Resource / JSON Structure

Resource: authorize

URL: https://api.bimplus.net/v2/authorize

...

Name	Mandatory / Optional	Type	Description
user_id	mandatory	string	The email address of the user
password	mandatory	string	The user's password
client_id	optional	string	The identifier of the used client
application_id	optional	string	The id of the application

Card

Card

label	Description

Authenticate by requesting and receiving a token.

Card

Card

default	true
label	Request

Code Block

borderColor	Green
title	Headers
lang	xml


Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml


{
 "user_id" : "test@bimplus.net",
 "password" : "test",
 "client_id" : "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml


Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml


{
access_token: "c33fa174169e46999fe82fb07fc53e3d"
expires_in: 2591999
client_id: "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
token_type: "BimPlus"
}

Card

Deck of Cards

For switching the client, the cross token service can be used. This service is basically used for requesting a disposable temporary token which will be used for authenticating against different clients. Based on the given authentication token the user is identified and a one time token is generated and returned. This one time cross token is valid only for 5 minutes and is used for logging into the given device/client using cross authentication service . As a result of this call, this one time cross token will be removed but the new token which will be generated can be used in the header for the subsequent API calls.

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 327

New Version 328

Key

Connect with Bimplus. Relation(workflow) between Bimplus portal and Bimplus api

Become a Bimplus compliant developer/partner. Register and authorize yourself to access the Bimplus resources. Relation between teams and projects

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

Create, modify and access different resources/objects of the building model using the Bimplus api

Create a project, add some objects(walls, columns) and view it using the web viewer

1. Create a new project

2. Create a topology node

3. Add a wall to the project

4. Add a column to the project

5. Verify whether the wall and column is added to the project by seeing the object topology

6. See your result visually by using the web viewer.

Get the list of available projects and its properties

Add a thumbnail to the project

Add properties to the project

Project topology and object topology tree

Find the geometry of an object. Get to know the types of geometry available

Get the project layers and element types. Find the relation between them

Filter the building information using different filter criteria

Import an existing project in the form of IFC/SketchUp file

Create and assign issues to projects. Locate/visualize the issues in the project

Add attachments to the whole building as well as to the individual objects

Find out how many teams I am part of. Remove myself from some of the teams

Authentication token for multiple logins and cross client authentication using temporary token