Object Navigator / Object Filter Service
- Get the predefined filters that belongs to a projects & discipline
- Get the building objects/elements using the filter
- Create a new filter
- Update existing filter
Object Navigator / Object Filter Service
Get the predefined filters that belongs to a projects & discipline
URL: https://api-stage.bimplus.net/v2/<team_slug>/settings/filters?object_id=<discipline_id>&project_id=<project_id>
Example: https://api-stage.bimplus.net/v2/bimplus/settings/filters?object_id=0f106af0-a919-44c5-b211-15bd5ef620b6&project_id=5cd37c77-d341-4ab2-9f0d-44467955b218
Get the predefined filters that belongs to a projects & discipline
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"disciplineID": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"name": "Buildingelement Type",
"filterString": "[I]tabAttribElement.DivisionID[I]tabAttribElement.ElementTyp",
"id": "954ec08b-5c55-4f86-9d01-d49cc3b2f666"
},
{
"disciplineID": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"name": "Buildingelement Name",
"filterString": "[I]tabAttribElement.DivisionID[I]tabAttribGeneral.Name",
"id": "d465bdc3-a3c7-469e-a0a9-25da81cd293e"
},
{
"disciplineID": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"name": "Buildingelement Type/Name",
"filterString": "[I]tabAttribElement.DivisionID[I]tabAttribElement.ElementTyp[I]tabAttribGeneral.Name",
"id": "ed2d009a-f90a-4001-9b17-45a414bca1d7"
},
{
"disciplineID": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"name": "Buildingelement Name/Type",
"filterString": "[I]tabAttribElement.DivisionID[I]tabAttribGeneral.Name[I]tabAttribElement.ElementTyp",
"id": "8ba9fa06-69e2-4f18-afee-4acfa01bae6e"
}
]
Get the building objects/elements using the filter
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/filters/<filter_id>
Optional query parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| topology | boolean | false | When query parameter "topology=true" is defined, the API call will returns objects/elements a particular filter id also with topology nodes. |
Get the building objects/elements using a particular filter id
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"structureDepth": 4,
"structure": {
"parent": null,
"name": "Buildingelement Type/Name",
"type": "Structure",
"children": [
{
"parent": "ae647490-054c-45d9-a348-122fba25bd3d",
"name": "Model1",
"type": "Structure",
"children": [
{
"parent": "3c80b75f-7ffd-423e-985e-08245192a403",
"name": "Wall",
"type": "Structure",
"children": [
{
"parent": "27d76576-ad75-4704-81b3-a55f509818fe",
"name": "Wall",
"type": "Structure",
"children": [
{
"parent": "9bf57f0e-9d29-4e02-bd04-ade4d0883643",
"name": "Wall",
"type": "ID_ArchWall",
"children": [],
"count": 1,
"level": 4,
"nodeInfo": "b539790e-2ffc-43cd-9582-b4aa27b36693;10074eef-9418-4d64-9c6d-23932835a7f1;Wall;20986a50-c2ed-4eae-8970-0003c1d21952",
"id": "20986a50-c2ed-4eae-8970-0003c1d21952"
},
{
"parent": "9bf57f0e-9d29-4e02-bd04-ade4d0883643",
"name": "Wall",
"type": "ID_ArchWall",
"children": [],
"count": 1,
"level": 4,
"nodeInfo": "b539790e-2ffc-43cd-9582-b4aa27b36693;10074eef-9418-4d64-9c6d-23932835a7f1;Wall;c38c8afa-161f-42d8-8af4-018f9e4f072a",
"id": "c38c8afa-161f-42d8-8af4-018f9e4f072a"
},
},.....]
Create a new custom object filter
URL: https://api-stage.bimplus.net/v2/<team_slug>/settings/filter?project_id=<project_id>
Example: https://api-stage.bimplus.net/v2/bimplus/settings/filter?project_id=5cd37c77-d341-4ab2-9f0d-44467955b218
Optional query parameters:
| Name | Type | Description |
|---|---|---|
| project_id | string(guid) | When query parameter "project_id" is defined, the created custom filter will be assigned only to requested project |
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
disciplineID |
mandatory |
string(guid) |
Id of the layer/discipline |
name |
mandatory |
string |
Name of the filter |
filterString |
mandatory |
string |
Id of the object attribute in this format [Attribute_ID].Value |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
"name" : "Custom Filter",
"filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}
Status: 201 Created
{
"id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
"disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
"name" : "Custom Filter",
"filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}
Update object filter
URL: https://api-stage.bimplus.net/v2/<team_slug>/settings/filter?project_id=<project_id>
Example: https://api-stage.bimplus.net/v2/bimplus/settings/filter?project_id=5cd37c77-d341-4ab2-9f0d-44467955b218
Optional query parameters:
| Name | Type | Description |
|---|---|---|
| project_id | string(guid) | When query parameter "project_id" is defined, the updated custom filter will be assigned only to requested project |
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| id | mandatory | guid | Filter Id |
disciplineID |
mandatory |
string(guid) |
Id of the layer/discipline |
name |
mandatory |
string |
Name of the filter |
filterString |
mandatory |
string |
Id of the object attribute in this format [Attribute_ID].Value |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
"disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
"name" : "Custom Filter",
"filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}
Status: 200 OK
{
"id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
"disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
"name" : "Custom Filter",
"filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}
