Versions Compared

Old Version 514

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 515

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column

Project Service

Column

Model Service

Column

Object Service

...

Deck of Cards
idbimGetFullObjectPropMesh
Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET
Card
labelDescription
 Gets the details of an object
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
langxml
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":0,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Anchor
generateScene
generateScene

Generate, save & share the view of an object
Deck of Cards
idbimObjectUpdate
Card
defaulttrue
labelURL / 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

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.

Code Block
titleAn 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
labelHTTP Method
 PUT
Card
labelDescription
 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
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "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
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
getObjectHeader
getObjectHeader

...