Versions Compared

Old Version 524

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 525

changes.mady.by.user Jayaraj Purushothaman

Saved on

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

 

Anchor
projectService
projectService

...

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

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

Example: https://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
deleteHierarchy
deleteHierarchy

Delete the hierarchy
Deck of Cards
idbimDeleteHierarchy
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: usersettings/hierarchies/<hierarchy_id>

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

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

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Deletes a specific hierarchy.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
deleteHierarchyList
deleteHierarchyList

Delete the list of hierarchies
Deck of Cards
idbimDeleteHierarchyList
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: usersettings/hierarchies?$operation=deletelist

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

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

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Deletes a specified user defined view(object view).
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK