Versions Compared

Key

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

...

Section
Column
width25%

Messaging Service


Column
width25%

Log Service


Column
width50%

Bimplus Windows Explorer related Services


...

Deck of Cards
idbimGetAllUserHierarchies
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: usersettings/heirarchies?moduleId=xxx;userId=yyy;category=zzz

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

Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchies?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

categoryoptionalstringcategory name (default category is "ObjectNavigator")


Card
labelHTTP Method
 GET
Card
labelDescription
 Get all the user hierarchies using the user & module information
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "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
    }
]

Anchor
getHierarchyDetails
getHierarchyDetails

Get the details of a hierarchy
Deck of Cards
idbimGetHierarchyDetails
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: usersettings/heirarchies/hierarchy_id> 

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

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

Card
labelHTTP Method
 GET
Card
labelDescription

 Get information about a particular objectview

Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "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
}

Anchor
deleteHierarchy
deleteHierarchy

...