Versions Compared

Key

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

...

Deck of Cards
idbimGetAllRights
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/rights 

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

Examplehttps://api-stage.bimplus.net/v2/best-company/rights

Card
labelHTTP Method
 GET
Card
labelDescription

 Get all the available rights. Right now, we support only project based roles and custom roles.

Here is the definition of Bimplus Rights & Roles.

Model rights and roles are not supported yet, the project rights are used instead - meaning e.g. update model requires ProjectEdit rights

The custom roles contains also definition for which resource and rights are valid.

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
[{
    "resource":"UserRightModel",
    "rights":["Model_Assign",
      "Model_Admin",
      "Model_Delete",
      "Model_Edit",
      "Model_View",
      "Model_Import"
    ]
  },
  {
    "resource":"UserRightProject",
    "rights":["Model_ViewAll",
      "Model_Create",
      "Project_Right",
      "Project_AllDocuments"
    ]
  },
  {
    "resource":"UserRightGlobal",
    "rights":["AllProjects",
      "AllModels",
      "Project_Delete",
      "Project_Create",
      "AllDocuments",
      "AllAttributes"
    ]
  },
  {
    "resource":"UserRightDocument",
    "rights":["Document_Update",
      "Document_Delete",
      "Document_Share",
      "Document_DownloadDenied",
      "Document_ViewDenied"
    ]
  },
  {
    "resource":"UserRightGlobalFreeAttributes",
    "rights":["FreeAttributeEdit",
      "FreeAttributeGroupEdit",
      "AttributeTemplateEdit",
      "ProjectAttributeTemplateEdit",
      "FreeAttributeView",
      "FreeAttributeGroupView",
      "AttributeTemplateView",
      "ProjectAttributeTemplateView",
      "TeamMembershipEdit",
      "TeamMembershipView",
      "StructuralAction_Editor",
      "StructuralAction_Viewer",
      "Precast_Editor",
      "Precast_Viewer",
      "Bridge_Editor",
      "Bridge_Viewer",
      "DoorWindow_Editor",
      "DoorWindow_Viewer",
      "Holzbauobjekte_Editor",
      "Holzbauobjekte_Viewer",
      "BuildingModel_Editor",
      "BuildingModel_Viewer",
      "Opening_Editor",
      "Opening_Viewer",
      "Inventary_Editor",
      "Inventary_Viewer",
      "TerrainModel_Editor",
      "TerrainModel_Viewer",
      "Stahlbauobjekte_Editor",
      "Stahlbauobjekte_Viewer",
      "MEP_Editor",
      "MEP_Viewer",
      "CollisionModel_Editor",
      "CollisionModel_Viewer",
      "Connection_Editor",
      "Connection_Viewer",
      "Proxy Model_Editor",
      "Proxy Model_Viewer",
      "Finish_Editor",
      "Finish_Viewer",
      "DesignModel_Concrete_Construction_Editor",
      "DesignModel_Concrete_Construction_Viewer",
      "Room_Editor",
      "Room_Viewer",
      "StructuralAnalysis_Editor",
      "StructuralAnalysis_Viewer",
      "RevisionComparison_Editor",
      "RevisionComparison_Viewer"
    ]
  },
  {
    "resource":"UserRightLayer",
    "rights":["StructuralAction_Right",
      "Precast_Right",
      "Bridge_Right",
      "DoorWindow_Right",
      "Holzbauobjekte_Right",
      "BuildingModel_Right",
      "Opening_Right",
      "Inventary_Right",
      "TerrainModel_Right",
      "Stahlbauobjekte_Right",
      "MEP_Right",
      "CollisionModel_Right",
      "Connection_Right",
      "Proxy Model_Right",
      "Finish_Right",
      "DesignModel_Concrete_Construction_Right",
      "Room_Right",
      "StructuralAnalysis_Right",
      "RevisionComparison_Right"
    ]
  }
]

...