Project Service
...
- Create a new project
- Create copy of the source 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
- Create a new attachment in the project using chunked upload
- Get the attachment list from the project
- Delete all the attachments from the project
- 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
...
Anchor | ||||
---|---|---|---|---|
|
...
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
...
Create copy of the source project
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Card |
|
Anchor | ||||
---|---|---|---|---|
|
Get the logged in user's project List
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get the user's project list from a team
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
This call also supports filtering and paging Card |
|
Anchor | ||||
---|---|---|---|---|
|
Get the user's project list from a team
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get the Project Properties
Deck of Cards | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Card | | |||||||||||||||||
| ||||||||||||||||||
Name | Type | Default value | Description | |||||||||||||||
disciplines | string (bool) | true | When query parameter "disciplines=false" is defined, the API will return project properties except "disciplines" project property. Otherwise if query parameter "disciplines" is true (this is default) or is missing the call will return all project properties. |
Card | ||
---|---|---|
| ||
GET |
Card | ||
---|---|---|
| ||
Get all the project properties of a project using its id. |
Card | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "name" : "Your Awesome Building", "shortDescr" : "Example for creating a project" "teamName": "jay-company", "teamSlug": "jay-company", "hasWriteAccess": true, "thumbnail": "/jay-company/projects/de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a/thumbnail/download", "created": "2014-02-14T09:48:27", "createdby": { { "id": "4e87944a-a477-4e4c-862e-e723dcb43066", "name": "UC_Fly-over Kerensheide", "shortDescr": "", "thumbnail": "", "created": "2013-05-10T07:13:38", "createdby" : { "id": "bda91f09-2cc6-45da-bba0-5f92828f58bc", "email" : "UserA@bimplus.net" }, "changed": "2013-05-16T07:34:56", "changedby" : { "id": "7c555899-5a5f-44d1-930e-284930678bed", "email" : "testuser@bimplus.net" }, "idaddress" : "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed", "emailhasWriteAccess": "jayaraj.purushothaman@gmail.com"true, }, "changedteamSlug": "2015-11-19T09:45:51best-company", "changedbymodelCount": {2, "idmemberCount": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"3, "emailsize": "jayaraj.purushothaman@gmail.com"63488, }, "addresssizeMB": "0,06", "modelCountrights": 1,{ "memberCount": 7, "topicCount": 30, "attachmentCountprojectAdmin": 13false, "size": 99317760, "sizeMB": "94,72", "disciplinesprojectDelete": [false, { "id"projectEdit": "0f106af0-a919-44c5-b211-15bd5ef620b6"true, "namemodelsCreate": "ID_BuildingModel"false, "divisionIdmodelsViewAll": "b539790e-2ffc-43cd-9582-b4aa27b36693",true } } ] |
Anchor | ||||
---|---|---|---|---|
|
Get the Project Properties
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
Anchor | ||||
---|---|---|---|---|
|
Update the project
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Create an issue in the project with a view
See Create Issue in Topic Service
Anchor | ||||
---|---|---|---|---|
|
Get the Issue List from the project
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Delete all the issues from the project
Deck of Cards | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
|
...
Update the project
Deck of Cards | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Card | | ||||||||
| |||||||||
Name | Mandatory / Optional | Type | Description | ||||||
id | will be ignored | string (guid) | Id of the project | ||||||
name | mandatory | string | Name of the project | ||||||
shortDescr | optional | string | Short description of the project | ||||||
teamName | will be ignored | string | Name of the team to which the project belongs | ||||||
teamSlug | will be ignored | string | Slug of the team to which the project belongs | ||||||
hasWriteAccess | will be ignored | boolean | Don't use this property. This property is not deleted to support the older clients | ||||||
created | will be ignored | string (date) | Creation date of the project | ||||||
createdBy | will be ignored | JSON object | Details of the Bimplus user who has created the project | ||||||
changed | will be ignored | string(date) | Modified date of the project | ||||||
changedBy | will be ignored | JSON object | Details of the Bimplus user who has created the project | ||||||
address | optional | string | Address of the project | ||||||
modelCount | will be ignored | int | Number of models in this project | ||||||
memberCount | will be ignored | int | Number of members in this project | ||||||
topicCount | will be ignored | int | Number of topics in this project | ||||||
attachmentCount | will be ignored | int | Number of attachments in this project | ||||||
size | will be ignored | int | Size of the project in bytes | ||||||
sizeInMB | will be ignored | string | Size of the project in MB | ||||||
disciplines | will be ignored | JSON object | Disciplines found under this project | ||||||
rights | will be ignored | JSON object | The rights the user has for this project |
Card | ||
---|---|---|
| ||
PUT |
Card | ||
---|---|---|
| ||
Update properties of the specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
| |||||||||
Card | |||||||||
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||
---|---|---|
| ||
{
"name" : "Your Awesome Building updated",
"shortDescr" : "Example for updating a project",
"teamName": "Best Company",
"teamSlug": "best-company",
"hasWriteAccess" : true,
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"createdby" : {
"id": "7c555899-5a5f-44d1-930e-284930678bed",
"email" : "testuser@bimplus.net"
},
"changed": "2013-06-02T10:04:15",
"changedby" : {
"id": "7c555899-5a5f-44d1-930e-284930678bed",
"email" : "testuser@bimplus.net"
},
"address" : "Changed address",
"modelCount": 0,
"memberCount": 1,
"topicCount": 0,
"attachmentCount": 0,
"size": 0,
"sizeMB": "0",
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
} |
...
|
Anchor | ||||
---|---|---|---|---|
|
Create a new attachment in the project
Deck of Cards | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
|
...
Create an issue in the project with a view
See Create Issue in Topic Service
...
Get the Issue List from the project
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
This call also supports filtering and paging
Card |
|
...
Delete all the issues from the project
Deck of Cards | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
Card | | ||||||||||||||||||
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
|
Anchor | ||||
---|---|---|---|---|
| ||||
Anchor | ||||
|
Create a new attachment in the project using chunked upload
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
Filtering and paging
...
Filtering and paging is implemented for following requests:
...
The %26 is just url encoding of '&' = AND. The encoding is required because otherwise it will be considered as another query parameter, and not part of a filter. Combination using OR is not supported
Examples :
GET https://api-stage.bimplus.net/v2/<team_slug>/projects?filter=name=MyProject - get project by name
...
GET https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments?filter=creator.email=myuser@allplan.com%26createdAt>2016-07-27T07:00:00 - get attachments created by the given user since the time