Skip to end of metadata
Go to start of metadata

Bimplus Windows Explorer related Services


Bimplus Windows Explorer related Services


Bimplus Windows Explorer is the Windows desktop application AEC professionals and BIM managers use to upload, manage and analyze building information on the Bimplus platform for use by all contributors to your construction project. For more information please see here

Create a new objectview
    Resource: objectlist

    URLhttps://api-stage.bimplus.net/v2/<team_slug>objectlist

    Examplehttps://api-stage.bimplus.net/v2/bimplus/objectlist

    JSON Structure

    Name

    Mandatory / Optional

    Type

    Description

    elementsId

    mandatory

    object

    List of elements id

    columnsList mandatory object List of columns
    tableName mandatory string Name of the resource
    columnName optional string Name of the property
    freeAttribId optional string(guid) Id of the used free attribute


     POST
     Create a new objectview
    Headers
    Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
    Content-Type: application/json
    
    JSON
    {
        "elementsId": [
            "8506156B-F965-4D51-9DD1-01D0C300601E",
            "CF9E6219-2962-4F21-B1DD-01DC4AB902E9",
            "1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
        ],
        "columnsList": [
            {
                "tableName": "general",
                "columnName": "Name",
                "freeAttribId": null
            },
            {
                "tableName": "general",
                "columnName": "Description",
                "freeAttribId": null
            },
            {
                "tableName": "quantity",
                "columnName": "Length",
                "freeAttribId": null
            },
            {
                "tableName": "quantity",
                "columnName": "Height",
                "freeAttribId": null
            },
            {
                "tableName": "element",
                "columnName": "ElementTyp",
                "freeAttribId": null
            },
            {
                "tableName": "element",
                "columnName": "DivisionID",
                "freeAttribId": null
            },
            {
                "tableName": "stringattrib",
                "columnName": "",
                "freeAttribId": "C3071F78-2ACA-46D9-9883-13F5184EC499"
            },
            {
                "tableName": "doubleattrib",
                "columnName": "",
                "freeAttribId": "8D3D9DD5-C998-465B-B13E-87901C90F3BC"
            }
        ]
    }
    Status
    Status: 201 CREATED
    
    JSON
    {
        "elementsId": [
            "8506156B-F965-4D51-9DD1-01D0C300601E",
            "CF9E6219-2962-4F21-B1DD-01DC4AB902E9",
            "1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
        ],
        "columnsList": [
            {
                "tableName": "general",
                "columnName": "Name",
                "freeAttribId": null
            },
            {
                "tableName": "general",
                "columnName": "Description",
                "freeAttribId": null
            },
            {
                "tableName": "quantity",
                "columnName": "Length",
                "freeAttribId": null
            },
            {
                "tableName": "quantity",
                "columnName": "Height",
                "freeAttribId": null
            },
            {
                "tableName": "element",
                "columnName": "ElementTyp",
                "freeAttribId": null
            },
            {
                "tableName": "element",
                "columnName": "DivisionID",
                "freeAttribId": null
            },
            {
                "tableName": "stringattrib",
                "columnName": "",
                "freeAttribId": "C3071F78-2ACA-46D9-9883-13F5184EC499"
            },
            {
                "tableName": "doubleattrib",
                "columnName": "",
                "freeAttribId": "8D3D9DD5-C998-465B-B13E-87901C90F3BC"
            }
        ]
    }

    Get the list of target objects(objectviews) which will be populated in the "Object Navigator List"
      Resource: objectview 

      URLhttps://api-stage.bimplus.net/v2/<team_slug>/objectviews

      Examplehttps://api-stage.bimplus.net/v2/bimplus/objectviews

       GET

       Get the list of target objectviews which will be populated in the "Object Navigator List"

      Headers
      Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
      Content-Type: application/json
      Status
      Status: 200 OK
      
      JSON
      [
          {
              "viewname": "onProjectElements_Building",
              "resourcenameid": "Category.ElementBuilding",
              "iconid": "IconArchitectureWall",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 21
          },
          {
              "viewname": "onProjectElements_Room",
              "resourcenameid": "Category.ElementRoom",
              "iconid": "IconArchitectureRoom",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 22
          },
          {
              "viewname": "onProjectElements_Finish",
              "resourcenameid": "Category.ElementFinish",
              "iconid": "IconRoofLayer",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 23
          },
          {
              "viewname": "onProjectElements_Reinforcement",
              "resourcenameid": "Category.Reinforcement",
              "iconid": "IconReinforcement",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 24
          },
          {
              "viewname": "onProjectElements_Mesh",
              "resourcenameid": "Category.Mesh",
              "iconid": "IconMesh",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 25
          },
          {
              "viewname": "onProjectElements_Precast",
              "resourcenameid": "Category.PrecastElement",
              "iconid": "IconPrecastUnit",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 27
          },
          {
              "viewname": "onProjectElements_PrecastTimber",
              "resourcenameid": "Category.ElementPrecastTimber",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 28
          },
          {
              "viewname": "onProjectElements_MEP",
              "resourcenameid": "Category.ElementMEP",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 29
          },
          {
              "viewname": "onProjectElements_Plumbing",
              "resourcenameid": "Category.ElementPlumbing",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 30
          },
          {
              "viewname": "onProjectElements_Electricity",
              "resourcenameid": "Category.ElementElectricity",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 32
          },
          {
              "viewname": "onProjectElements_Mechanical",
              "resourcenameid": "Category.ElementMechanical",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 34
          },
          {
              "viewname": "onProjectElements_Construction",
              "resourcenameid": "Category.ElementConstruction",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 35
          },
          {
              "viewname": "onProjectElements_Terrain",
              "resourcenameid": "Category.ElementTerrain",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 36
          },
          {
              "viewname": "onProjectElements_Inventary",
              "resourcenameid": "Category.ElementInventary",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 37
          },
          {
              "viewname": "onProjectElements_Structural",
              "resourcenameid": "Category.ElementStructural",
              "iconid": "IconFolder",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Element",
              "ordernr": 38
          },
          {
              "viewname": "onProjectElements_Clash",
              "resourcenameid": "Category.Collision",
              "iconid": "IconCollision",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Collision",
              "ordernr": 39
          },
          {
              "viewname": "onProjectIssues",
              "resourcenameid": "Category.Issue",
              "iconid": "IconIssue",
              "sortcolumns": null,
              "projectfilter": null,
              "objectname": "Issue",
              "ordernr": 41
          }
      ]

      Get information about an "Object Navigator" item (objectview)
        Resource: objectviews/<objectview_name> 

        URLhttps://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_name>

        Examplehttps://api-stage.bimplus.net/v2/bimplus/objectviews/onProjectElements_Building

         GET

         Get information about a particular objectview

        Headers
        Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
        Content-Type: application/json
        Status
        Status: 200 OK
        
        JSON
        [
            {
                "viewname": "onProjectElements_Building",
                "resourcenameid": "Category.ElementBuilding",
                "iconid": "IconArchitectureWall",
                "sortcolumns": null,
                "projectfilter": null,
                "objectname": "Element",
                "ordernr": "21"
            }
        ]

        Get the properties of the object (objectview)
          Resource: objectviews/<objectview_name>/properties 

          URLhttps://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_name>/properties

          Examplehttps://api-stage.bimplus.net/v2/bimplus/objectviews/onProjectElements_Building/properties

           GET

           Get the properties of a particular objectview

          Headers
          Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
          Content-Type: application/json
          Status
          Status: 200 OK
          
          JSON
          [
              {
                  "name": "ObjectID",
                  "ordernr": 1,
                  "datatype": "uniqueidentifier",
                  "isdefault": null,
                  "categorynameid": null,
                  "resourcenameid": null,
                  "proporder": null,
                  "converter": null,
                  "browsable": "false",
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Nr",
                  "ordernr": 2,
                  "datatype": "int",
                  "isdefault": null,
                  "categorynameid": "Category.General",
                  "resourcenameid": null,
                  "proporder": null,
                  "converter": null,
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Name",
                  "ordernr": 3,
                  "datatype": "nvarchar",
                  "isdefault": "true",
                  "categorynameid": "Category.General",
                  "resourcenameid": "Name",
                  "proporder": null,
                  "converter": "Converter_PPName",
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Description",
                  "ordernr": 4,
                  "datatype": "nvarchar",
                  "isdefault": "true",
                  "categorynameid": "Category.General",
                  "resourcenameid": "Description",
                  "proporder": null,
                  "converter": null,
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "DivisionID",
                  "ordernr": 5,
                  "datatype": "uniqueidentifier",
                  "isdefault": null,
                  "categorynameid": null,
                  "resourcenameid": null,
                  "proporder": null,
                  "converter": null,
                  "browsable": "false",
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Division",
                  "ordernr": 6,
                  "datatype": "nvarchar",
                  "isdefault": "true",
                  "categorynameid": "Category.General",
                  "resourcenameid": "Property.Model",
                  "proporder": null,
                  "converter": null,
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "ModelType",
                  "ordernr": 7,
                  "datatype": "uniqueidentifier",
                  "isdefault": "true",
                  "categorynameid": "Category.General",
                  "resourcenameid": "Property.Discipline",
                  "proporder": null,
                  "converter": "Converter_ElementType",
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "ElementTyp",
                  "ordernr": 8,
                  "datatype": "uniqueidentifier",
                  "isdefault": "true",
                  "categorynameid": "Category.General",
                  "resourcenameid": "Type",
                  "proporder": null,
                  "converter": "Converter_ElementType",
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Weight",
                  "ordernr": 9,
                  "datatype": "float",
                  "isdefault": null,
                  "categorynameid": "Category.Geometry",
                  "resourcenameid": "Mass",
                  "proporder": null,
                  "converter": "Converter_Mass",
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Volume",
                  "ordernr": 10,
                  "datatype": "float",
                  "isdefault": null,
                  "categorynameid": "Category.Geometry",
                  "resourcenameid": "Volume",
                  "proporder": null,
                  "converter": "Converter_Volume",
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Area",
                  "ordernr": 11,
                  "datatype": "float",
                  "isdefault": null,
                  "categorynameid": "Category.Geometry",
                  "resourcenameid": "Area",
                  "proporder": null,
                  "converter": "Converter_Area",
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Length",
                  "ordernr": 12,
                  "datatype": "float",
                  "isdefault": "true",
                  "categorynameid": "Category.Geometry",
                  "resourcenameid": "Element.Geometry.Length",
                  "proporder": null,
                  "converter": "Converter_Length",
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              },
              {
                  "name": "Width",
                  "ordernr": 13,
                  "datatype": "float",
                  "isdefault": "true",
                  "categorynameid": "Category.Geometry",
                  "resourcenameid": "Element.Geometry.Width",
                  "proporder": null,
                  "converter": "Converter_Length",
                  "browsable": null,
                  "iconid": null,
                  "filterable": null
              }
          ]

          Get the required object's(objectview's) details from input objectview list reference
            Resource: objectviews/content 

            URLhttps://api-stage.bimplus.net/v2/<team_slug>/objectviews/content 

            Examplehttps://api-stage.bimplus.net/v2/bimplus/objectviews/content

            JSON Structure

            Name

            Mandatory / Optional

            Type

            Description

            name

            mandatory

            string

            Name of the resource/objectview

            elementsguid

            optional

            object

            List of object id's whose details has to be found

            filter optional object The properties that could be used as filters


             POST
             Get the required objectview's details from input object list reference
            Headers
            Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
            Content-Type: application/json
            
            JSON
            {
                "name": "onProjectElements_Building",
                "elementsguid": [
                    "1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",
                    "54978C4C-B18B-4420-819D-405234FC11B4",
                    "EB0472BE-1353-4E47-BE76-875924E0586F"
                ],
                "filter": [
                    "ObjectId",
                    "DivisionId",
                    "Name",
                    "Width",
                    "ElementTyp"
                ]
            }
            Status
            Status: 200 OK
            
            JSON
            [
                {
                    "objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
                    "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
                    "name": "Wall",
                    "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
                    "width": 300
                },
                {
                    "objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
                    "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
                    "name": "Wall",
                    "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
                    "width": 300
                },
                {
                    "objectid": "eb0472be-1353-4e47-be76-875924e0586f",
                    "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
                    "name": "Wall",
                    "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
                    "width": 300
                }
            ]
               

              Delete the object view
                Resource: objectviews/<objectview_id>

                URLhttps://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_id>

                Examplehttps://api-stage.bimplus.net/v2/bimplus/objectviews/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

                 DELETE
                 Deletes a specified user defined view(object view).
                Headers
                Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                Content-Type: application/json
                
                Status
                Status: 200 OK
                

                Create a new hierarchy
                  Resource: usersettings/hierarchies/<hierarchy_id>

                  URLhttps://api-stage.bimplus.net/v2/<team_slug>/hierarchies/<hierarchy_id>

                  Examplehttps://api-stage.bimplus.net/v2/bimplus/hierarchies/aaaaa213-1a6e-4aa2-b032-d5aeb8f31c97

                  JSON Structure

                  Name

                  Mandatory / Optional

                  Type

                  Description

                   moduleId  mandatory string(guid)  Guid of the module

                  objectId

                  mandatory

                  string(guid)

                  Guid of the object type

                  userId mandatory string(guid) Guid of the user
                  category optional string Name of the category(default is "ObjectNavigator")
                  oneExtendedData mandatory object Additional information
                  valueKey mandatory string key name
                  valueName mandatory string Value of the key
                  value mandatory string Content of stored value
                  isDefault optional boolean Whether it is the default value
                  dataSmallInt optional integer Additional info about the value


                   POST
                   Create a new hierarchy
                  Headers
                  Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                  Content-Type: application/json
                  
                  JSON
                  {
                      "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
                      "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                      "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
                      "category": "ObjectNavigator",
                      "oneExtendedData": {
                          "valueKey": "[onProjectElements_Building]onProjectElements_Building",
                          "valueName": "test xxx",
                          "value": "[I]Name[I]Length[F][0]<1700[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
                          "isDefault": "0",
                          "dataSmallInt": "1"
                      }
                  }
                  Status
                  Status: 200 OK
                  
                  JSON
                  {
                      "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
                      "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                      "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
                      "category": "ObjectNavigator",
                      "oneExtendedData": {
                          "valueKey": "[onProjectElements_Building]onProjectElements_Building",
                          "valueName": "test xxx",
                          "value": "[I]Name[I]Length[F][0]<1700[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
                          "isDefault": "0",
                          "dataSmallInt": "1"
                      }
                  }

                  Create a list of hierarchies
                    Resource: usersettings/hierarchies?$operation=createlist

                    URLhttps://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=createlist

                    Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=createlist

                    JSON Structure

                    Name

                    Mandatory / Optional

                    Type

                    Description

                     moduleId  mandatory string(guid)  Guid of the module

                    objectId

                    mandatory

                    string(guid)

                    Guid of the object type

                    userId mandatory string(guid) Guid of the user
                    category optional string Name of the category(default is "ObjectNavigator")
                    oneExtendedData mandatory object Additional information
                    valueKey mandatory string key name
                    valueName mandatory string Value of the key
                    value mandatory string Content of stored value
                    isDefault optional boolean Whether it is the default value
                    dataSmallInt optional integer Additional info about the value


                     POST
                     Create a new hierarchy
                    Headers
                    Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                    Content-Type: application/json
                    
                    JSON
                    {
                        "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
                        "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                        "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
                        "category": "ObjectNavigator",
                        "extendedDataList": [
                            {
                                "userSettingId": "1FABF447-E511-4FC1-940B-D5AEB8F31C97",
                                "valueKey": "[onProjectElements_Building]onProjectElements_Building",
                                "valueName": "pokus 001",
                                "value": "[I]Name[I]Length[F][0]<7777[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
                                "isDefault": "false",
                                "dataSmallInt": "1"
                            },
                            {
                                "userSettingId": "53AB1047-E611-4FC1-940B-D5AEB8F31012",
                                "valueKey": "[onProjectElements_Building]onProjectElements_Building",
                                "valueName": "pokus 002",
                                "value": "[I]Name[I]Length[F][0]<2222[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
                                "isDefault": "false",
                                "dataSmallInt": "1"
                            }
                        ]
                    }
                    Status
                    Status: 200 OK
                    
                    JSON
                    {
                        "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
                        "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                        "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
                        "category": "ObjectNavigator",
                        "extendedDataList": [
                            {
                                "userSettingId": "1FABF447-E511-4FC1-940B-D5AEB8F31C97",
                                "valueKey": "[onProjectElements_Building]onProjectElements_Building",
                                "valueName": "pokus 001",
                                "value": "[I]Name[I]Length[F][0]<7777[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
                                "isDefault": "false",
                                "dataSmallInt": "1"
                            },
                            {
                                "userSettingId": "53AB1047-E611-4FC1-940B-D5AEB8F31012",
                                "valueKey": "[onProjectElements_Building]onProjectElements_Building",
                                "valueName": "pokus 002",
                                "value": "[I]Name[I]Length[F][0]<2222[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
                                "isDefault": "false",
                                "dataSmallInt": "1"
                            }
                        ]
                    }

                    Create a complete new hierarchy structure
                      Resource: services/applyhierarchy

                      URLhttps://api-stage.bimplus.net/v2/<team_slug>/services/applyhierarchy

                      Examplehttps://api-stage.bimplus.net/v2/bimplus/services/applyhierarchy

                      JSON Structure

                      Name

                      Mandatory / Optional

                      Type

                      Description

                       projectId  mandatory string(guid)  Id of the project for which the structure will be created

                      userSettingId

                      mandatory

                      string(guid)

                      Id of the user settings required for the hierarchy definition

                      hierarchyDefinition mandatory string Definition of the hierarchy
                      name mandatory string Name of the hierarchy
                      description optional string Description of the hierarchy
                      structureType optional string Structure type
                      elementsId optional Array of strings(guid) List of elements guid connected to the hierarchy structure


                       POST
                       Create a complete new hierarchy structure
                      Headers
                      Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                      Content-Type: application/json
                      
                      JSON
                      {
                          "runAsync": "false",
                          "applyHierarchy": {
                              "projectId": "01C52808-6561-47F6-833E-B62D05DA8A8E",
                              "hierarchyDefinition": "[I]tabAttribGeneral.Name[I]tabAttribGeometry.Length[I] tabAttribGeometry.Width[I][8807e401-6e3c-4536-88e1-e834d4de745d].Value",
                              "name": "Navigator 1",
                              "description": "Test for HierarchyNavigator",
                              "structureType": "CostStructure",
                              "elementsId": [
                                  "803312C0-26B6-49BE-A607-4319F1B32383",
                                  "51FEF0FA-437B-4410-B9BE-39B9E15D440F",
                                  "71D472FD-96A5-4174-8A5A-460DEB8E88E1"
                              ]
                          }
                      }
                      Status
                      Status: 201 CREATED
                      
                      JSON
                      {
                          "applyHierarchy": {
                              "projectId": "01c52808-6561-47f6-833e-b62d05da8a8e",
                              "hierarchyDefinition": "[I]tabAttribGeneral.Name[I]tabAttribGeometry.Length[I]tabAttribGeometry.Width[I] [8807e401-6e3c-4536-88e1-e834d4de745d].Value",
                              "name": "Navigator 1",
                              "description": "Test for HierarchyNavigator",
                              "structureType": "CostStructure",
                              "elementsId": [
                                  "803312c0-26b6-49be-a607-4319f1b32383",
                                  "51fef0fa-437b-4410-b9be-39b9e15d440f",
                                  "71d472fd-96a5-4174-8a5a-460deb8e88e1"
                              ],
                              "result": {
                                  "projectId": "01c52808-6561-47f6-833e-b62d05da8a8e",
                                  "parentId": "01c52808-6561-47f6-833e-b62d05da8a8e",
                                  "name": "Navigator 1",
                                  "description": "Test for HierarchyNavigator",
                                  "type": "CostStructure",
                                  "nr": 45,
                                  "color": 0,
                                  "id": "dd71620e-af8f-4496-88a5-cc2be1f1747d"
                              }
                          },
                          "runAsync": false
                      }

                      Get all the user hierarchies using the user & module information
                        Resource: usersettings/hierarchies?moduleId=xxx;userId=yyy;category=zzz

                        URLhttps://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?moduleId=xxx;userId=yyy;category=zzz

                        Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?moduleId=3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d;userId=a612e213-1a6e-4aa2-b032-d5aeb8f31c97;category=ObjectNavigator

                        JSON Structure

                        Name

                        Mandatory / Optional

                        Type

                        Description

                        moduleid

                        mandatory

                        guid

                        Id of the module

                        userid

                        mandatory

                        guid

                        Id of the user

                        category optional string category name (default category is "ObjectNavigator")


                         GET
                         Get all the user hierarchies using the user & module information
                        Headers
                        Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                        Content-Type: application/json
                        
                        Status
                        Status: 200 OK
                        
                        JSON
                        [
                            {
                                "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
                                "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
                                "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                                "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
                                "category": "ObjectNavigator",
                                "isdefault": false,
                                "valuekey": "[onProjectElements_Building]",
                                "valuename": "onProjectElements_Building",
                                "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
                                "datasmallint": null,
                                "revision": null
                            },
                            {
                                "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
                                "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
                                "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                                "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
                                "category": "ObjectNavigator",
                                "isdefault": false,
                                "valuekey": "[onProjectElements_Electricity]",
                                "valuename": "onProjectElements_Electricity",
                                "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
                                "datasmallint": null,
                                "revision": null
                            },
                            {
                                "attribusersettingid": "e4ca5278-98da-4809-9582-6815bbab2200",
                                "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
                                "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                                "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
                                "category": "ObjectNavigator",
                                "isdefault": false,
                                "valuekey": "[onProjectElements_MEP]",
                                "valuename": "onProjectElements_MEP",
                                "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Weight[I]Length[I]Width",
                                "datasmallint": 0,
                                "revision": null
                            }
                        ]

                        Get the details of a hierarchy
                          Resource: usersettings/hierarchies/hierarchy_id> 

                          URLhttps://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies/hierarchy_id>

                          Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies/B39AD364-F049-42E3-A936-3FD2871EB4D4

                           GET

                           Get information about a particular hierarchy

                          Headers
                          Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                          Content-Type: application/json
                          Status
                          Status: 200 OK
                          
                          JSON
                          {
                              "attribusersettingid": "b39ad364-f049-42e3-a936-3fd2871eb4d4",
                              "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
                              "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                              "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
                              "category": "ObjectNavigator",
                              "isdefault": false,
                              "valuekey": "[onProjectElements_Building]onProjectElements_Building",
                              "valuename": "Hierarchie Nr.1",
                              "value": "[I]Name[I]Length[F][0]<3000[2]>=215[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND[I]Width[F][0]<1000[2]>400[10]AND[11]AND[12]AND[13]AND[14]AND",
                              "datasmallint": 1,
                              "revision": null
                          }

                          Get details about a list of hierarchies
                            Resource: usersettings/hierarchies?$operation=getlist

                            URLhttps://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=getlist

                            Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=getlist

                            JSON Structure

                            Name

                            Mandatory / Optional

                            Type

                            Description

                            userSettingsListId

                            mandatory

                            object

                            List of hierarchy ids


                             GET

                             Get details about a list of hierarchies

                            Headers
                            Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                            Content-Type: application/json
                            JSON
                            {
                             "userSettingsListId": [
                             "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
                             "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
                             ]
                            }
                            Status
                            Status: 200 OK
                            
                            JSON
                            [
                                {
                                    "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
                                    "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
                                    "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                                    "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
                                    "category": "ObjectNavigator",
                                    "isdefault": false,
                                    "valuekey": "[onProjectElements_Building]",
                                    "valuename": "onProjectElements_Building",
                                    "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
                                    "datasmallint": null,
                                    "revision": null
                                },
                                {
                                    "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
                                    "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
                                    "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
                                    "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
                                    "category": "ObjectNavigator",
                                    "isdefault": false,
                                    "valuekey": "[onProjectElements_Electricity]",
                                    "valuename": "onProjectElements_Electricity",
                                    "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
                                    "datasmallint": null,
                                    "revision": null
                                }
                            ]

                            Delete the hierarchy
                              Resource: usersettings/hierarchies/<hierarchy_id>

                              URLhttps://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies/<hierarchy_id>

                              Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

                               DELETE
                               Deletes a specific hierarchy.
                              Headers
                              Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                              Content-Type: application/json
                              
                              Status
                              Status: 200 OK
                              

                              Delete the list of hierarchies
                                Resource: usersettings/hierarchies?$operation=deletelist

                                URLhttps://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=deletelist

                                Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=deletelist

                                JSON Structure

                                Name

                                Mandatory / Optional

                                Type

                                Description

                                userSettingsListId

                                mandatory

                                object

                                List of hierarchy ids that has to be deleted


                                 DELETE
                                 Deletes the list of hierarchies as specified in the request
                                Headers
                                Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                                Content-Type: application/json
                                
                                JSON
                                {
                                 "userSettingsListId": [
                                 "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
                                 "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
                                 ]
                                }
                                Status
                                Status: 200 OK
                                

                                Delete all the hierarchies filtered by additional info
                                  Resource: usersettings/hierarchies?moduleId=xxx;userId=<yyy>;category=<name>;objectId=<zzz>

                                  URLhttps://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?moduleId=<xxx>;userId=<yyy>;category=<name>;objectId=<zzz>

                                  Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?moduleId=3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d;userId=a612e213-1a6e-4aa2-b032-d5aeb8f31c97;category=ObjectNavigator;objectId=1F15C447-E511-4FC1-940B-13639F973C52

                                  JSON Structure

                                  Name

                                  Mandatory / Optional

                                  Type

                                  Description

                                  moduleId

                                  mandatory

                                  string(guid)

                                  Id of the module

                                  userId mandatory string(guid) Id of the user
                                  objectId optional string(guid) Id of the object (default is "1F15C447-E511-4FC1-940B-13639F973C52")
                                  Category optional string Name of the category (default is "ObjectNavigator")


                                   DELETE
                                   Deletes all the hierarchies filtered by additional info specified as query strings.
                                  Headers
                                  Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                                  Content-Type: application/json
                                  
                                  JSON
                                  {
                                   "userSettingsListId": [
                                   "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
                                   "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
                                   ]
                                  }
                                  Status
                                  Status: 200 OK
                                  
                                  • No labels