Selection Object Service
- Create a new selection object
- Get the selection object details
- Get all selection objects of the project
- Delete the selection object
Selection Object Service
Selection Objects are the primary components to help better organize full or partial selections of the project objects.
Please see the detailed structure of the issue in the Object Model
Create a new selection object
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/selections
Example: https://api-stage.bimplus.net/v2/bimplus/projects/ceac9b1e-31d9-4c5f-bd78-f909767b7b01/selections
JSON Structure: The structure of the Selection objects is the same like the structure of the object for Export Object
Optionally there is an opportunity to mark selection object validity just for one use with the 'singleuse' (default is null or false) attribute. The created selection for a single use ("singleuse": true) attribute selection object will be automatically deleted when the selection id is used on any of the API services where it is possible to use a selection id (Including services for example: Objects, Revision comparisions, Locks, Geometries, Clash filters).
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"divisionId":"371D0C5F-87A1-42CF-BF43-6FE6123EBE00",
"type":"Topology",
"singleuse": false,
"topology":{
"layers":[{
"id":"33826b01-c267-4b25-9f8e-79ac2953c443",
"divisionId":"1B52B5F7-1B2D-461A-AA9B-6F55C8889241"
}
],
"topology":[{
"id":"522e3cc1-c6d4-441c-974c-becfcb51cd14"
},
{
"id":"02583ba2-f7da-4f3a-a2b0-976d98415740"
}
]
}
}
Status: 201 Created
{
"id":"e9eb4f1a-827a-4c19-ae56-e91c4f2988b1",
"projectid":"3f6de86b-0bef-4146-847c-aa21afad6cfa",
"divisionid":"371d0c5f-87a1-42cf-bf43-6fe6123ebe00",
"singleuse": false,
"type":"Topology",
"elements":null,
"topology":{
"camera":null,
"topology":[{
"id":"522e3cc1-c6d4-441c-974c-becfcb51cd14",
"visible":false,
"opaque":false,
"opacity":0
},
{
"id":"02583ba2-f7da-4f3a-a2b0-976d98415740",
"visible":false,
"opaque":false,
"opacity":0
}
],
"layers":[{
"revision":0,
"id":"33826b01-c267-4b25-9f8e-79ac2953c443",
"name":null,
"divisionId":"1b52b5f7-1b2d-461a-aa9b-6f55c8889241",
"divisionName":null,
"visible":false,
"opaque":false,
"opacity":0
}
]
},
"filter":null,
"structure":null
}
Get the selection object details
URL: https://api-stage.bimplus.net/v2/<team_slug>/selections/<object_id>
Example: https://api-stage.bimplus.net/v2/bimplus/selections/e9eb4f1a-827a-4c19-ae56-e91c4f2988b1
Optional query parameters
Gets the details of the specified selection object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"id":"e9eb4f1a-827a-4c19-ae56-e91c4f2988b1",
"projectid":"3f6de86b-0bef-4146-847c-aa21afad6cfa",
"divisionid":"371d0c5f-87a1-42cf-bf43-6fe6123ebe00",
"singleuse": false,
"type":"Topology",
"elements":null,
"topology":{
"camera":null,
"topology":[{
"id":"522e3cc1-c6d4-441c-974c-becfcb51cd14",
"visible":false,
"opaque":false,
"opacity":0
},
{
"id":"02583ba2-f7da-4f3a-a2b0-976d98415740",
"visible":false,
"opaque":false,
"opacity":0
}
],
"layers":[{
"revision":0,
"id":"33826b01-c267-4b25-9f8e-79ac2953c443",
"name":null,
"divisionId":"1b52b5f7-1b2d-461a-aa9b-6f55c8889241",
"divisionName":null,
"visible":false,
"opaque":false,
"opacity":0
}
]
},
"filter":null,
"structure":null
}
Get all the selection objects of the project
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/exportobjects
Example: https://api-stage.bimplus.net/v2/bimplus/projects/ceac9b1e-31d9-4c5f-bd78-f909767b7b01/exportobjects
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[{
"id":"e9eb4f1a-827a-4c19-ae56-e91c4f2988b1",
"projectid":"3f6de86b-0bef-4146-847c-aa21afad6cfa",
"divisionid":"371d0c5f-87a1-42cf-bf43-6fe6123ebe00",
"singleuse": false,
"type":"Topology",
"elements":null,
"topology":{
"camera":null,
"topology":[{
"id":"522e3cc1-c6d4-441c-974c-becfcb51cd14",
"visible":false,
"opaque":false,
"opacity":0
},
{
"id":"02583ba2-f7da-4f3a-a2b0-976d98415740",
"visible":false,
"opaque":false,
"opacity":0
}
],
"layers":[{
"revision":0,
"id":"33826b01-c267-4b25-9f8e-79ac2953c443",
"name":null,
"divisionId":"1b52b5f7-1b2d-461a-aa9b-6f55c8889241",
"divisionName":null,
"visible":false,
"opaque":false,
"opacity":0
}
]
},
"filter":null,
"structure":null
},
{
"id":"3f5125db-8fe1-47a5-980d-96ebf62e52d4",
"projectid":"3f6de86b-0bef-4146-847c-aa21afad6cfa",
"divisionid":"371d0c5f-87a1-42cf-bf43-6fe6123ebe00",
"singleuse": false,
"type":"Topology",
"elements":null,
"topology":{
"camera":null,
"topology":[{
"id":"522e3cc1-c6d4-441c-974c-becfcb51cd14",
"visible":false,
"opaque":false,
"opacity":0
},
{
"id":"02583ba2-f7da-4f3a-a2b0-976d98415740",
"visible":false,
"opaque":false,
"opacity":0
}
],
"layers":[{
"revision":0,
"id":"33826b01-c267-4b25-9f8e-79ac2953c443",
"name":null,
"divisionId":"1b52b5f7-1b2d-461a-aa9b-6f55c8889241",
"divisionName":null,
"visible":false,
"opaque":false,
"opacity":0
}
]
},
"filter":null,
"structure":null
}
]
Delete the selection object
URL: https://api-stage.bimplus.net/v2/<team_slug>/selections/<object_id>
Example: https://api-stage.bimplus.net/v2/bimplus/selections/ceac9b1e-31d9-4c5f-bd78-f909767b7b01
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
