Versions Compared

Old Version 12

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 13

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

...

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


Optional query paramaters

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 ).


Card
labelHTTP Method
 GET
Card
labelDescription

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
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
langxml
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

 

In general, the response has following format :

Code Block
borderColorRed
langxml
titleJSON
{
  "elementtyp": "<type_id>",
  "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75<object_id>",
  "parent" : "<parent_id>",
  "type": "Wall<type_name>",
  "layerid": "<discipline_id>",
  "attributes": {
        "element"<attribute_group_1": {
            "isparent<property_name_1>": false"<property_value>",
            "nr"<property_name_2>": 0"<property_value>",
            "matrix<property_name_3>": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",<property_value>"
      ...
    },
    "elementtyp<attribute_group_2": "10074eef-9418-4d64-9c6d-23932835a7f1",
      {
      "logparentid<property_name_1>": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e<property_value>",
            "divisionid"<property_name_2>": "ac21b9a1-8853-4658-9fbf-0cf62340bd18<property_value>"
      ...
    },
    ....
  },
  "generalchildren" : {
            "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]}"
        }
    }
}
[]
}

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

 

If query parameter "freeattributes" is used, the "property_value" it's not just value, but full attribute definition in following format:

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

 

 

Anchor
generateScene
generateScene

...