geometry



Object Service


Object Service


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

Please see the detailed structure of the issue in the Object Model

Create a new object


Resource: objects 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects

JSON Structure:

Name

Mandatory / Optional

Type

Description

parent

mandatory

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



 POST


 Creates a new object



Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/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]}"
    }
  }
}




Status: 201 Created


{
  "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"
    }
  }
}




Get the object details


Resource: objects/<object_id> 

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

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


Optional query parameters

NameTypeDefault valueDescription
revisionintnull ( current )If revision is specified, then the call will get the object from the requested revision, otherwise return current object ( latest revision ).
internalbooleanfalsefalse = return attributes in viewer format ( as seen in the portal ); true = return in different, internal server representation format.
childrenbooleanfalsefalse = return only properties of the object itself; true = return properties of the object and all its children
freeattributesbooleanfalsefalse = for each attribute return only name and value; true = return full definition for each object's attribute
disciplineIdGuidnullSpecifies the discipline ( layer ).
typestringnull

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

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

you will get all Columns, who exist in the project

documentversionint0 (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

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

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

projectidGuidnull

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.

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

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

shortinfobooleanfalsetrue = return results without attributes and without localizedAttributeGroups ( query can be set on true just when object_id is ID of selection objects ).



 GET


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 callShould be replaced by
GET /<teamslug>/objects/<object_id>/treeGET /<teamslug>/objects/<object_id>?children=true
GET /<teamslug>/objects/<object_id>/internalGET /<teamslug>/objects/<object_id>?internal=true
GET /<teamslug>/objects/<object_id>/properties/3GET /<teamslug>/objects/<object_id>?children=true
GET /<teamslug>/objects/<object_id>/properties/8GET /<teamslug>/objects/<object_id>?freeattributes=true




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




Status: 200 OK


{
  "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 of child objects in the same format as is the object itself.


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


Examples:

{
  "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
    }
  },
  ...
}


{
  "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"
      }
    }
    ...
  }
}


{
  "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
    },
    ...
  }
}




Generate, save & share the view of an object


Resource: objects/<object_id> 

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

Examplehttps://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

slideoptionalobjectSlide is one of the children of attributes which contains the scene object for saving the view of an object
sceneoptionalobject

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.


"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
        }
    ]
}



 PUT


 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.



Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/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\":[]}]}"
        }
    }
}




Status: 200 OK



Check whether an object has been updated (See only the header info)


Resource: objects/<object_id>

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

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


 HEAD


Check whether an object has been modified by seeing an object's ETag by reading only the header information of an object.



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

If-None-Match:"ca85a1f3-1a37-4f6d-bf1e-d0af96357774"




Status: 304 Not Modified - if not changed

or Status: 200 OK - if changed


ETag: "ca85a1f3-1a37-4f6d-bf1e-d0af96357774"



Get the object tree with full property list without geometry (object topology tree)


Resource: objects/<object_id>/topology 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/topology

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


 GET


 Get the object tree with full property list without geometry.



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




Status: 200 OK


{
    "ifcId": "1o1vYcpcH5KRRKl5voLOXN",
    "ifcType": "IfcBuilding",
    "parent": null,
    "name": "Brickwall",
    "type": "Project",
    "children": [],
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75"
}



Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"


Resource: objects/<object_id>/geometries/threejs 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/threejs

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/threejs

Please see the Templates & Chunk  section for improving the performance of geometry calls



 GET


 Get the optimized objects tree with selected property list whose geometry type is "ThreeJS". Please see the Templates & Chunk  section for improving the performance of geometry calls



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




Status: 200 OK


{
    "elementsCount": 1,
    "faceCount": 6,
    "verticesCount": 24,
    "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 object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"


Resource: objects/<object_id>/geometries/meshblob 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/meshblob

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/meshblob


Optional query parameters

NameTypeDefault valueDescription
elementTypeIdguidnull ( current )filter for requested element type. Get objects just with specified element type id.



 GET


 Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)".



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




Status: 200 OK


