Page History

...

Object Service

...

Objects are the primary component of the project tree and it exists in two forms.

...

Deck of Cards

id	bimCreateObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: https://api-stage.bimplus.net/v2/<team_slug>/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	HTTP Method

POST

Card

label	Description

Creates a new object

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

title	JSON

{
  "parent": "925f9e2d-8877-406b-9806-afb4246ed2e2",
  "type": "Wall",
  "attributes": {
    "element": {
      "isparent": false,
      "nr": 0,
      "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
      "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
      "divisionid": "e7859a8f-4b7a-4263-8420-405d565377aa"
    },
    "general": {
      "name": "Brickwall",
      "isobjectvalid": true
    },
    "quantity": {
      "width": 115
    },
    "geometry": {
      "mesh": "{\"Color\":4278255360,\"Vertices\":[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],\"Faces\":[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

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "33c741c1-f03e-4c47-b072-de8637f8f340",
  "parent": "925f9e2d-8877-406b-9806-afb4246ed2e2",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element": {
      "isparent": false,
      "nr": 0,
      "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
      "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
      "divisionid": "e7859a8f-4b7a-4263-8420-405d565377aa",
      "logparentid": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a"
    },
    "general": {
      "name": "Brickwall",
      "isobjectvalid": true
    },
    "quantity": {
      "width": 115
    },
    "geometry": {
      "mesh": "{\"Color\":4278255360,\"Vertices\":[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],\"Faces\":[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]}"
    },
    "elementstate": {
      "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
    }
  }
}

...

Deck of Cards

id	bimGetFullObjectPropMesh

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

Optional query paramaters

Name

Type

Default value

Description

revision

int

null ( current )

If revision is specified, then the call will get the object from the requested revision, otherwise return current object ( latest revision ).

internal

boolean

false

false = return attributes in viewer format ( as seen in the portal ); true = return in different, internal server representation format.

children

boolean

false

false = return only properties of the object itself; true = return properties of the object and all its children

freeattributes

boolean

false

false = for each attribute return only name and value; true = return full definition for each object's attribute

disciplineId

Guid

null

Specifies the discipline ( layer ).

type

string

null

filter for requested element type. f.ex. if you use 'type=Wall', you will get a list of Walls, who are childs of the requested object_Id
this means, when you use

Code Block
{host}/v2/{slug}/objects/{objectId}?type=Column

you will get all Columns, who exist in the project

documentversion

int

0 (current)

If document version is specified and when document version is supported by object, e.g. actually only attachment can have document version,
then the call will get the result from the requested document version, otherwise return current object ( latest revision ).

To get free attributes of attachment for exact document version can be used freeattributes and documentversion

Code Block
{host}/v2/{slug}/objects/{objectId}?freeattributes=true&documentversion=1

In this case you will get free attributes of object for requested document version.

projectid

Guid

null

Specifies the project id.
Note:
This query parameter is mandatory in case when resource identification (object_id) represent the user.
If resource id represent user id and this query parameter is missing teh response will be not found.
Together with query parameter 'freeattributes' is possible to get detail info about user.

Code Block
{host}/v2/{slug}/objects/{objectId}?freeattributes=true&projectid={projectid}

The same query parameters must be used also in "PUT" version of this request.

Card

label	HTTP Method

GET

Card

label	Description

Gets the properties ( attributes ) of an object.

By using and combining the optional query parameters, the caller can shape the response to requested format ( see response for more description ).

If parameter is not used, its default value is used.

Note:

Following object-related api calls are now obsolete ( they are still supported, but will be removed eventually ), and should be replaced by using get object call with query parameters :

Obsolete call	Should be replaced by
GET /<teamslug>/objects/<object_id>/tree	GET /<teamslug>/objects/<object_id>?children=true
GET /<teamslug>/objects/<object_id>/internal	GET /<teamslug>/objects/<object_id>?internal=true
GET /<teamslug>/objects/<object_id>/properties/3	GET /<teamslug>/objects/<object_id>?children=true
GET /<teamslug>/objects/<object_id>/properties/8	GET /<teamslug>/objects/<object_id>?freeattributes=true

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response
lang	xml

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	In general, the response json has following format :

