Page History

...

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

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

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

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

A Topology node has to be created for adding the objects (Column, Wall). As a topology node is also an object, the Bimplus Object Service has to be used for creating the topology object. Please see the request tab. The id of the project is provided for the parent attribute of the json object(topology)

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

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

Example: https://api.bimplus.net/v2/bimplus/objects

JSON Structure:

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

label	Description

...

Card

Creates a new object

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

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

Again we use the Bimplus Object Service for creating the wall object in the project. Please note that the wall is added to the topology node and not the project (i.e See the request tab. The id of the topology node is provided for the parent attribute of the json object(wall))

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

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

Example: https://api.bimplus.net/v2/bimplus/objects

JSON Structure:

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

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

Again we use the Bimplus Object Service for creating the column object in the project. Please note that the wall is added to the topology node and not the project (i.e See the request tab. The id of the topology node is provided for the parent attribute of the json object(wall))

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

...

Card

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

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

Example: https://api.bimplus.net/v2/bimplus/objects

JSON Structure:

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

...

Card

Creates a new object

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

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

For verifying whether the wall and the column is added to the project, we have to call GET https://api.bimplus.net/v2/nemetschek/objects//topology. Please note that the API call GET https://api.bimplus.net/v2/nemetschek/projects//topology will only give you its children (i.e topology) details. So, if your project is very big, you can first call GET https://api.bimplus.net/v2/nemetschek/projects//topology and get the topology id(i.e 7f76a497-e322-4b78-b820-1ce85ebc39db in our example). Using the topology id we can get the object(wall, column in our case) details using the call GET https://api.bimplus.net/v2/nemetschek/objects/7f76a497-e322-4b78-b820-1ce85ebc39db/topology.

Deck of Cards

id	bimGetProjectProp

Card

label	HTTP Method

GET

Card

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/topology

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

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

...

Card

label	Description

...

card

Card

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

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

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.

...

Anchor

	storyProjectList
	storyProjectList

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 331

New Version 332

Key

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.