{
    "elementsCount": 1,
    "objects": [
        {
            "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
            "parent": "00000000-0000-0000-0000-000000000000",
            "type": "Wall",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW3PbRBTWylIsuUmctml6T900t7aua+eetiHOndAQDLS8pBnhyzYVUeQiyR0cGJ545y9QGB54YYY3HvkXPPetQLlDuV/2E7uqiEfUMzRDkWc/zfl0tHvO2XPOWhKRJOkPduGOq1VmcLVQmPE8xywVzLJXc+iV+k06nE69QB3XrNpTQ9lcLpPNjExmxzIjufHRbDo1V7OgOGXTmucUrXSqUCtZZvkyrV+pblJ7yq5Zloo10qt0i3pu+QbdzKxe9UxrxSw5RaeemZstunTBYk9tr1C16rRCnTh7Qb1ZNW1PoZUNqlwvlqm2ZTxXrJg1t33LmKV2xbQ3nKplUcVjRsrL87FYTFGU2G3yfN316FZmDg/LHrPbzSxRmzpmObNiut6LubW1SFsCO9jSzJfdiMb6+luPwsQFFpfH28JFtmm7ZmFP5OrVmu3NOE6xjoRuUq03Sk0kJMyG4h4el6WaWYGsxwAKQGWQSKg/s5pqajoURfxW0apRw5A0TBbrkCTlJ/Z+eJU97IFsFGWjJBtl2ajIBpWN67KxIRs3ZMOUjZdkY1N6cGnxuMwvacelwNj/QX3AzBbDZEa6quGa21Qzbv01Jwv0QFO2ra3De03TNXbr4EPBPj3+xfeP7vc3Y1rgvc5uh/hQ1Efl/a4W9r/zHqYF3idQkXzEkQgSEZnQ11QW+RWOAtRbAW2AdkASgIn0vYB9gP2ATsABQBfgIADB1w8DjsAQXRiSgiGRrSK8n74dRwHHAMcB3YATAMyjnwT0AE4BegF9gH7AAGAQcBpwBnAWkAacA2QA5wFZQA4wxKBNiyf+FrqHWow98C0eBowARgFjgHHABGAScAFwEXAJa7WoiHZzm4NEIa+QOtlGxrS0YMn7g9felEsf5F+eSnz8zkfX8q92vr90Z/uNaYL9w9T3nv2wW5Xea1Ro26EgHgQK7VxBLNGgkAzP0PV2o0LHDoUGG/ZyBUE0KOzbodCwxP4dRooZ/CVfezdPOiO8CBQORCwRKHRFGBkoHIxw05eP3c6TQxF7ESgcjtiLQOFIRKiFgopaabqy1BLdMO0Y+0uJriHzXPfvKLejXPDz7TgnIOA0Id2cUPhr5AQn0G1bQKQ4AQH/a8lJTkBAVyI9nND4a+QUJ9AqUHyklxMJ7jjp4wQE5Dbp50Qrf40MhAzz5xgMTepbejpkGNKfnOEEBKQ7OcuJdhGPdGgV35dzITt8XzKhAKEiyHlOQEAFkCwnOoS3udCyvsZQ6BUsrQ43s51oO/BLxReDG3u9iYOOqyzb3vBQOrXllquOZZYeHGIj7ARjv4cfXaXx8eJoeXQsNzk8QrMTk+v+EaRPwRs0QL8TPgFpVEjTkMaElIc0LqQZSBNCmoU0KaQ5SBeENA/popAWIF0S0iJ2Hyb8x6GIPtHjKDhNX+Jp6tcQogSj9SfD7LRgl8NsXrBPhdkZwV7mSekn5qxgV8K6c4J9Oqw7L9jVsO6CYJ8Js4uCLYTYpHBJE61ENIykcEsTDUK0gaRwTRNlL4o7KdzTfmUfByiTH9gdlZEMXMRnhygxnCP4tP+Gje/YwLGRFG5r+MD4go3v2cB5kQxc/40xOCBwBqDN/8jkz9m4z8a3mF+EQ0OP/4wxaOVf4YkIifYJk75m4xc2PsUTERbtLpPusfE7G1/iI+dPBQ0gCIMQAAA=",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        }
    ]
}



Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer


Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/threejs

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/bded6990-b08b-4a27-a8bc-55c87ef2a8f8/disciplines/ac21b9a1-8853-4658-9fbf-0cf62340bd18/geometries/threejs

Please see the Templates & Chunk section for improving the performance of geometry calls


 GET


 Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer. Please see the Templates & Chunk  section for improving the performance of geometry calls



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




Status: 200 OK


{
    "elementsCount": 4,
    "faceCount": 154,
    "verticesCount": 24, 
	"viewbox": {
        "x": 4067.5,
        "y": -480,
        "z": -4652.5,
        "width": 9775,
        "height": 600,
        "depth": 9695
    },
    "colors": [
        -4272966
    ],
    "objects": [
        {
            "id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
            "parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            8955,
                            -780,
                            -9580,
                            -820,
                            -780,
                            -9580,
                            -820,
                            -780,
                            -9500,
                            8955,
                            -780,
                            -9500,
                            8955,
                            -180,
                            -9580,
                            -820,
                            -180,
                            -9580,
                            -820,
                            -180,
                            -9500,
                            8955,
                            -180,
                            -9500
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9775,
                    "width": 80,
                    "height": 600,
                    "volume": 469200000.0000012,
                    "area": 5865000.000000014
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
            "parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            -820,
                            -780,
                            -9500,
                            -820,
                            -780,
                            115,
                            -740,
                            -780,
                            115,
                            -740,
                            -780,
                            -9500,
                            -820,
                            -180,
                            -9500,
                            -820,
                            -180,
                            115,
                            -740,
                            -180,
                            115,
                            -740,
                            -180,
                            -9500
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9615,
                    "width": 80,
                    "height": 600,
                    "volume": 461520000.0000002,
                    "area": 5769000.000000003
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
            "parent": "b62c83db-69ea-485b-9315-26826110e578",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            -820,
                            -780,
                            195,
                            8875,
                            -780,
                            195,
                            8875,
                            -780,
                            115,
                            -820,
                            -780,
                            115,
                            -820,
                            -180,
                            195,
                            8875,
                            -180,
                            195,
                            8875,
                            -180,
                            115,
                            -820,
                            -180,
                            115
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9695,
                    "width": 80,
                    "height": 600,
                    "volume": 465359999.99999976,
                    "area": 5816999.999999998
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
            "parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            8955,
                            -780,
                            195,
                            8955,
                            -780,
                            -9500,
                            8875,
                            -780,
                            -9500,
                            8875,
                            -780,
                            195,
                            8955,
                            -180,
                            195,
                            8955,
                            -180,
                            -9500,
                            8875,
                            -180,
                            -9500,
                            8875,
                            -180,
                            195
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9695,
                    "width": 80,
                    "height": 600,
                    "volume": 465360000.00000006,
                    "area": 5817000
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        }
    ]
}



Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer


Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/bded6990-b08b-4a27-a8bc-55c87ef2a8f8/disciplines/ac21b9a1-8853-4658-9fbf-0cf62340bd18/geometries/meshblob


 GET


 Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer.



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




Status: 200 OK


{
    "elementsCount": 4,
    "objects": [
        {
            "id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
            "parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVX624TRxTe2Yu9TkocIIQ7mDSXtpgljh0gldIGXBqhRsiCwJ/Imq7XQ9hmvaZ7QXUqFbXqg7Tq/z5DpT5Ef/cdeuXSdr7tjNkaOazURIGN5tucM2fnfOfsOTNrhSiK8je/cMf1hsrhTqNxNYoCt9VwnSgO2HrvAauWS3dZELpdf3lhvlKx5q3alUuLVqVaW+JT9diD4bLP4iiwvXKpEbc81/mI9da7W8xf9mPPM+CjfJN1WBQ699mWdfNO5Hprbiuwg55Vv2aH7LrHZ/2o0fV6rM2CPH/AeNB1/Uhn7U2m37MdZnboLbvtxuFYh15jftv1N4Ou5zE94iTVGx9omqbruvYtud0LI9ax6ph0Is47tFaZzwLXsdbcMPq4srExlEufB3fNY9mLbDSb3+wGxes8L682ww/5S9szhlNDvXdjP7oaBHYPBZ3RbHqYmSxI0IbhqMjLauy2IRc0gA4wADkOI8afvK8yLYnGyD+0vZhRqphYUBtXFP0P/nza0yifUKmt0pZKHZW2VcpUek+lmyq9r1JXpZ+odEt5fpn5vCouZeDSQfg16BHQzFGXkwwNGrrbzKQP/12TJ3suE7eNJqI3zUIBNzF0vKtXvwF3DH82C7V+9CPY3MXQjd2Kfk+b+/9FD2r96NE6OTGMXPYdodChiYIF/Ny5iw4NNe2LDIkTJjf8qLpQLnVCpxt4but5Umo8I/zv5aloXb5sLzqLlypL1Rqbv7LUbD7K7v42Px09tsv+k7ygjAoHsG+hrRQi+2omU08mS4wBioBxwEHAIcBhwATgCByMSAcw04duqOmqT9afBBwFHAMcB5wAnAScApwGnAGcBZQA5zgc0POj/wnrpV5RbYnXKcCbgGnADGAWMId1VR2J2+cCGt5XeTSLWXgLIcuBl7zfJbcj41HO+O0UYwOFla0OsS75jPTINhzkcniDn098v/rl0R9XPl0e+ek7ZX0F8s/bX79PUKpjwgCKFwzGBwwG7+RgygAuXjA4NGAgXWB64oevVsjhIRz6BhNDOPQNjgzhIA2MyZ0+hAabzGixTdfX+Hc4KkcVbwBtQ9B5k0LABDkmFMn3DRTHhUKTj50QCkO0HTkpFBDwY4CcEoq82MvJaaHIicfImZTbRHE25TZ5pJRymyx6Tih04cmYypICdHziBD9Nwv0+FJK95x1Eg70n2YTOQ5qWUhnSjJQuQJqVkgVpTkoXORTlFmDix+FffDzj4ykfRdlqfIN8r64oa3y8y8ejOoH75FyYT3UjOS+1lbS2LLULae0Fqa2mtZbU1tLai1K7mNIWpWtTlp0srqJ0bxqiEPLidRclhSRWLPmE339HrJKGiQzgoMMn+W+YkVRM5AUnFD72f8WMpGMiWzhFHvP7L/j/H73mm6ltDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAICF61G4/o3CQAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
            "parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TiAOEFLumDSXtpgljh0gSGkDhkaoEbJK4CWypuv1ELZZr+leUJ1KoFb9IUW88xuqvvQn9Ln/ofcbnW87Y5YUh5WaKHSj+SbnzNk535w5Z2atEEVRnvEHPZ59KofbjcaVKArcVsN1ojhgq737rFou3WFB6Hb9xbnZSsWatWqXLsxblWptgQ/VYw+Giz6Lo8D2yqVG3PJc5wPWW+1uMH/Rjz3PgI/yTdZhUejcYxvWzduR6624rcAOelb9qh2y6x4f9aNG1+uxNgvy/AXjftf1I52115l+13aY2aEf2m03Dkc69Crz266/HnQ9j+kRJ6neuKZpmq7r2mNyqxdGrGPVMehEnHdoLTOfBa5jrbhh9FFlbW0glz4P7pqvZTei0Wx+tRMUr/O4vN4M3+ebtmsMJwZ678Z+dCUI7B4SOqPZ5CAzmZCgDcNhEZfl2G1DLmgAHWAAchyGjF95XWWaEoWRf2B7MaNUMTGhNqoo+i/8/bSnYT6gUlulLZU6Km2rlKn0rkrXVXpPpa5KP1bphvL8MfN5VTzKlkcH4f9BjYBmjrqcZGjQ0N1kJn3wz5w82DOZuK01sXrTLBTQiaZjr17/Atx2+dNZqPVXP4TDXTTd2KnV72px/7fVg1p/9SidnGhGLvuJUOjQRMECfu/cQYWGmvYwQ+CEyQ0/qs6VS53Q6Qae23oelBqPCP97dShaFy/a8878hcpCtcZmLy00m4+yu7/Fb0eP7bD/JC5Io8J+nFsoK4XIuprKVJPJFCOAImAUcABwEHAIMAY4DAdD0gHM9IEHajrrk/nHAW8AjgCOAo4BjgNOAE4CTgFOA0qAMxz26/nhF5b1Sq/ItsTrBOBNwCRgCjANmMG8qo7A7XECDa6rPIrFLLyFJcuGTd7rlNuW8TBn/HaKsYHEypaHmJd8SnpkEw5yOezgZ2NPl7/f/PI99J9/+82SlAlSdWSLQbono8Lgk8Wh754oq0v/MjjwEoMXXBx8iQsYQBr7+oslcmgAh77B2AAOfYPDAzhIA2N8uw+hrUVmtNi662v8OxyZo4odQNkQVN64EDBAjghF8n0DxVGh0ORrx4TCEGVHjgsFBPwYICeEIi/OcnJSKHLiNXIq5TZRnE65TV4ppdwmk54RCl14MiayhAAVnzjBT5Nwry+F5Ox5B6vB2ZMcQmchTUqpDGlKSucgTUvJgjQjpfMcivIIMPHj8C/e/uTtD96KstT4AfluXVFWeLvM26M6gfvkXphNVSM5K7WVtLYstXNp7Tmpraa1ltTW0trzUjuf0hala1OmnUyuonRvGiIR8mK7i5JCslZM+Tvvf8ZaJQ0TEcBFh0/ynzAiqZiIC24ofOz/iBFJx0S0cIv8xvsf8P/f/WbD220PAAA=",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACA/kbhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAAPwrXo8BcwAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
            "parent": "b62c83db-69ea-485b-9315-26826110e578",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TkocIIQ7mJBLC2aJYwdIpbSASyNEhKwSeIms6Xo9hCXrNewF1alU1Ko/pFXf+xuq/ok+9xf0pff7fMuMWYwcVmqi0I3mm8yZs3O+c+acmbVCFEX5hz/o8byhcrjbaFyLosBtNVwnigO21nvEquXSPRaEbtdfXpivVKx5q3bl0qJVqdaW+FQ99qC47LM4CmyvXGrELc91brHeWneT+ct+7HkGbJRvsw6LQucB27Ru341cb9VtBXbQs+rX7ZDd8PisHzW6Xo+1WZDnLxiPuq4f6ay9wfT7tsPMDv3AbrtxONah15nfdv2NoOt5TI84SfXme5qm6bqufUnu9MKIdaw6Jp2I8w6tFeazwHWsVTeMPqysrw/l0ufBTXNfdiMazeYXO0HxBo/L683wfb5pu8Zwaqj1buxH14LA7iGhM6pND1OTCQnaUBwVcVmJ3TbGBQ2gAwxAjsOI8Ruvq0xLojDyT2wvZpQqJhbUxhVF/5W/n7Y0yidUaqu0pVJHpW2VMpXeV+mGSh+o1FXpQ5VuKs8fM59XxaMMPDoI/w9qBDRz1OUkQ4OG7hYz6ZNna/Jgz2Xitt6E96ZZKKATTcdevf4FuK37s1mo9b0fweEumm7slPe7Wtz/zXtQ63uP0smJZuSynwiFDk0ELOD3zj1UaKhpn2QInFC56UfVhXKpEzrdwHNbz4NS4xHhf68ORevyZXvRWbxUWarW2PyVpWbzaXbzd/jt6LEdtp/EBWlU2IdzC2WlEFlXM5lqMlliDFAEjAP2Aw4ADgImAIdgYEQagJo+9EBNZ32y/iTgMOAI4CjgGOA44ATgJOAU4DSgBDjDYZ+eH33BrVdaRbYlVqcAZwHTgBnALGAO66o6ArfHCTS8rvIoFrPwJlyWDZu81ym3LeNRzvitFGMDiZUtD7Eu+Yj0yBYM5HLYwY8nvl75fuvzdwd7glQdEwqf/vDt1ZcUxgcUHi+PfPeVstZXJPtTChC8pHBgQEH2wIlvPrtKDg7h0FeYGMKhr3BoCAepYExu9yE0WGRGi224vsa/w5E5qtgBlA1B5U2KASbIESFIvm8gOCoEmnztmBAYouzIcSHAAD8GyAkhyIuznJwUgpx4jZxKmU0Ep1Nmk1dKKbPJomeEQBeWjKksIUDFJ0bw0yTc60shOXvOwRucPckhdB6jaTkqYzQjRxcwmpUjC6M5ObrIoSiPABM/Dv/m7S/e/uStKEuNH5Dv1BVllbe3eXtaJzCf3AvzqWok56W0kpaWpXQhLb0gpdW01JLSWlp6UUoXU9KiNG3KtJPJVZTmTUMkQl5sd1FSSHzFkn/w/hf4KmmYiAAuOnyS/4wZScVEXHBD4WP/J8xIOiaihVvkd97/iP//BRHHAGFtDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIB5H4XrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
            "parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTeq71OShwghDuYNJcWzBLHDpBKaQGXRqgRskrgJbKm6/UQhqzXsBdUp1JRq/6QVn3vb6j6J/rcX9CXtrTQFubbzphNhMNKTRS60XybOXNmznfOnDOzVlRFUZ7zB288b2kcbjcaV6MoYK0Gc6M4oCu9B7RaLt2hQci6/uLcbKViz9q1yxfn7Uq1tsCH6rEHxUWfxlHgeOVSI255zP2Y9la669Rf9GPPM2GjfJN2aBS69+i6ffN2xLxl1gqcoGfXrzkhve7xUT9qdL0ebdMgzyeYD7rMjwzaXqPGXcelVod84rRZHI50yDXqt5m/FnQ9jxoRJ6nd+FDXdcMw9G/VW70woh27jkE34rxDe4n6NGCuvczC6NPK6upALn0e3DT3ZTei0Wx+sxMUr/O4vNkMP+KbtmsMJwZa78Z+dDUInB4SOqPa5CA1mZCgDcVhEZelmLXRL+gAA2ACchyGzD95XWVaEoWRf+R4MSVEsbCgPqooxh98ftrSMB/QiKORlkZcjbQ1QjVyVyNrGrmnEaaR+xpZV14+Vj6viUfZ8hgg/D+oEdDMEcZJhiYJ2Qa1yKN/1+TBnsnEbbUJ7y2rUMBLNAN79eYX4LbuT2eh1vd+CIe7aIa5U97vanH/N+9Bre89SicnmpnLfiIUOiQR0IDfO3dQoaGuf5EhcELlhh9V58qlTuh2A4+1XgalxiPC/14fitalS868O3+xslCt0dnLC83m4+zmb/Hb0aM7bD+JC9KosA/nFspKUWVdTWWqyWSJEUARMArYDzgAOAgYAxyCgSFpAGrGwAM1nfXJ+uOAw4AjgKOAY4DjgBOAk4BTgNOAEuAMh31GfniTW6+1imxLrE4A3gZMAqYA04AZrKsZCNweJ9DgusqjWKzCO3BZNmzyXqfctoyHOeN3U4xNJFa2PMS66mdqT92AgVwOO/hwcein75SVK5+Pfb/088bXH8i3ilQd2aLw5S8/9hXVUaGQnrlJYf8rFDaZOPAKExgAjv3w1RX14AAOfYWxARz6CocGcJAK5vh2H0Jbi8xs0TXm6/w7HJmjiR1A2aiovHHRwYB6RAiS7xsIjgqBLqcdEwJTlJ16XAjQwY8B9YQQ5MVZrp4UgpyYpp5KmU0Ep1NmkymllNlk0TNCYAhL5kSWEKDiEyP4aRLu9aWQnD1n4Q3OnuQQOofepOyV0ZuSvfPoTcuejd6M7F3gUJRHgIUfh//w9jdvf/FWlKXGD8j364qyzNt7vD2uqzCf3AuzqWpUz0lpJS0tS+lcWnpeSqtpqS2ltbT0gpTOp6RFadqSaSeTqyjNW6ZIhLzY7qKkkPiKJZ/x9xP4KmlYiAAuOnyS/44RScVCXHBD4WP/N4xIOhaihVvkKX//iv9fAChNaqptDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAkOtRuH5VwUAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIDAHoXrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        }
    ]
}



Get the different properties / structure(normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations


Resource: objects/<object_id>/geometries/threejs/properties/{props} 

where props is a binary sum of following possible values :

1 : show objects as hierarchical tree ( default (/geometries/threejs or /geometries/threejs/properties/0 will give the object details in a flat structure))
2 : show also viewer attributes
4 : include FACE_NORMAL
8 : with templates
16: mixed geometry

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/threejs/properties/{props}

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/a17ff78a-8b42-4523-9bf7-283e725e3e95/geometries/threejs/properties/7 (i.e 7 gives you a combination of objects as tree(1) + viewer attributes(2) + face normal(4))


 GET


Get the different properties / structure (normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations.

url: /geometries/threejs/properties/{props}

where props is a binary sum of following possible values :

1 : show objects as hierarchical tree ( default (/geometries/threejs or /geometries/threejs/properties/0 will give the object details in a flat structure))
2 : show also viewer attributes
4 : include FACE_NORMAL
8 : with templates
16: mixed geometry

You can also combine different property numbers

eg: geometries/threejs/properties/5 should give both the show objects as tree(1) + add FACE_NORMAL in threeJs json(4)

geometries/threejs/properties/7 should give you a combination of objects as tree(1) + viewer attributes(2) + face normal(4)



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




Status: 200 OK


{
    "elementsCount": 1,
    "faceCount": 88,
    "viewbox": {
        "x": 21000,
        "y": 2850,
        "z": -19000,
        "width": 133,
        "height": 5700,
        "depth": 140
    },
    "colors": [
        4278190080
    ],
    "objects": [
        {
            "id": "a17ff78a-8b42-4523-9bf7-283e725e3e95",
            "type": "Column",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            0,
                            2,
                            1,
                            0,
                            0,
                            4,
                            0,
                            3,
                            0,
                            7,
                            6,
                            5,
                            0,
                            8,
                            5,
                            6,
                            0,
                            9,
                            5,
                            8,
                            0,
                            10,
                            9,
                            8,
                            0,
                            13,
                            12,
                            11,
                            0,
                            16,
                            15,
                            14,
                            0,
                            17,
                            14,
                            15,
                            0,
                            18,
                            14,
                            17,
                            0,
                            19,
                            18,
                            17,
                            0,
                            7,
                            15,
                            6,
                            0,
                            16,
                            6,
                            15,
                            0,
                            7,
                            5,
                            15,
                            0,
                            17,
                            15,
                            5,
                            0,
                            17,
                            5,
                            19,
                            0,
                            9,
                            19,
                            5,
                            0,
                            2,
                            11,
                            1,
                            0,
                            2,
                            0,
                            11,
                            0,
                            13,
                            11,
                            0,
                            0,
                            13,
                            0,
                            12,
                            0,
                            4,
                            12,
                            0,
                            0,
                            4,
                            3,
                            12,
                            0,
                            20,
                            12,
                            3,
                            0,
                            18,
                            10,
                            14,
                            0,
                            8,
                            14,
                            10,
                            0,
                            8,
                            6,
                            14,
                            0,
                            16,
                            14,
                            6,
                            0,
                            0,
                            1,
                            21,
                            0,
                            21,
                            3,
                            0,
                            0,
                            1,
                            11,
                            22,
                            0,
                            22,
                            11,
                            12,
                            0,
                            12,
                            20,
                            23,
                            0,
                            3,
                            21,
                            23,
                            0,
                            23,
                            22,
                            12,
                            0,
                            23,
                            20,
                            3,
                            0,
                            26,
                            25,
                            24,
                            0,
                            24,
                            27,
                            26,
                            0,
                            25,
                            26,
                            28,
                            0,
                            31,
                            30,
                            29,
                            0,
                            32,
                            31,
                            29,
                            0,
                            35,
                            34,
                            33,
                            0,
                            32,
                            29,
                            36,
                            0,
                            38,
                            36,
                            37,
                            0,
                            36,
                            38,
                            32,
                            0,
                            39,
                            10,
                            18,
                            0,
                            24,
                            41,
                            40,
                            0,
                            42,
                            19,
                            9,
                            0,
                            43,
                            30,
                            37,
                            0,
                            36,
                            26,
                            27,
                            0,
                            37,
                            27,
                            43,
                            0,
                            27,
                            37,
                            36,
                            0,
                            26,
                            36,
                            29,
                            0,
                            30,
                            43,
                            28,
                            0,
                            29,
                            28,
                            26,
                            0,
                            28,
                            29,
                            30,
                            0,
                            24,
                            40,
                            43,
                            0,
                            43,
                            27,
                            24,
                            0,
                            33,
                            34,
                            39,
                            0,
                            39,
                            34,
                            44,
                            0,
                            45,
                            34,
                            35,
                            0,
                            38,
                            23,
                            21,
                            0,
                            21,
                            32,
                            38,
                            0,
                            21,
                            1,
                            31,
                            0,
                            31,
                            1,
                            22,
                            0,
                            31,
                            32,
                            21,
                            0,
                            45,
                            35,
                            25,
                            0,
                            24,
                            25,
                            35,
                            0,
                            41,
                            24,
                            35,
                            0,
                            33,
                            39,
                            18,
                            0,
                            42,
                            33,
                            18,
                            0,
                            18,
                            19,
                            42,
                            0,
                            45,
                            40,
                            44,
                            0,
                            44,
                            34,
                            45,
                            0,
                            44,
                            40,
                            41,
                            0,
                            35,
                            33,
                            42,
                            0,
                            41,
                            42,
                            44,
                            0,
                            42,
                            41,
                            35,
                            0,
                            38,
                            37,
                            22,
                            0,
                            31,
                            22,
                            37,
                            0,
                            22,
                            23,
                            38,
                            0,
                            37,
                            30,
                            31,
                            0,
                            44,
                            42,
                            9,
                            0,
                            39,
                            44,
                            9,
                            0,
                            9,
                            10,
                            39,
                            0,
                            45,
                            25,
                            28,
                            0,
                            40,
                            45,
                            28,
                            0,
                            28,
                            43,
                            40
                        ],
                        "vertices": [
                            21066.5,
                            0,
                            -18930,
                            21058,
                            0,
                            -18985.2,
                            21058,
                            0,
                            -18930,
                            21058,
                            0,
                            -19070,
                            21066.5,
                            0,
                            -19070,
                            20942,
                            0,
                            -18930,
                            20933.5,
                            0,
                            -19070,
                            20933.5,
                            0,
                            -18930,
                            20942,
                            0,
                            -19070,
                            20942,
                            0,
                            -18985.2,
                            20942,
                            0,
                            -19014.8,
                            21058,
                            5700,
                            -18930,
                            21066.5,
                            5700,
                            -19070,
                            21066.5,
                            5700,
                            -18930,
                            20942,
                            5700,
                            -19070,
                            20933.5,
                            5700,
                            -18930,
                            20933.5,
                            5700,
                            -19070,
                            20942,
                            5700,
                            -18930,
                            20942,
                            5700,
                            -19014.8,
                            20942,
                            5700,
                            -18985.2,
                            21058,
                            5700,
                            -19070,
                            21057.8,
                            0,
                            -19012.4,
                            21057.8,
                            5700,
                            -18987.6,
                            21057.8,
                            5700,
                            -19012.4,
                            20954,
                            5700,
                            -18997.2,
                            20954,
                            5700,
                            -19002.8,
                            21048.3,
                            5700,
                            -19003,
                            21048.3,
                            5700,
                            -18997,
                            21048.3,
                            0,
                            -19003,
                            21052.7,
                            0,
                            -19004.8,
                            21052.7,
                            0,
                            -18995.2,
                            21056,
                            0,
                            -18991.9,
                            21056,
                            0,
                            -19008.1,
                            20944,
                            5700,
                            -19008.1,
                            20945.5,
                            0,
                            -19006.3,
                            20947.3,
                            5700,
                            -19004.8,
                            21052.7,
                            5700,
                            -19004.8,
                            21052.7,
                            5700,
                            -18995.2,
                            21056,
                            5700,
                            -19008.1,
                            20942.9,
                            0,
                            -19010.2,
                            20951.7,
                            0,
                            -18997,
                            20949.4,
                            5700,
                            -18996.3,
                            20942.9,
                            5700,
                            -18989.8,
                            21048.3,
                            0,
                            -18997,
                            20945.5,
                            0,
                            -18993.7,
                            20949.4,
                            0,
                            -19003.7
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "general": {
                    "name": "B132",
                    "description": "Ifc Imported Element"
                },
                "element": {
                    "elementtyp": "Column",
                    "layer": "BuildingModel",
                    "model": "Structural model",
                    "material": "S 235"
                },
                "elementstate": {
                    "state": "Nothing Defined"
                },
                "allfreeattrib": {
                    "globalid": "26gojRHan8_9KtPcvJkUQf",
                    "skipparentlocations": "False",
                    "extrudeprofilename": "HEA140",
                    "extrudeprofiletype": "IShapeProfile",
                    "filletradius": "12",
                    "flangethickness": "8,5",
                    "overalldepth": "133",
                    "overallwidth": "140",
                    "webthickness": "5,5"
                }
            }
        }
    ]
}




Get Geometry as binary Gltf


Resource:  <team_slug>/objects/<object_id>/geometries/glb?chunk=1&topology=true

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/glb?chunk=1&topology=true

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/dc701cd2-7490-44dc-8b7e-bd697e1f72d5/geometries/glb?chunk=1&topology=true

Optional query parameters

NameTypeDefault valueDescription

chunk

intnull ( diasabled)

If chunks are switched on, the geometry is divided into ~5MB blocks. The number of chunks is returned in the header using 'X-Total-Count'.

topologybooleanfalseIf topology is enabled, the scene object contains additional topology nodes
levelOfDetailint1switch geometry precision to 100 to reduce face count


Extension:

you can add an additional filter for disciplines (layer) by using
Url: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/glb


 GET


This API function returns geometry data based on root object <object_id> as binary gltf.



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




Status: 200 OK



the response is no json!
it's a binary with mimetype "model/gltf-binary"
it can be saved as 'glb' file.


Get the complex properties of the object


Resource:  <team_slug>/objects/<object_id>/complexproperties?revision=<revisionNr>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/complexproperties?revision=<revisionNr>

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/dc701cd2-7490-44dc-8b7e-bd697e1f72d5/complexproperties?revision=2

Optional query parameters

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



 GET


This API function returns structure of all complex properties for required object.



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




Status: 200 OK


{
  "children":[{
      "children":[{
          "children":[],
          "parent":"23240392-024d-4c05-bfc8-4d6eff6f7045",
          "name":"Object Layer Attributes #1",
          "type":null,
          "number":2,
          "id":"dbf87493-6dad-4ee5-acba-115437accc68"
        },
        {
          "children":[],
          "parent":"23240392-024d-4c05-bfc8-4d6eff6f7045",
          "name":"Object Layer Attributes #0",
          "type":null,
          "number":2,
          "id":"d17b5c98-f0cf-4acb-9314-af3cb686fe3d"
        }
      ],
      "parent":"dc701cd2-7490-44dc-8b7e-bd697e1f72d5",
      "name":"Allplan Attributes",
      "type":null,
      "number":1,
      "id":"23240392-024d-4c05-bfc8-4d6eff6f7045"
    }
  ],
  "parent":"00000000-0000-0000-0000-000000000000",
  "name":null,
  "type":"Wall",
  "number":0,
  "id":"dc701cd2-7490-44dc-8b7e-bd697e1f72d5"
}



Update the object


Resource: objects/<object_id> 

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

Examplehttps://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



 PUT


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



Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/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]}"
    }
  }
}




