Page History

...

Deck of Cards

id	bimCreateNewRole

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles

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

Example: https://api-stage.bimplus.net/v2/bimplus/roles

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	optional	string (guid)	Id of the role
name	mandatory	string	The name of the role
parent	optional	string (guid)	The Id of the parent role
customRole	optional	boolean	When this flag is true the role is custom role otherwise will role is 'built in' role
resources	optional	JSON Array	Array of the right resource type definition objects for which the role is valid
projectRightsRolesTemplate	mandatory	JSON object	The object contains id of rights and roles template guid.

JSON Structure of the right resource type definition object:

Name	Mandatory / Optional	Type	Description
id	optional	string(Guid)	Id of the right resource type
resource	mandatory	string	Describe kind of right resource type e.g. Global" or "Layer", etc.
rights	mandatory	JSON Array	Array of the strings with right names e.g.: "FreeAttributeView", "RoomModel"
rightsAccess	mandatory	JSON Array	Array of the objects with properties id, name, access : id is string (Guid) represent id of right name is string representing name of right e.g. "RoomModel", access is string representing access right of the right e.g. "View"

Card

label	HTTP Method

POST

Card

label	Description

Creates a new role with defined properties and resources to be valid for.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name":"Test",
  "customRole":true,
  "resources":[{
      "id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
      "resource":"Layer",
      "rights":["Room"
      ],
      "rightsAccess":[{
          "id":"52bbc329-dab3-a81c-b548-09c715786a81",
          "name":"RoomModel",
          "access":"Edit"
        }
      ]
    }
  ],
  "projectRightsRolesTemplate":{
    "id":"894072db-e1cb-48f1-a672-999356d66311"
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id": "94a60a79-7c81-454b-8158-ffdb9a2bf4d6",
  "name":"Test",
  "customRole":true,
  "resources":[{
      "id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
      "resource":"Layer",
      "rights":["Room"
      ],
      "rightsAccess":[{
          "id":"52bbc329-dab3-a81c-b548-09c715786a81",
          "name":"RoomModel",
          "access":"Edit"
        }
      ]
    }
  ],
  "projectRightsRolesTemplate":{
    "id":"894072db-e1cb-48f1-a672-999356d66311",
    "name":"CustomProjectRightsRolesTemplate",
    "description":"Custom template for rights and roles"
  }
}

...

Deck of Cards

id	bimGetRoleDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles/<role_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/roles/213becc094a60a79-ad487c81-4cd0454b-aef28158-b922b21bbfd7ffdb9a2bf4d6

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified role.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id" : "94a60a79-7c81-454b-8158-ffdb9a2bf4d6",
  "name":"Test",
  "customRole":true,
  "resources":[{
      "id":"52bbc3294e587ea1-dab35098-a81c45cd-b5489655-09c715786a8115f90c16dc58",
      "resource":"UserRightLayerLayer",
      "rights":["Room"
      ],
      "rightsAccess":[{
          "id":"4e587ea152bbc329-5098dab3-45cda81c-9655b548-15f90c16dc5809c715786a81",
          "name":"RoomRoomModel",
          "access":"ViewEdit"
        }
      ]
    }
  ]
}

,
  "projectRightsRolesTemplate":{
    "id":"894072db-e1cb-48f1-a672-999356d66311",
    "name":"CustomProjectRightsRolesTemplate",
    "description":"Custom template for rights and roles"
  }
}

Anchor


	updateTheRole

Anchor

updateTheRole

Update the role

Deck of Cards

id	bimUpdateTheRole

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles/<role_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/roles/213becc094a60a79-ad487c81-4cd0454b-aef28158-b922b21bbfd7ffdb9a2bf4d6

Json structure : See above in Create a new role section.

Card

label	HTTP Method

PUT

Card

label	Description

Update the role.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name":"Test",
  "customRole":true,
  "resources":[{
      "id":"52bbc3294e587ea1-dab35098-a81c45cd-b5489655-09c715786a8115f90c16dc58",
      "resource":"UserRightLayerLayer",
      "rights":["Room"
      ],
      "rightsAccess":[{
          "id":"4e587ea152bbc329-5098dab3-45cda81c-9655b548-15f90c16dc5809c715786a81",
          "name":"RoomRoomModel",
          "access":"ViewEdit"
        }
      ]
    }
  ]
},
  "projectRightsRolesTemplate":{
    "id":"894072db-e1cb-48f1-a672-999356d66311"
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "id" : "94a60a79-7c81-454b-8158-ffdb9a2bf4d6",
  "name":"Test",
  "customRole":true,
  "resources":[{
      "id":"52bbc3294e587ea1-dab35098-a81c45cd-b5489655-09c715786a8115f90c16dc58",
      "resource":"UserRightLayerLayer",
      "rights":["Room"
      ],
      "rightsAccess":[{
          "id":"4e587ea152bbc329-5098dab3-45cda81c-9655b548-15f90c16dc5809c715786a81",
          "name":"RoomRoomModel",
          "access":"ViewEdit"
        }
      ]
    }
  ]
}

...

,
  "projectRightsRolesTemplate":{
    "id":"894072db-e1cb-48f1-a672-999356d66311",
    "name":"CustomProjectRightsRolesTemplate",
    "description":"Custom template for rights and roles"
  }
}

Anchor

	deleteTheRole
	deleteTheRole

Delete

...

Delete the role

Deck of Cards

id	bimDeleteTheRole

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles/<role_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/roles/213becc0-ad48-4cd0-aef2-b922b21bbfd7

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified role.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Deck of Cards

id	bimassignProjectRole

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/members

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

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

JSON Structure:

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)
roles	mandatory	JSON Array	Array of role objects, each object must have defined role id.

Card

label	HTTP Method

POST

Card

label	Description

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.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "member": {
    "id" : "bf5b2382-1d14-b8df-8454-947f83b45c25",
  },
  "role": {
    "id" : "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
}  }
  "roles":[
    {
      "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    },
    {
      "id":"391fb0fc-43ec-464c-bd18-b5223b32bd14",
    },
    {
      "id":"33078aed-0473-4714-beb9-ab989959afdd",
    }
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	Status

Status: 201 Created

	JSON

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "testuser@bimplus.net",
    "firstname" : "Test",
    "lastname" : "User",
    ...
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Editor"
  }
  "roles":[
    {

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "member": {
    "id": "bf5b2382f11d32e2-1d1430b7-b8df4f81-84548a74-947f83b45c252165ecc00cf6",
      "emailname": "testuser@bimplus.net"Project_Editor"
    },
    "firstname" : "Test{
      "id":"391fb0fc-43ec-464c-bd18-b5223b32bd14",
      "lastnamename" : "UserArchitekt",
    ...
  },
  "role":  {
      "id": "f11d32e233078aed-30b70473-4f814714-8a74beb9-2165ecc00cf6ab989959afdd",
      "name": "Project_Editor"BuildingEditor"
    }
  ]
}

Anchor

	getMembersWithRoles
	getMembersWithRoles

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 35

New Version 36

Key

Update the role

Delete

Delete the role