Page History

Versions Compared

Key

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

...

Delete Project

Deck of Cards

id	bimGetAllRoles

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/best-company/roles

Card

label	HTTP Method

GET

Card

label	Description

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

Here is the definition of Bimplus Rights & Roles.

Account

Owner

Project

Admin

Project

Editor

Project

Viewer

Model
Admin

Model
Editor

Model
Viewer

Create Project

Create project	x
Admin

Project (eg. invite)

project	x	x
Delete project	x

x
Edit

Project

project

View project

Create model

x
View

Projectxxxxxxx View all Modelsxxxx Create Modelxxx Admin Model (eg. invite)xx Assign User to Modelxxx x Edit Modelxxx xx Import Dataxxx xx Delete Model

all models

View Modelxxxxxxx

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

Card

label	Request

Code Block

borderColor	Green
titlelang	Headersxml
langtitle	xmlHeaders

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

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

[
    {
        "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
        "name": "Project_Editor",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Edit",
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    },
    {
        "id": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c",
        "name": "Account_Owner",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightGlobal",
                "rights": [
                    "AllProjects",
                    "AllModels",
                    "Project_Create"
                ]
            }
        ]
    },
    {
        "id": "a298b28d-9711-4a76-9a7d-910cbf144ee5",
        "name": "Project_Admin",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Admin",
                    "Project_Edit",
                    "Project_Delete",
                    "Project_View",
                    "Model_ViewAll",
                    "Model_Create"
                ]
            }
        ]
    },
    {
        "id": "a618d075-7e4a-4bde-9d58-d2979696fa96",
        "name": "Project_Viewer",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    }
]

...

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
id	mandatory	string (guid)	Id of the user
role	mandatory	object	The project role which will be assigned to the team member
id	mandatory	string (guid)	Id of the role

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	lang	xml

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

Code Block

lang

borderColor	Red
lang	xml
title	JSON	xml

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25"
  },
  role: {
    id: "f11d32e2-30b7-4f81-8a74-2165ecc00cf6"
}

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

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

...

Deck of Cards

id	bimGetMembersWithRoles

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

Card

label	HTTP Method

GET

Card

label	Description

Get the member list of a project along with their respective project roles.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

[
    {
        "member": {
            "id": "7aa846f2-6014-f68d-8dd4-4c7941d7cbcc",
            "email": "customer1@bimplus.net"
        },
        "role": {
            "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Editor"
        }
    },
    {
        "member": {
            "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
            "email": "customer2@bimplus.net"
        },
        "role": {
            "id": "e11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Viewer"
        }
    }
]

...

Deck of Cards

id	bimUpdateProject

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
id	mandatory	string (guid)	Id of the user
role	mandatory	object	The project role which will be assigned to the team member
id	mandatory	string (guid)	Id of the role

Card

label	HTTP Method

PUT

Card

label	Description

Update the project role of a team member. 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	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "customer@bimplus.net"
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Viewer"
}

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 200 OK

Anchor

	deleteProjectRole
	deleteProjectRole

...

Deck of Cards

id	bimdeleteProjectRole

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

Card

label	HTTP Method

DELETE

Card

label	Description

Remove the user from a project

Card

label	Request

Code Block

lang

borderColor	Green
lang	xml
title	Headers	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 3

New Version 4

Key