Status: 200 OK


{
  "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"
    }
  }
}



Create a new comment in the object


Resource: objects/<object_id>/comments 

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

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

JSON Structure:

Name

Mandatory / Optional

Type

Description

issueIdwill be ignoredstring(guid)The id of the issue

text

mandatory

string

The comment text

createdAt

will be ignored

string (date)

Creation date of the comment

modifiedAtwill be ignoredstring (date)Modified date of the comment

author

will be ignored

object

The author of the comment



 POST


Create a new comment for a specified object.



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


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




Status: 201 Created


{
    "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"
}



Get all the comments of the object


Resource: objects/<object_id>/comments 

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

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


 GET


 Get all the comments of a specified object.



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




Status: 200 OK


[
    {
        "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"
    }
]



Create a new attachment in the object


Resource: objects/<object_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments

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


 POST


Create a new attachment in a object.


Bimplus supports creating and updating of attachments only using requests with multipart/form-data content type. By standard, multipart/form-data content consists of several parts, each part containing a file data.

But Bimplus supports only one file sent per call, so only first part of multipart form data content is used, the rest are ignored. The parts are separated by boundaries, each part contains content headers and content data.

Examples :


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW


------MyFormBoundarytlTJWL8i2mvYwGPW
Content-Disposition: form-data; name="TestFile"; filename="TestFile.xml"; classification="Report"; tag="ABCDE"
Content-Type: application/xml
 
