geometry
Object Service
...
- Create a new object
- Get the object details
- Generate, save & share the view of an object
- Check whether an object has been updated (See only the header info)
- Get the object tree with full property list without geometry (object topology tree)
- Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
- Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
- Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer
- Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer
- Get the different properties / structure(normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations
- Get the complex properties of the object
- Update the object
- Create a new comment in the object
- Get all the comments of the objectDelete all the comments from the object
- Create a new attachment in the object
- Get the attachment list from the object
- Delete all attachments from the object
- Create a new hyperlink for the object
- Get the hyperlink list from the object
- Capture/create an object view(scene) for sharing it with another user
- Improve the get model geometries performance using chunks & templates
- Delete the object
- Create a new custom table in the object
- Get all the custom tables of the object
- Delete all the custom tables from the object
- Get the report of object
- Get object geometry as binary gltf (glb)
Object Service
...
Objects are the primary component of the project tree and it exists in two forms.
- Node: Objects with no graphical representation
- Geometry: Objects with graphical representation (See Geometry)
Please see the detailed structure of the issue in the Object Model
Anchor | ||||
---|---|---|---|---|
|
...
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
...
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
...
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | |||
---|---|---|---|
|
...
|
Get Geometry as binary Gltf
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Get the complex properties of the object
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Update the object
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
Anchor | ||||
---|---|---|---|---|
|
Create a new comment in the object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Get all the comments of the object
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Create a new attachment in the object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Get the attachment list from the object
Deck of Cards | ||
---|---|---|
|
...
Create a new comment in the object
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
Anchor | ||||
---|---|---|---|---|
|
Delete all the attachments from the object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Create a new hyperlink for the
...
object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Get the hyperlink list from the object
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Delete all the comments of the object
...
id | bimDeleteCommentOfObject |
---|
|
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
Anchor | ||||
---|---|---|---|---|
|
Improve the get model geometries performance using chunks & templates
The performance of the Get Geometry call can be improved by using templates & chunks.
Templates
- Templates are geometry references which are generated if more than one object has same geometry information. Templates are automatically generated on Bimplus import.
- Templates can be got for the whole project or per layer/discipline
eg
...
default | true |
---|---|
label | URL / Resource / JSON Structure |
...
...
...
- jay-company/objects/25f38274-7158-436d-9356-f5c917ee44c9/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/templates/threejs --> Get all the templates under a particular discipline in a project
eg: https://api-
...
...
...
...
...
...
Card | ||
---|---|---|
| ||
DELETE |
Card | ||
---|---|---|
| ||
Delete all the comments from the issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
- 44467955b218/templates/threejs --> Get all the templates under a project where object_id is the project_id
- Templates are referenced in the Get Geometry call
- eg
...
Create a new attachment in the object
...
id | bimObjCreateAttachment |
---|
...
default | true |
---|---|
label | URL / Resource / JSON Structure |
...
...
Code Block | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{
"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,
<team_slug>/objects/<object_id>attachmentsExample: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.
Card | | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
borderColor | Red |
---|---|
lang | xml |
title | JSON |
"objectIds": [
1,"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
]
17100,"fileName": "Building_Plan.jpg",
0,"type": "image/jpeg",
-1,"size":
211258,
"createdAt": "2013-12-11T10:47:39",
0,"creator":
{
"id":
"e18941f4-a809-2d01-d27d-cd251f2b6cb6",
-64025,"email": "test@bimplus.net"
0,"firstname":
"First
Name",
"lastname":
"Second
Name"0,"company":
"Best-Company",
"fullname":
"First
Name
Second
Name"0,"displayname":
"Best-Company",
"info": "",
1"gender":
"",
"phoneWork": "",
]"phoneHome":
"",
}"fax":
"",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}...
} |
Chunks
- Objects/geometry information can be got in chunks if the geometry data is more which the client can't handle.
- Chunks can be used for the normal geometry call or templates call
eg: https://api-dev.bimplus.net/v2/jay-company/objects/daf760d2-9fc2-4b89-907b-20df7fb62aeb/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/geometries/threejs/properties/8?chunk=1&chunkSize=medium
eg: https://api-dev.bimplus.net/v2/jay-company/objects/25f38274-7158-436d-9356-f5c917ee44c9/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/templates/threejs?chunk=1&chunkSize=medium - Chunk has 4 variants
off = 0,
low = 1000000 (1 MB)
middle = 5000000 (5 MB)
high = 20000000 (20 MB) - The user will receive the "X-Total-Count: X" in the header. It means the number of chunks(the number of iterations the user have to make)
- Please remember that always the first call of chunk_size will take some time (as the “object to chunk conversion” takes place during the first call)
Anchor | ||||
---|---|---|---|---|
|
Delete the object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Create a new custom table in the object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get the attachment list from the object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
...
Delete all the attachments from the object
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
|
...
|
...
Create a new hyperlink for the object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get the hyperlink list from the object
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
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
...
|
Anchor | ||||
---|---|---|---|---|
|
Get all the custom tables of the object
Deck of Cards | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
...
...
|
...
|
...
...
...
...
...
...
...
...
|
...
Code Block | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{
"id": "1e9d3697-cde5-4d67-8998-267edd4fe968",
"type": "Door",
"attributes": {
"geometry": {
"colorid": 1,
"template": "5ad3b016-a9d8-4f8a-9e12-8919c411f076",
"matrix": [
|
...
|
Anchor | ||||
---|---|---|---|---|
|
Delete all the custom tables of the object
Deck of Cards | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
...
...
|
...
|
...
...
...
...
...
...
...
|
Anchor | ||||
---|---|---|---|---|
|
Get reports of
...
...
the object
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|