{
  "elementtyp": "<type_id>",
  "id": "<object_id>",
  "parent" : "<parent_id>",
  "type": "<type_name>",
  "layerid": "<discipline_id>",
  "attributes": {
    "<attribute_group_1": {
      "<property_name_1>": "<property_value>",
      "<property_name_2>": "<property_value>",
      "<property_name_3>": "<property_value>"
      ...
    },
    "<attribute_group_2": {
      "<property_name_1>": "<property_value>",
      "<property_name_2>": "<property_value>"
      ...
    },
    ....
  },
  "children" : []
}

if query parameter "children" is used, the property "children" will contain array of child objects in the same format as is the object itself.

Code Block

title	If query parameter "freeattributes" is used, the "property_value" contains full attribute definition in following format:

{
  "id": "<attribute_id>",
  "name": "<attribute_name>",
  "group": "<attribute_group>",
  "type": "<attribute_value_type>",
  "isInternal": <true or false>,
  "value": "<attribute_value>"
}

Examples:

Code Block

title	GET /<teamslug>/objects/<objectid>

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
  "parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element (default property set)": {
      "type": "Wall",
      "model": "Model A",
      "layer": "BuildingModel"
    },
    "general (default property set)": {
      "name": "Basic Wall:300_21_isolatie_208.5_spouwklein:4820766",
      "description": "Ifc Imported Element",
      "ifcglobaluniqueid": "2H$2pBsuL7TgKZ59zSDw0D",
      "ifcelementtype": "IfcWallStandardCase"
    },
    "content": {
      "tag": "4820766",
      "objecttype": "Basic Wall:300_21_isolatie_208.5_spouwklein:4296143",
      "skipparentlocations": "False",
      "extrudeprofiletype": "RectangleProfile",
      "polyeder area": "25,851 m²",
      "polyeder volume": "2,036 m³",
      "xdim": 5160.00000000001,
      "ydim": 208.5
    }
  },
  ...
}

Code Block

title	GET /<teamslug>/objects/<object_id>?freeattributes=true

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
  "parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element (default property set)": {
      "type": {
        "id": "a0e8ae2c-c869-4ec3-9019-25d3704be707",
        "name": "Type",
        "group": "Element (default Property set)",
        "subGroup": "Element",
        "type": "Guid",
        "value": "Wall"
      },
      "model": {
        "id": "cd320d7b-7299-4abc-8409-c86e46fa45f9",
        "name": "Model",
        "group": "Element (default Property set)",
        "subGroup": "Element",
        "type": "Guid",
        "value": "Model A"
      },
      "layer": {
        "id": "4812c68a-3f8d-40c1-b3f8-551a4102a406",
        "name": "Layer",
        "group": "Element (default Property set)",
        "subGroup": "Element",
        "type": "Guid",
        "value": "BuildingModel"
      }
    }
    ...
  }
}

Code Block

title	GET <teamslug>/objects/<object_id>?internal=true

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
  "parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element": {
      "isparent": true,
      "nr": 4,
      "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
      "logparentid": "b1570b15-2786-4c22-baf0-94e07de69990",
      "divisionid": "1b6fa8ae-568a-4bc0-81b7-c6d282834a0c",
      "materialstring": "ISR_Isolatie",
      "matrix": {
        "values": [
          1,
          0,
          0,
          120,
          0,
          1,
          0,
          -228.5,
          0,
          0,
          1,
          -70,
          0,
          0,
          0,
          1
        ]
      },
      "articleid": "0583a9a7-3756-48b9-b836-63541bdf130e",
      "materialsurfaceid": "058578b6-6a32-48f5-ae4a-59dc452de287",
      "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6"
    },
    "general": {
      "name": "Basic Wall:300_21_isolatie_208.5_spouwklein:4820766",
      "description": "Ifc Imported Element",
      "isobjectvalid": true
    },
    "elementstate": {
      "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
    },
    "objectlog": {
      "createdby": "e4d7ac3c-94f3-4507-9b8b-a1505225845c",
      "created": "2016-01-28T10:51:04.843",
      "modifiedby": "e4d7ac3c-94f3-4507-9b8b-a1505225845c",
      "modified": "2016-01-28T10:51:04.843",
      "revision": 0
    },
    ...
  }
}