**** Here are file data  ******
 
------MyFormBoundarytlTJWL8i2mvYwGPW

Where :

  • name and filename are mandatory saved as attachment's "name" and "filename" properties
  • classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
  • Content-Type is mandatory and is saved as attachment's property "type"




Status: 201 Created


{
     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "size": 211258,
     "createdAt": "2013-12-11T10:47:39",
     "creator": {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
         "firstname": "First Name",
         "lastname": "Second Name",
         "company": "Best-Company",
         "fullname": "First Name Second Name",
         "displayname": "Best-Company",
     },
     "changed" : "2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     }
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}



Get the attachment list from the object


Resource: objects/<object_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments

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



 GET


 Get all the attachments belonging to a specified object.



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




Status: 200 OK


[
   {
     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "size": 211258,
     "createdAt": "2013-12-11T10:47:39",
     "creator": {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
         "firstname": "First Name",
         "lastname": "Second Name",
         "company": "Best-Company",
         "fullname": "First Name Second Name",
         "displayname": "Best-Company",
     },
     "changed" : "2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     }
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
  },
  ...
]



Delete all the attachments from the object


Resource: objects/<object_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments

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


 DELETE


 Delete all the attachments from a specified object.



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




Status: 200 OK



Create a new hyperlink for the object


 Resource: objects/<object_id>hyperlinks 

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

