Versions Compared

Old Version 30

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 31

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...

Deck of Cards
idbimDeleteTheRole


Card
defaulttrue
labelURL / 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
labelHTTP Method
 DELETE


Card
labelDescription
 Deletes a specified role.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



Anchor
getAllProjectRolesFromRightsAndRolesTemplate
getAllProjectRolesFromRightsAndRolesTemplate

Get all project's roles assigned by right and roles template
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.


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


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
{
  "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"
}



Anchor
assignProjectRole
assignProjectRole

...