Versions Compared

Old Version 4

changes.mady.by.user Jayaraj Purushothaman

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.

...

Object Navigator / Object Filter Service

...

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": {
        "idparent": 853539null,
        "servername": "K2177Buildingelement Type/Name",
        "datetype": "2013-12-16T10:00:23Structure",
        "requestid"children": [
            {
                "parent": "653750b3ae647490-a97e054c-451f45d9-bd01a348-1a4671344087122fba25bd3d",
        "thread        "name": "51Model1",
                "leveltype": "INFOStructure",
                "loggerchildren": "PerformanceLog.ServiceLog", [
                    {
        "message                "parent": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
3c80b75f-7ffd-423e-985e-08245192a403",
                        "exceptionname": "Wall",
                        "useridtype": "123456789Structure",
          "clientid":"987654321",              "children": [
                            {
        "executiontime                        "parent": "1234"
27d76576-ad75-4704-81b3-a55f509818fe",
                  },
      {
        "idname": 853540"Wall",
                    "server            "type": "K2177Structure",
            "date": "2013-12-16T10:00:23",
                    "children": [
                                    {
                                        "requestidparent": "653750b39bf57f0e-a97e9d29-451f4e02-bd01bd04-1a4671344087ade4d0883643",
                             "thread           "name": "51Wall",
                                        "leveltype": "INFOID_ArchWall",
                                        "logger": "PerformanceLog.UserLog",
children": [],
                                        "count": 1,
                             "message": "User found byId: bestcustomer@bimplus.net",
           "level": 4,
                                        "nodeInfo": "b539790e-2ffc-43cd-9582-b4aa27b36693;10074eef-9418-4d64-9c6d-23932835a7f1;Wall;20986a50-c2ed-4eae-8970-0003c1d21952",
                                        "exceptionid": "20986a50-c2ed-4eae-8970-0003c1d21952"
                                    },
         "userid                           {
                                        "parent": "1234567899bf57f0e-9d29-4e02-bd04-ade4d0883643",
                                        "clientidname": "987654321Wall",
                            "executiontime            "type": "1234ID_ArchWall",
                                       },
  "children": [],
                    {
                    "idcount": 853541,
1,
                                        "serverlevel": "K2177",
4,
                               "date         "nodeInfo": "2013-12-16T10:00:23",
b539790e-2ffc-43cd-9582-b4aa27b36693;10074eef-9418-4d64-9c6d-23932835a7f1;Wall;c38c8afa-161f-42d8-8af4-018f9e4f072a",
                                        "requestidid": "653750b3c38c8afa-a97e161f-451f42d8-bd018af4-1a4671344087018f9e4f072a",

                                   "thread": "51" },
    },.....]



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
{
    "leveldisciplineID": "INFOED51EC38-2BE6-43D2-8DA4-C34CBFA808A1",
    "name": "Sprinkler Name",
    "loggerfilterString": "PerformanceLog.ServiceLog[I]tabAttribElement.DivisionID[I]tabAttribGeneral.Name",
    "isDefault": true,
    "messagedisableSortByModels": false,
  "END Request (GET /v2/best-company/projects/679532b9- "id": "6cf16e42-160a-4979-be52-a47d9f4b57d2"
}



Anchor
createObjectFilter
createObjectFilter

Create a new custom object filter
Deck of Cards
idbimCreateObjectFilter


Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: settings/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:

NameTypeDescription
project_idstring(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



Card
labelHTTP Method
 POST


Card
labelDescription
 Creates a new user's object filter.


Card
labelRequest


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


Code Block
borderColorRed
langxml
titleJSON
{
 "disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
 "name" : "Custom Filter",
 "filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
titleJSON
{
 "id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
 "disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
 "name" : "Custom Filter",
 "filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}



Anchor
updateObjectFilter
updateObjectFilter

Update object filter

Deck of Cards
idbimUpdateObjectFilter


Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: settings/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:

NameTypeDescription
project_idstring(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

idmandatoryguidFilter 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



Card
labelHTTP Method
PUT


Card
labelDescription
 Update existing object filter


Card
labelRequest


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


Code Block
borderColorRed
langxml
titleJSON
{
 "id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
 "disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
 "name" : "Custom Filter",
 "filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
titleJSON
{
 "id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
 "disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
 "name" : "Custom Filter",
 "filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },.....]