Page History

...

Deck of Cards

id	bimCreateProject

Card

label	HTTP Method

POST

Card

label	URL / Resource / JSON Structure

Resource: projects

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

Example: https://api-stage.bimplus.net/v2/bimplus-gmbh/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

default	true
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

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",
    "teamName": "Bimplus GmbH",
    "teamSlug": "bimplus-gmbh",
    "hasWriteAccess": true,
    "thumbnail": null,
    "created": "20132014-0701-11T1130T15:0243:1155.6567346Z1302187Z",
    "changed": "20132014-0701-11T1130T15:0243:1155.6567346Z1302187Z",
    "disciplines": null,
    "id": "0bc9e4b769e48f92-d679a8dc-43d74af5-86e38f71-0ded12fc0736187b40a8b8f5"
}

2. Create a

...

model under the project

Create a new model

...

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	bimGetObject1bimCreateModel

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource:

objects

divisions

URL: https://api-stage.bimplus.net/v2/<team>/objects/<team_slug>/projects/<project_id>/divisions

Example: https://api-stage.bimplus.net/v2/bimplus/objects/projects/69e48f92-a8dc-4af5-8f71-187b40a8b8f5/divisions

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentname	optionalmandatory	string (guid)	The id Name of the parent to which the object can be associatedmodel
description	optional	type	mandatory	string	Element type Short description of the objectmodel
attributesprojectIdoptional	will be ignored	string (guid)	Attributes Id of the objectchildrenthe project to which the model belongs
topologyId	optional	Object	Children of the object	string (guid)	Id of the topology to which the model belongs
disciplines	optional	object	The discipline list of the model

Card

label	Description

Creates a new objectmodel.

Card

default	true
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

{
    "parentname" : "0bc9e4b7-d679-43d7-86e3-0ded12fc0736Nemetschek Building",
    "typeshortDescr" : "TopologyDivision",
Model created via  "attributes"API"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
: {
        "elementname": {
            "isparent": false,
        "Nemetschek Building",
    "elementtypdescription": "e003e080-f21b-4f8a-8c4c-4c9c5026cf50"null,
            "logparentidprojectId": "b65b253469e48f92-55fea8dc-4fe74af5-806a8f71-da5bd1bccf75187b40a8b8f5",
            "divisionidid": "ac21b9a14496b8ad-8853ba5a-4658483c-9fbf9912-0cf62340bd182cb837178708",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "isobjectvalid": true,
			"name": "First floor"
        }
    }
}

Card

label	Response

3. 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 as the parent of the topology node object. The model id has to be provided as the "divisionid" attribute.

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

label	URL / Resource / JSON Structure

Resource: objects

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

Example: https://api-stage.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

default	true
label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "idparent": "7f76a49769e48f92-e322a8dc-4b784af5-b8208f71-1ce85ebc39db187b40a8b8f5",
    "type": "TopologyDivision",
    "attributes": {
        "element": {
            "isparent": falsetrue,
            "elementtyp": "e003e080-f21b-4f8a-8c4c-4c9c5026cf50",
            "logparentiddivisionid": "b65b25344496b8ad-55feba5a-4fe7483c-806a9912-da5bd1bccf752cb837178708",
        },
        "divisionidgeneral": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",{
            "materialsurfaceidname": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
    created by objects post",
    },
        "generalisobjectvalid": {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": "b793c860-d3b8-48a5-aa42-9df9e24a0d71",
    "parent": "69e48f92-a8dc-4af5-8f71-187b40a8b8f5",
    "type": "TopologyDivision",
    "attributes": {
        "isobjectvalidelement": {
            "isparent": true,
        }    "elementtyp": "e003e080-f21b-4f8a-8c4c-4c9c5026cf50",
            "divisionid": "4496b8ad-ba5a-483c-9912-2cb837178708",
    }
}
        "logparentid": "69e48f92-a8dc-4af5-8f71-187b40a8b8f5"
        },
        "general": {
            "name": "created by objects post",
            "isobjectvalid": true
        }
    }
}

3. Add a wall to the 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

label	URL / Resource / JSON Structure

Resource: objects

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

Example: https://api-stage.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

default	true
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" : "7f76a497b793c860-e322d3b8-4b7848a5-b820aa42-1ce85ebc39db9df9e24a0d71",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparentelementtyp": false"10074eef-9418-4d64-9c6d-23932835a7f1",
            "nrdivisionid": 0,"4496b8ad-ba5a-483c-9912-2cb837178708"
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="},
            "elementtypgeneral": "10074eef-9418-4d64-9c6d-23932835a7f1",
 {
            "divisionidname": "ac21b9a1-8853-4658-9fbf-0cf62340bd18a new test wall without walllayer"
        },
        "generalquantity": {
            "namewidth": "Brickwall"100,
            "isobjectvalidvolume": true200.4
        },
        "quantitygeometry": {
            "widthmesh": 115{
        },
        "allplancolor": {4291407461,
                "allplan_guidvertices": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
 [
                    -3486.667,
                   "allplan_id": 2065507287 0,
              "allplan_text": "<PP>Wall"      -3000,
            "dateofexport": "2013-05-01T09:32:13"
        8993.333,
         },
           0,
                "geometry": {    -3000,
            "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

label	Response

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "b2a92252-ae51-4c72-ab1e-fafa141ac54c",
    "parent": "b793c860-d3b8-48a5-aa42-9df9e24a0d71",
    "type": "Wall",
    "attributes": {
        "element": {
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "divisionid": "4496b8ad-ba5a-483c-9912-2cb837178708",
            "logparentid": "69e48f92-a8dc-4af5-8f71-187b40a8b8f5"
        },
        "general": {
            "name": "a new test wall without walllayer"
        },
        "quantity": {
            "width": 100,
            "volume": 200.4
        },
        "geometry": {
            "mesh": {
                "color": 4291407461,
                "vertices": [
                    -3486.667,
                    0,
                    -3000,
                    8993.333,
                    0,
                    -3000,
                    8993.333,
                    300,
                    -3000,
                    -3486.667,
                    300,
                    -3000,
                    -3486.667,
                    0,
                    -400,
                    8993.333,
                    0,
                    -400,
                    8993.333,
                    300,
                    -400,
                    -3486.667,
                    300,
                    -400
                ],
                "faces": [
                    4,
                    3,
                    0,
                    1,
                    2,

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": 04,
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        4,
                 "logparentid": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736"   7,
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"        6,
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        }5,
        "general": {
            "name": "Brickwall"4,
            "isobjectvalid": true
        }0,
            "allplan": {
        3,
      "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287 7,
                  "allplan_text": "<PP>Wall"  4,
            "dateofexport": "2013-05-01T09:32:13"
        }4,
        "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]}" 1,
                    0,
                    4,
                    5,
                    4,
                    2,
                    1,
                    5,
                    6,
                    4,
                    3,
                    2,
                    6,
                    7
                ]
            }
        },
        "elementstate": {
            "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
        }
    }
}

4. Add a column to the project

...

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

...

Anchor

	storyProjectList
	storyProjectList

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 359

New Version 360

Key

2. Create a

model under the project

Create a new model

3. Create a topology node

3. Add a wall to the 3. Add a wall to the project

4. Add a column to the project

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