Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: objects/<object_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id> Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75
Optional query paramaters Name | Type | Default value | Description |
---|
revision | int | null ( current ) | If revision is specified, then the call will get the object from the requested revision, otherwise return current object ( latest revision ). | internal | boolean | false | false = return attributes in viewer format ( as seen in the portal ); true = return in different, internal server representation format. | children | boolean | false | false = return only properties of the object itself; true = return properties of the object and all its children | freeattributes | boolean | false | false = for each attribute return only name and value; true = return full definition for each object's attribute | disciplineId | Guid | null | Specifies the discipline ( layer ). |
|
Card |
---|
| Gets the properties ( attributes ) of an object. By using and combining the optional query parameters, the caller can shape the response to requested format ( see response for more description ). If parameter is not used, its default value is used. Note: Following object-related api calls are now obsolete ( they are still supported, but will be removed eventually ), and should be replaced by using get object call with query parameters : Obsolete call | Should be replaced by |
---|
GET /<teamslug>/objects/<object_id>/tree | GET /<teamslug>/objects/<object_id>?children=true | GET /<teamslug>/objects/<object_id>/internal | GET /<teamslug>/objects/<object_id>?internal=true | GET /<teamslug>/objects/<object_id>/properties/3 | GET /<teamslug>/objects/<object_id>?children=true | GET /<teamslug>/objects/<object_id>/properties/8 | GET /<teamslug>/objects/<object_id>?freeattributes=true |
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 200 OK
|
In general, the response has following format : Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSONIn general, the response json has following format : |
---|
| {
"elementtyp": "<type_id>",
"id": "<object_id>",
"parent" : "<parent_id>",
"type": "<type_name>",
"layerid": "<discipline_id>",
"attributes": {
"<attribute_group_1": {
"<property_name_1>": "<property_value>",
"<property_name_2>": "<property_value>",
"<property_name_3>": "<property_value>"
...
},
"<attribute_group_2": {
"<property_name_1>": "<property_value>",
"<property_name_2>": "<property_value>"
...
},
....
},
"children" : []
} |
if query parameter "children" is used, the property "children" will contain array of child objects in the same format as is the object itself. Code Block |
---|
title | If query parameter "freeattributes" is used, the "property_value" |
---|
| it's not just value, but contains full attribute definition in following format: |
|
code | | {
"id": "<attribute_id>",
"name": "<attribute_name>",
"group": "<attribute_group>",
"type": "<attribute_value_type>",
"isInternal": <true or false>,
"value": "<attribute_value>"
} | Examples: Code Block |
---|
title | GET /<teamslug>/objects/<objectid> |
---|
| {
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
"parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
"type": "Wall",
"layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"attributes": {
"element (default property set)": {
"type": "Wall",
"model": "Model A",
"layer": "BuildingModel"
},
"general (default property set)": {
"name": "Basic Wall:300_21_isolatie_208.5_spouwklein:4820766",
"description": "Ifc Imported Element",
"ifcglobaluniqueid": "2H$2pBsuL7TgKZ59zSDw0D",
"ifcelementtype": "IfcWallStandardCase"
},
"content": {
"tag": "4820766",
"objecttype": "Basic Wall:300_21_isolatie_208.5_spouwklein:4296143",
"skipparentlocations": "False",
"extrudeprofiletype": "RectangleProfile",
"polyeder area": "25,851 m²",
"polyeder volume": "2,036 m³",
"xdim": 5160.00000000001,
"ydim": 208.5
}
},
...
} |
Code Block |
---|
title | GET /<teamslug>/objects/<object_id>?freeattributes=true |
---|
| {
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
"parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
"type": "Wall",
"layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"attributes": {
"element (default property set)": {
"type": {
"id": "a0e8ae2c-c869-4ec3-9019-25d3704be707",
"name": "Type",
"group": "Element (default Property set)",
"subGroup": "Element",
"type": "Guid",
"value": "Wall"
},
"model": {
"id": "cd320d7b-7299-4abc-8409-c86e46fa45f9",
"name": "Model",
"group": "Element (default Property set)",
"subGroup": "Element",
"type": "Guid",
"value": "Model A"
},
"layer": {
"id": "4812c68a-3f8d-40c1-b3f8-551a4102a406",
"name": "Layer",
"group": "Element (default Property set)",
"subGroup": "Element",
"type": "Guid",
"value": "BuildingModel"
}
}
...
}
} |
Code Block |
---|
title | GET <teamslug>/objects/<object_id>?internal=true |
---|
| {
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
"parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
"type": "Wall",
"layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"attributes": {
"element": {
"isparent": true,
"nr": 4,
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"logparentid": "b1570b15-2786-4c22-baf0-94e07de69990",
"divisionid": "1b6fa8ae-568a-4bc0-81b7-c6d282834a0c",
"materialstring": "ISR_Isolatie",
"matrix": {
"values": [
1,
0,
0,
120,
0,
1,
0,
-228.5,
0,
0,
1,
-70,
0,
0,
0,
1
]
},
"articleid": "0583a9a7-3756-48b9-b836-63541bdf130e",
"materialsurfaceid": "058578b6-6a32-48f5-ae4a-59dc452de287",
"layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6"
},
"general": {
"name": "Basic Wall:300_21_isolatie_208.5_spouwklein:4820766",
"description": "Ifc Imported Element",
"isobjectvalid": true
},
"elementstate": {
"state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
},
"objectlog": {
"createdby": "e4d7ac3c-94f3-4507-9b8b-a1505225845c",
"created": "2016-01-28T10:51:04.843",
"modifiedby": "e4d7ac3c-94f3-4507-9b8b-a1505225845c",
"modified": "2016-01-28T10:51:04.843",
"revision": 0
},
...
}
} |
|
|