...

Deck of Cards

id	bimObjectUpdate

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

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
slide	optional	object	Slide is one of the children of attributes which contains the scene object for saving the view of an object
scene	optional	object	A JSON string which includes viewMode(transparent or not), camera values & positions, related objects, clipping plane, topology & layer details. An example template is specified below. Please remember, the server will process the scene information as a json string and hence the client has to take care on the information that is stored & retrieved.

Code Block

title	An example scene template:

"scene": {
    "viewMode": "transparent",
    "camera": {
        "fov": 45,
        "position": {
            "x": 1231.4,
            "y": 234.3,
            "z": 3123.7
        },
        "quaternion": {
            "x": 0.9,
            "y": 0.7,
            "z": 0.7,
            "w": 0.23
        },
        "target": {
            "objectId": "<GUID>",
            "position": {
                "x": 1231.4,
                "y": 234.3,
                "z": 3123.7
            }
        }
    },
    "objects": {
        "selected": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9
        ],
        "transparent": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9
        ],
        "hidden": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9
        ]
    },
    "clippingPlane": {
        "axis": "x",
        "distance": -123.5,
        "selected": false
    },
    "topology": [
        [
            "<nodeId>",
            "<disciplineId>"
        ],
        [
            "<nodeId2>",
            "<disciplineId2>"
        ]
    ],
    "layers": [
        {
            "id": "<GUID>",
            "divisionTopologyId": "<GUID>",
            "visible": true,
            "transparent": false
        }
    ]
}

Card

label	HTTP Method

PUT

Card

label	Description

