...
- Create a new project
- Get the logged in user's project list
- Get the user's project list from a team
- Get the properties of the project
- Update the project
- Create an issue in the project with a view
- Get the issue list from the project
- Delete all the issues from the project
- Create a new attachment in the project
- Get the attachment list from the project
- Delete all the attachments from the project
- Create a new objecttype in the project
- Get all objecttypes from the project
- Update the objecttype
- Get the objecttype
- Delete the objecttype
- Get the project topology
- Get the project layers
- Get material surfaces of the project
- Get the spot list from the project
- Create / Upload a thumbnail to the project
- Download the thumbnail
- Get the structure list from the project
- Delete all the structures from the project
- Get the topology of all structures belonging to the project
- Get all the comments, hyperlinks from the project
- Delete the project
- Get project actions rights
- Filtering and paging
...
| Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||
Card |
|
...
Create a new objecttype in the project
...
| id | bimCreateObjectTypeInProject |
|---|
...
| label | URL / Resource / JSON Structure |
|---|
Resource: projects/<project_id>/objecttypes
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/objecttypes
Example: https://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes
JSON Structure:
...
Name
...
Mandatory / Optional
...
Type
...
Description
...
name
...
mandatory
...
string
...
Name of the objecttype
...
description
...
optional
...
string
...
Description of the objecttype
...
| Card | ||
|---|---|---|
| ||
| POST |
| Card | ||
|---|---|---|
| ||
| Creates a new objecttype in a project. |
...
| label | Request |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name":"UpdateTestObjectType",
"definedBy":[{
"id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
},
{
"id":"2e5d5f07-6431-4bc6-b17c-49b5b8c585b7"
}
]
}
|
...
| label | Response |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id":"c7d15b4e-02da-42c6-a1be-9082d3668cda",
"projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
"type":"ModelType",
"name":"TestObjectType",
"customModeType":true,
"definedBy":[{
"name":"CommonMEP",
"id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
},
{
"name":"Heating",
"id":"2e5d5f07-6431-4bc6-b17c-49b5b8c585b7"
}
]
} |
...
Get all objecttypes from the project
...
| id | bimGetObjectTypesFromProject |
|---|
...
| default | true |
|---|---|
| label | URL / Resource / JSON Structure |
...
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/objecttypes
Example: https://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes
Optional query parameters:
Following query parameter allows reduce set of returned objecttypes. By default will be returned all defined objecttypes of the project.
...
Name
...
Type
...
Default value
...
Description
...
type
...
string
...
none
...
| Card | ||
|---|---|---|
| ||
| GET |
| Card | ||
|---|---|---|
| ||
Get allobjecttypes belonging to a specified project. |
...
| label | Request |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
| label | Response |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[{
"id":"ef37183d-8c74-473a-80de-03ba98b9eb6d",
"projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
"type":"DocumentType",
"name":"Report",
"description":"documenttype",
"customModeType":true
},
{
"id":"d4d2204a-6352-4252-8b44-3746c0d7fd16",
"projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
"type":"DocumentType",
"name":"5486",
"customModeType":true
},
{
"id":"0b329478-6643-474c-b580-41ccc9dad750",
"projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
"type":"DocumentType",
"name":"Specification",
"description":"documenttype",
"customModeType":true
},
{
"id":"90d5c7d8-2430-4c87-984e-76ae4e8dd72a",
"projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
"type":"DocumentType",
"name":"Presentation",
"description":"documenttype",
"customModeType":true
},
{
"id":"64b85111-8570-45ca-9c30-86f85bfb666f",
"projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
"type":"DocumentType",
"name":"Contract",
"description":"documenttype",
"customModeType":true
},
...
] |
...
Update the objecttype
...
| id | bimUpdateObjectType |
|---|
| Card | ||||
|---|---|---|---|---|
| ||||
Resource: objecttypes/<objecttype_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/objecttypes/<objecttype_id> Example: https://api-stage.bimplus.net/v2/bimplus/objecttypes/c7d15b4e-02da-42c6-a1be-9082d3668cda JSON Structure: See Create a new objecttype in the project |
| Card | ||
|---|---|---|
| ||
| PUT |
| Card | ||
|---|---|---|
| ||
| Update properties of the specified objecttype. |
...
| label | Request |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name":"UpdateTestModelType",
"description":"update",
"definedBy":[{
"id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
}
]
} |
...
| label | Response |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
| Code Block | ||
|---|---|---|
| ||
{
"id":"c7d15b4e-02da-42c6-a1be-9082d3668cda",
"projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
"type":"ModelType",
"name":"UpdateTestModelType",
"description":"update",
"customModeType":false,
"definedBy":[{
"name":"CommonMEP",
"id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
}
]
} |
...
Get the objecttype
...
| id | bimGetObjectType |
|---|
| Card | ||||
|---|---|---|---|---|
| ||||
Resource: objecttypes/<objecttype_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/objecttypes/<objecttype_id> Example: https://api-stage.bimplus.net/v2/bimplus/objecttypes/c7d15b4e-02da-42c6-a1be-9082d3668cda |
| Card | ||
|---|---|---|
| ||
| GET |
| Card | ||
|---|---|---|
| ||
Get requested objecttype |
...
| label | Request |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
| label | Response |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id":"c7d15b4e-02da-42c6-a1be-9082d3668cda",
"projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
"type":"ModelType",
"name":"UpdateTestModelType",
"description":"update",
"customModeType":true,
"definedBy":[{
"name":"CommonMEP",
"id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
}
]
} |
...
Delete the objecttype
| Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
...