Examplehttps://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

typeoptionalstringHyperlink type. Could be either none - link to web site, or "Attachment" - link to download url



 POST


Create a new hyperlink for the object.



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


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




Status: 200 Created


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



Get the hyperlink list from the object


Resource: objects/<object_id>hyperlinks 

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

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


 GET


 Get all the hyperlinks belonging to a specified object.



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




Status: 200 OK


[
    {
        "orderNumber": 1,
        "name": "My website",
        "url": "https://www.bimplus.net/",
        "id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
    },
    {
        "orderNumber": 2,
        "name": "My second website",
        "url": "https://www-stage.bimplus.net/",
        "id": "e72e6ddd-63f4-40a3-b820-a32300e14c31"
    }
]



Capture/create an object view(scene) for sharing it with another user

A view of an object can be created similar to the Slideshow & Topics by updating the object (i.e PUT objects/<object_id>) This is similar to creating slides & the template for creating slides is present here


Improve the get model geometries performance using chunks & templates

The performance of the Get Geometry call can be improved by using templates & chunks.

Templates

 {
            "id": "1e9d3697-cde5-4d67-8998-267edd4fe968",
            "type": "Door",
            "attributes": {
                "geometry": {
                    "colorid": 1,
                    "template": "5ad3b016-a9d8-4f8a-9e12-8919c411f076",
                    "matrix": [
                        1,
                        0,
                        0,
                        75957.48,
                        0,
                        0,
                        1,
                        17100,
                        0,
                        -1,
                        0,
                        -64025,
                        0,
                        0,
                        0,
                        1
                    ]
                }
            }


Chunks


Delete the object


Resource: objects/<object_id> 

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

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


 DELETE


 Deletes a specified object.



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




Status: 200 OK




Create a new custom table in the object


Resource: objects/<object_id>/customtables 

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

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

JSON Structure:

Name

Mandatory / Optional

Type

Description

relatedIdoptionalstring(guid)The id of the object the custom table belongs to. Will be taken from request url.
nameoptionalstringCustom table name
descriptionoptionalstringCustom table description
idwill be ignoredstring(guid)The id of the custom table.

created

will be ignored

string (date)

Creation date of the custom table

createdBy

will be ignored

object

The user which created custom table

changedwill be ignoredstring (date)Modified date of the comment
changedBywill be ignoredstring (date)The user which recently modified custom table
revisionoptionalint (null=current)Object revision. If revision is specified, then the call will get the object from the requested revision, otherwise return current object ( latest revision ).
dataTablemandatoryobject

A JSON string which includes data for custom table. An example template is specified below.

Please remember, the server will process the dataTable information as a json string and hence the client has to take care on the information that is stored & retrieved.



 POST


Create a new custom table for a specified object.



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


{
    "name": "Sample custom table",
    "description": "Sample custom table with all column types",
    "dataTable": {
        "columns": [
            { "name": "Int column", "type": "Int32" },
            { "name": "DateTime column", "type": "DateTime" },
            { "name": "String column", "type": "String" },
            { "name": "Double column", "type": "Double" },
            { "name": "Guid column", "type": "Guid" },
            { "name": "Bool column", "type": "Boolean" }
        ],
        "rows": [
            { "items": [ 1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 3, "2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
        ]
    },
}
 




Status: 201 Created


{
    "name": "Sample custom table",
    "description": "Sample custom table with all column types",
    "relatedId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "created": "2017-06-20T06:51:40.64",
    "createdBy": {
        "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
        "email": null
    },
    "changed": "2017-06-20T06:51:40.64",
    "changedBy": {
        "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
        "email": null
    },
    "revision": 0,
    "dataTable": {
        "columns": [
            { "name": "Int column", "type": "Int32" },
            { "name": "DateTime column", "type": "DateTime" },
            { "name": "String column", "type": "String" },
            { "name": "Double column", "type": "Double" },
            { "name": "Guid column", "type": "Guid" },
            { "name": "Bool column", "type": "Boolean" }
        ],
        "rows": [
            { "items": [ 1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 3, "2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
        ]
    },
    "id": "2517e000-eb32-4487-be36-c5db90b9b943"
}
 



Get all the custom tables of the object


Resource: objects/<object_id>/customtables 

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

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


 GET


 Get all the custom tables of a specified object.



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




Status: 200 OK


[
    {
	    "name": "Sample custom table",
    	"description": "Sample custom table with all column types",
	    "relatedId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
	    "created": "2017-06-20T06:51:40.64",
	    "createdBy": {
	        "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
	        "email": null
	    },
	    "changed": "2017-06-20T06:51:40.64",
	    "changedBy": {
        	"id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
    	    "email": null
	    },
	    "revision": 0,
	    "dataTable": {
        	"columns": [
    	        { "name": "Int column", "type": "Int32" },
	            { "name": "DateTime column", "type": "DateTime" },
	            { "name": "String column", "type": "String" },
            	{ "name": "Double column", "type": "Double" },
        	    { "name": "Guid column", "type": "Guid" },
    	        { "name": "Bool column", "type": "Boolean" }
	        ],
        	"rows": [
    	        { "items": [ 1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
	            { "items": [ 2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
        	    { "items": [ 3, "2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
    	        { "items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
	        ]
    	},
    	"id": "2517e000-eb32-4487-be36-c5db90b9b943"
	}
]



Delete all the custom tables of the object


Resource: objects/<object_id>/customtables

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

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


 DELETE


 Delete all the custom tables of a specified object.



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




Status: 200 OK



Get reports of the object


Resource: objects/<object_id>/reports

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/reports

Examplehttps://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/reports


Optional query parameters

NameTypeDefault valueDescription
versionintnullIf version is specified, then the call will get report's of object from the requested version, otherwise return all reports of objects.
actionstringnullIf action is specified, then the call will get report's of object from the requested action, otherwise return all reports of objects. Now we have report just for action = Download_Document



 GET


 Get report of a specified object.



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




Status: 200 OK


[
    {
        "id": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "user": {
            "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
            "email": "test@email.com"
        },
        "created": "2010-08-02T10:08:14.069124",
        "version": 1,
        "action": "Download_Document"
    },
	{
        "id": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "user": {
            "id": "98a94d0e-0d58-3f85-aafa-1e631c51b5d2",
            "email": "test8@email.com"
        },
        "created": "2010-08-02T10:08:14.069124",
        "version": 2,
        "action": "Download_Document"
    }
...
]




Selection Object