A view of an object could be generated by updating an object with a scene object. The generated view could be saved and the url can be shared between different users.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "id": "852fb78c-4d2d-4196-9f5d-647617749eed",
    "type": "Wall",
    "attributes": {
        "slide": {
            "scene": "{\"viewMode\":\"\",\"thumbnail\":\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALQAAABwCAYAAAC3tFqQAAAJF0lEQVR4Xu2bWWwbVRSGz4yXrI3TJqlEKGkpZQ0tdGNvmgohQKIIEEggIagqAYLn9gHx0AIvIPHGA5uQALELQYFSRAUkobS00AoKikoBsYSKltZO4ux27BnuuY4dx56kJomDOfe/kmNn7sx4/vN/c/37ztgiNFRAUAUsQVogBRUgAA0IRFUAQIuyE2IANBgQVQEALcpOiAHQYEBUBQC0KDshBkCDAVEVANCi7IQYAA0GRFUAQIuyE2IANBgQVQEALcpOiAHQYEBUBQC0KDshBkCDAVEVANCi7IQYAA0GRFUAQIuyE2IANBgQVQEALcpOiAHQYEBUBQC0KDshBkCDAVEVANCi7IQYAA0GRFUAQIuyE2IANBgQVQEALcpOiAHQYEBUBQC0KDshBkCDAVEVANCi7IQYAA0GRFUAQIuyE2IANBgQVQEALcpOiAHQYEBUBQC0KDshBkCDAVEVANCi7IQYAA0GRFUAQIuyE2IANBgQVQEALcpOiDEK6Peeuan1RJW1Ldf26ECcfj/R3z6yckEH913eP77O4V8i7c8+tu/RUkRlaWvjtq2bV7emj+3AfLedEtThdJxYf+WqMzLLJzv2gYDbvvWunSWpbbr1Ng5on89qyy3W4PAonYoM05JFNXl17Pw5QuQ6Gx5+an/7dItcjO3u2LzCXVYWpCtXnpG3+6++PU7N59ZRTXVwyre2LHf7xvsAdDH8mZN98ggtBeiHH1zDJ2YrgJ6IjpgRetN7N532I7Z5hNbXxaztXiP04NAoLayrpPjgKDUGAplVSnGEvn3LmrZzB0nrnQroPj9Rec3ko3SkzN3eWU46ZuW2l27dWVKfSIWOeGKA/uD5jXrEKlT4ZOvt/S1Ci5pqqKpiHGrPdY+OLT3fo3efWlanHrl9Kr0Qb8fLuT+7cV/YYxteR21T1+uj8wKK0ElapNahn5aO6t5Dh47r55qEN/CF1Ojm+z/8X7LxvzxoL0NmC2gekTlLp4E+mdxE5eUBsqwAJRIx8pFL5PNR7f7d1GMN0g+3rJtwOG48Rute2EVday+grssuzPTx8tpT/bR8xx69TfTMekqUndM7Ssne8r7oksWf76NQLDxxf0Nq8z+Jlh/aQ8l5C8i/Zr3en+UGaDg+TImkSw988bZeFpmfpH2rYvo1Z+h08xrBAXQhFfiP1ykW0G7tVqqsKlcUBWg0PkL+pILG9lH8o9epxz+SB7TTHaaWN/ZkgHYH+omCQeLn+cMKziyg/fOuIttfT05fmBp3vjgl0HXnXESBLKAHhgYo6Vp027tPA+gs9jBC55yIuSO0FbpH8ahGaDtAyUSc7GRcwW3T6Cefa6C7bhgfhXlXDO6Kt77TQEdXNOj/GWiKx6m2b4SaPv6Rum5UfY0N5Ks4nyx/Hbl9ETrzix1ECvgJ+1P/cwxp+uYI1S+7lBrOOjs1QjsWxRMJSjpEV7e/CaAlAv3MKxvbypyZZ+ijRyNUvbSGglUFZOh6VcncLMzF5Zzs1TdVTuY+bv9mfzknY4M617hxhuYvhJyhV6/On9Yr5MN08yZk6ELqVLR1ihU5aMEjVFFZNp6hHUWJihyx91/0jBw8Iq97+dPxyKGys248QkdjEyJHphgqKzd1HJkycvAI7V/TojdxKUAjw4M6cvi6H8+rKTJ00TCbux0XC+hiZuh/A3R2hnbJT0ODKaAD0ScBtMTIUTSgK66hgN9WsTmoMnRMZWg1NaZmOZy2P8hJHNN5OLu5aiRe/PavKj/X6wf/n25Wf1Bn6OgG1admObJbaH+YQj3hvP1xhg4dCNP8RVVkL1+c2SSpZjgSKkT7Ynszy8JjU84cOThucMMsx9wNqrP6TrOZobPnoa2yZSpupA7VVTN2Fv+xLXIO/6KXMbS5QNfu7dNZOLuPwWagQ9+HU8uzsnJiUI253ZYGOnd//EUx9DNPUKu3vWRZ5q1c9YVQH1M8dRzc6sfOHY4cnKG5IUPPKmZzt7OijdBFnLZLVyecrPp91e6DS6aah0bkKIwlTNvl1Cl32q6YGbo31MBjrJqH7qZLd3UWPA+NDD053ADaA2ietktfKXT9TSoyp8rEuVWlZ/3a6TymnyeLHOlYoaMGX1iZInLwfjiKeO0vHTnsRpWfs9INXyXkZie68tzFpe/CRvOSXmu2MvTfnRMvfZMC2h4D2lEQZV6rL4UaQPUFL7eF3lFwnpcPO6m55lCbyslqG3deKvAy7Lp9p/pUhu69XuXkgZNE1QtT/dFe4i+MnLntlambQ5LqsjefZHyCWR5Ap6ftOEcjQ5c0tt4Ht+Xo3dtaOqKtqpcfM2pzFTl6KlKHaS9InRA8D1023E2fPXBt5vjLux1aeDCu7+Wobr6Ykus26D5fxKFq2yG+j9vufiKzPs+B8+PA8fEPXsxyzAiH4m685cjdrWSTvkPHcq0JAK84PECh6Nhc1QwOwwvoYKhCX1hxhobVpepkapTc8Zq+sPLNnakbhtKNgbruud36wspPLc0asHTk4Asra9/s0Pd/eAHNI/SX96agTbeyHofWftBBtWc1E13BklXrc6k86HoC7fz9F33dN/5DhekCvaeltt11Xf1rlqcufLV9BiWd001LNkNPBa9XhWYL6IPVDlVVBqjydLePnuZ2T89L33zgs31ZPKsYXYvVTVSqWceGyD5wSr++qiE0LaAU0LnbaahLHfKSA/qhvbfn/eZvWo5go6JXYOjkiP5xQCn9GKDkgC66C3gD0RUA0KLtNU8cgDbPc9GKAbRoe80TB6DN81y0YgAt2l7zxAFo8zwXrRhAi7bXPHEA2jzPRSsG0KLtNU8cgDbPc9GKAbRoe80TB6DN81y0YgAt2l7zxAFo8zwXrRhAi7bXPHEA2jzPRSsG0KLtNU8cgDbPc9GKAbRoe80TB6DN81y0YgAt2l7zxAFo8zwXrRhAi7bXPHEA2jzPRSsG0KLtNU8cgDbPc9GKAbRoe80TB6DN81y0YgAt2l7zxAFo8zwXrRhAi7bXPHEA2jzPRSsG0KLtNU8cgDbPc9GKAbRoe80TB6DN81y0YgAt2l7zxAFo8zwXrRhAi7bXPHEA2jzPRSsG0KLtNU8cgDbPc9GKAbRoe80TB6DN81y04n8AFGPHnvj28LgAAAAASUVORK5CYII=\",\"viewBox\":{\"position\":[41100.200000000004,10500,-53363.100000000006],\"size\":[110887.30000000002,21600,114908]},\"camera\":{\"fov\":45,\"position\":[41100.200000000004,10500.000000000011,141787.79481218164],\"euler\":[-5.720026065953601e-17,0,0,\"XYZ\"],\"target\":[41100.200000000004,10500,-53363.100000000006]},\"objects\":{\"selected\":[\"852fb78c-4d2d-4196-9f5d-647617749eed\"],\"highlighted\":[],\"highlightedSelected\":[],\"transparent\":[]},\"clippingPlane\":null,\"topology\":[{\"id\":\"af938b96-fc92-488c-aa22-1bbfe9970fd7\",\"divisionTopologyId\":\"2643ad38-84cc-47d4-8f1b-43ab8ac471db\",\"visible\":true},{\"id\":\"d05aaefd-acc2-44b5-9df8-a45413ac3359\",\"divisionTopologyId\":\"2643ad38-84cc-47d4-8f1b-43ab8ac471db\",\"visible\":true},{\"id\":\"c4aa6b72-096e-4f26-ad3f-f91b85ff3285\",\"divisionTopologyId\":\"2643ad38-84cc-47d4-8f1b-43ab8ac471db\",\"visible\":true},{\"id\":\"3bb594d9-2af8-4602-b261-bc5429bc3e9e\",\"divisionTopologyId\":\"2643ad38-84cc-47d4-8f1b-43ab8ac471db\",\"visible\":true},{\"id\":\"68e38c99-4eca-425f-bf7a-7c51e47eaac0\",\"divisionTopologyId\":\"2643ad38-84cc-47d4-8f1b-43ab8ac471db\",\"visible\":true}],\"layers\":[{\"id\":\"0f106af0-a919-44c5-b211-15bd5ef620b6\",\"divisionId\":\"9400f4b8-16b5-4b8f-a3e1-c1deb9ae7a9b\",\"divisionTopologyId\":\"2643ad38-84cc-47d4-8f1b-43ab8ac471db\",\"visible\":true,\"opaque\":true,\"opacity\":0.1,\"divisionName\":\"Model1\",\"name\":\"Building\",\"revisions\":[]},{\"id\":\"09e623d4-1e12-4a77-b358-ea1d0b28e4a7\",\"divisionId\":\"9400f4b8-16b5-4b8f-a3e1-c1deb9ae7a9b\",\"divisionTopologyId\":\"2643ad38-84cc-47d4-8f1b-43ab8ac471db\",\"visible\":false,\"opaque\":true,\"opacity\":0.1,\"divisionName\":\"Model1\",\"name\":\"Room\",\"revisions\":[]}]}"
        }
    }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Deck of Cards

