Versions Compared

Old Version 33

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 34

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...

Deck of Cards
idbimGetAllProjectRolesFromRightsAndRolesTemplate


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/roles 

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/roles 

Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/roles

JSON Structure: The structure of object is the same as in get all available roles

Name

Mandatory / Optional

Type

Description

member

mandatory

object

The member who will be assigned a role to the project.
The object has a mandatory property name "id" which represents Id of the user, its type is string(guid)

role

mandatory

object

The project role which will be assigned to the team member.
The object has a mandatory property name "id" which represents Id of the role, its type is string(guid)

Card
labelHTTP Method
 POST
Card
labelDescription
 Assign a project role to an existing member of a team. Only the user with "Account Owner" or "Project Owner" role can use this API call.

.
The rightsandrolestemplate query parameter should not be used, due to it is implicitly set to actual project rights and roles template id.


Card
labelHTTP Method
 GET


Card
labelDescription

Each project has by default assigned free attribute "RightsAndRoles template" which defines rights and roles template.

The API call will returns all project's roles assigned by rights and roles template.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
  "member": {
    "id" : "bf5b2382-1d14-b8df-8454-947f83b45c25"
  },
  role: {
    "id" : "f11d32e2-30b7-4f81-8a74-2165ecc00cf6"
}
Card
labelResponse
JSON
[
    {
        "id": "94a60a79-7c81-454b-8158-ffdb9a2bf4d6",
        "name": "TEST1",
        "customRole": true,
        "resources": [
            {
                "id": "4e587ea1-5098-45cd-9655-15f90c16dc58",
                "resource": "Layer",
                "rights": [
                    "RoomModel"
                ],
                "rightsAccess": [
                    {
                        "id": "52bbc329-dab3-a81c-b548-09c715786a81",
                        "name": "RoomModel",
                        "access": "Edit"
                    }
                ]
            }
        ],
        "projectRightsRolesTemplate": {
            "id": "482176be-84ab-4d8f-93e4-2c58863d4eae",
            "name": "DefaultProjectRightsRolesTemplate",
            "description": "Default template for rights and roles"
        }
    },
    {
        "id": "391fb0fc-43ec-464c-bd18-b5223b32bd14",
        "name": "TEST2",
        "customRole": true,
        "resources": [
            {
                "id": "9dae8bb5-77c1-47a6-a916-d4948583b0b9",
                "resource": "Global",
                "rights": [
                    "AllModels",
                    "ProjectCreate",
                    "AllAttributes"
                ],
                "rightsAccess": [
                    {
                        "id": "cc3416d3-c570-4dc6-aa84-72216d3f58da",
                        "name": "AllModels",
                        "access": "Edit"
                    },
                    {
                        "id": "6bbc401b-7cd5-4684-a11d-e2448befb3c1",
                        "name": "ProjectCreate",
                        "access": "Edit"
                    },
                    {
                        "id": "99bad6fc-0539-4848-84af-62b6df31eaa3",
                        "name": "AllAttributes",
                        "access": "Edit"
                    }
                ]
            }
        ],
        "projectRightsRolesTemplate
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
        "emailid": "testuser@bimplus.net482176be-84ab-4d8f-93e4-2c58863d4eae",
     "firstname"  : "Test",
    "lastnamename" : "UserDefaultProjectRightsRolesTemplate",
    ...
      },
  "roledescription": {
"Default template for rights "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",and roles"
    "name": "Project_Editor"
}    }
    }
...
]



Anchor
assignProjectRole
assignProjectRole

...