Versions Compared

Old Version 13

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version Current

changes.mady.by.user Noema Bradnanska

Saved on

Key

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

...

...

Deck of Cards
idbimGetFilterInfo


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: filters/<filter_id> 

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/filters/<filter_id>

Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955b218/filters/ed2d009a-f90a-4001-9b17-45a414bca1d7

Optional query parameters

NameTypeDefault valueDescription
topologybooleanfalse

When query parameter "topology=true" is defined, the API call will returns objects/elements a particular filter id also with topology nodes.



Card
labelHTTP Method
 GET


Card
labelDescription

Get the building objects/elements using a particular filter id


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
    "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"
                                    },
    },.....]



Anchor
getOneFilter
getOneFilter

Get the one filter
Deck of Cards
idbimGetAllFilters


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: settings/filters 

URL: https://api-stage.bimplus.net/v2/<team_slug>/settings/filters<filters_id>

Example: https://api-stage.bimplus.net/v2/bimplus/settings/filters/6cf16e42-160a-4979-be52-a47d9f4b57d2


Card
labelHTTP Method
 GET


Card
labelDescription

 Get the one filter


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
    "disciplineID": "ED51EC38-2BE6-43D2-8DA4-C34CBFA808A1",
    "name": "Sprinkler Name",
    "filterString": "[I]tabAttribElement.DivisionID[I]tabAttribGeneral.Name",
    "isDefault": true,
    "disableSortByModels": false,
    "id": "6cf16e42-160a-4979-be52-a47d9f4b57d2"
}



Anchor
createObjectFilter
createObjectFilter

...