id	bimObjectUpdate

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

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	HTTP Method

PUT

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

title	JSON

{
  "parent": "925f9e2d-8877-406b-9806-afb4246ed2e2",
  "type": "Wall",
  "attributes": {
    "element": {
      "isparent": false,
      "nr": 0,
      "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
      "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
      "divisionid": "e7859a8f-4b7a-4263-8420-405d565377aa"
    },
    "general": {
      "name": "Brickwall",
      "isobjectvalid": true
    },
    "quantity": {
      "width": 115
    },
    "geometry": {
      "mesh": "{\"Color\":4278255360,\"Vertices\":[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],\"Faces\":[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

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "33c741c1-f03e-4c47-b072-de8637f8f340",
  "parent": "925f9e2d-8877-406b-9806-afb4246ed2e2",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element": {
      "isparent": false,
      "nr": 0,
      "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
      "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
      "divisionid": "e7859a8f-4b7a-4263-8420-405d565377aa",
      "logparentid": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a"
    },
    "general": {
      "name": "Brickwall",
      "isobjectvalid": true
    },
    "quantity": {
      "width": 115
    },
    "geometry": {
      "mesh": "{\"Color\":4278255360,\"Vertices\":[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],\"Faces\":[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]}"
    },
    "elementstate": {
      "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
    }
  }
}

