...
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: projects/<project_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id> Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e |
| Card |
|---|
| | Deletes a specified project. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
|
|
| Anchor |
|---|
| ProjectActionsRights |
|---|
| ProjectActionsRights |
|---|
|
Get project actions rights
| Deck of Cards |
|---|
| id | bimProjectActionsRights |
|---|
|
| Card |
|---|
| Purpose of this API call is to get required project rights for a Bimplus action.
This is a static API call, meaning it's global for all the projects, and the response can only change after the deploy. Returns list of pairs of :
- name of the action ( event )
- required right the user must have for a project, to be able to execute that action Currently used project rights are:
- ProjectAdmin
- ProjectDelete
- ProjectEdit
- ProjectView
- ModelViewAll
- ModelCreate Clients can use this API to automatically handle access to Bimplus actions according to the role the user have in the project, e.g. enable/disable action buttons, ... And if Bimplus server will decide to change required project user rights for some action, this change will be reflected on the client automatically, without having to change the client's code. Important note: - this call does not includes all the Bimplus actions, but mostly those related to project and issues : actions of projects, models, issues, attachments, comments, pins, slides, slideshows, bcf, ..
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| [
{
"action": "UPDATE_PROJECT",
"right": "ProjectEdit"
},
{
"action": "DELETE_PROJECT",
"right": "ProjectDelete"
},
{
"action": "CREATE_MODEL",
"right": "ModelCreate"
},
{
"action": "UPDATE_MODEL",
"right": "ProjectEdit"
},
{
"action": "GET_MODEL",
"right": "ProjectView"
},
{
"action": "DELETE_MODEL",
"right": "ProjectEdit"
},
{
"action": "DOWNLOAD_MODEL",
"right": "ProjectView"
},
{
"action": "CREATE_ISSUE",
"right": "ProjectEdit"
},
{
"action": "GET_PROJECT_ISSUES",
"right": "ProjectView"
},
{
"action": "DELETE_PROJECT_ISSUES",
"right": "ProjectAdmin"
},
{
"action": "CREATE_COMMENT",
"right": "ProjectEdit"
},
...
] |
|
|
| Anchor |
|---|
| FilteringAndPaging |
|---|
| FilteringAndPaging |
|---|
|
Filtering and paging
Filtering and paging is implemented for following requests:
...