...

Deck of Cards

id	bimCreateCommentForObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Example: https://api-stage.bimplus.net/v2//objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string(guid)	The id of the issue
text	mandatory	string	The comment text
createdAt	will be ignored	string (date)	Creation date of the comment
modifiedAt	will be ignored	string (date)	Modified date of the comment
author	will be ignored	object	The author of the comment

Card

label	HTTP Method

POST

Card

label	Description

Create a new comment for a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

...

Deck of Cards

id	bimObjCreateHyperlink

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>hyperlinks

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/hyperlinks

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/hyperlinks

JSON Structure:

Name	Mandatory / Optional	Type	Description
orderNumber	will be ignored	integer	The ordering number of the hyperlink
name	mandatory	string	Name of the hyperlink
url	mandatory	string	The actual url
id	will be ignored	string (guid)	Id of the hyperlink
type	optional	string	Hyperlink type. Could be either none - link to web site, or "Attachment" - link to download url

Card

label	HTTP Method

POST

Card

label	Description

Create a new hyperlink for the object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "My website",
    "url": https://www.bimplus.net/
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "e72e6ddd-63f4-40a3-b820-a32300e14c31"
}

...

Deck of Cards

id	bimObjDelete

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	createCustomTableForObject
	createCustomTableForObject

Create a new custom table in the object

Deck of Cards

id	bimCreateCustomTableForObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/customtables

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/customtables

Example: https://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/customtables

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string(guid)	The id of the issue
text	mandatory	string	The comment text
createdAt	will be ignored	string (date)	Creation date of the comment
modifiedAt	will be ignored	string (date)	Modified date of the comment
author	will be ignored	object	The author of the comment

Card

label	HTTP Method

POST

Card

label	Description

Create a new comment for a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

Anchor

	getCommentsOfObject
	getCommentsOfObject

Get all the comments of the object

Deck of Cards

id	bimGetAllCommentsOfObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Example: https://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Card

label	HTTP Method

GET

Card

label	Description

Get all the comments of a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",
        "modifiedAt": "2013-07-03T13:26:18+00:00",
        "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
        "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
    }
]

Anchor

	deleteCommentsOfObject
	deleteCommentsOfObject

Delete all the comments of the object

Deck of Cards

id	bimDeleteCommentOfObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Example: https://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the comments from the issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 31

New Version 32

Key

Object Service

Create a new custom table in the object

Get all the comments of the object

Delete all the comments of the object