Project Service
...
...
Anchor |
---|
| projectService |
---|
| projectService |
---|
|
...
Deck of Cards |
---|
|
Card |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects URL: https://api-stage.bimplus.net/v2/<team_slug>/projects Example: https://api-stage.bimplus.net/v2/bimplus/projects JSON Structure: 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 | thumbnail | will be ignored | string | Direct download link to project thumbnail | 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 |
---|
default | true |
---|
label | Description |
---|
| Creates a new project. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
"name" : "Your Awesome Building",
"shortDescr" : "Example for creating a project",
"address" : "My address somewhere"
}
|
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
"name": "Your Awesome Building",
"shortDescr": "Example for creating 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-01T10:05:00",
"changedby" : {
"id": "7c555899-5a5f-44d1-930e-284930678bed",
"email" : "testuser@bimplus.net"
},
"address" : "My address somewhere",
"modelCount": 0,
"memberCount": 1,
"topicCount": 0,
"attachmentCount": 0,
"size": 0,
"sizeMB": "0",
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
|
|
|
Anchor |
---|
| getCurrentProjectListcreateCopyProjectFromSourceProjectgetCurrentProjectList |
---|
| createCopyProjectFromSourceProject |
---|
|
...
Create copy of the source project
Deck of Cards |
---|
id | bimGetCurrentProjectListbimCreateCopyProjectFromSourceProject |
---|
|
Card |
---|
| Gets the entire list of projects in which the logged in user is a member |
/copyfrom JSON Structure: Name | Mandatory / Optional | Type | Description |
---|
id | mandatory | string(guid) | Source project Id. Only projects from 'Bimplus Demo' team are supported by this api function. | name | mandatory | string | Unique name of the newly created project. | shortDescr | optional | string | Description of the newly created project. |
|
Card |
---|
| Creates new project as copy of the source project. The content of source project from "Bimplus Demo" team will be copied to user team. |
Card |
---|
| Card |
---|
| Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | StatusHeaders |
---|
| StatusAuthorization: 200 OKBimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| [
{
"id": "586b02be1eb8efe0-43b87611-4e2747e7-b698a06d-e067e85e38e2102ec8e2fff6",
"name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"Copy of the Mallorca V1",
"shortDescr": "Hey, i am your favourite testDescription of the new copy of the Mallorca V1"
}
|
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
entry",
"thumbnailtopicCount": ""0,
"attachmentCount": 2,
"createdprojectAttachmentCount": "2013-05-01T09:33:18"0,
"createdbyname" : {
"Copy of the Mallorca V1",
"idshortDescr" : "f4b1178d-385f-449c-a2a7-6f58b264d90c"
Description of the new copy of the Mallorca V1",
"emailhasWriteAccess" : "owner@company1.com"false,
}"teamSlug": null,
"thumbnail": null,
"changedcreated": "20132014-0502-01T0913T12:3339:1836",
"changedbycreatedby" : {
"id" : "f4b1178de0837206-385f4bff-449c65d4-a2a7b79f-6f58b264d90cf3878c3567fd",
"email" : "owner@company1demo@bimplus.comnet",
}"firstname": "bim+",
"addresslastname" : "Addressa ofservice companyby 1Allplan"
},
"hasWriteAccesschanged": false"2019-01-24T11:51:40.55",
"teamSlugchangedby": "company1",{
"modelCountid" : 3"e0837206-4bff-65d4-b79f-f3878c3567fd",
"memberCountemail" : 3"demo@bimplus.net",
"sizefirstname" : 63488"bim+",
"sizeMBlastname" : "0.06",a service by Allplan"
},
"rightsmodelCount": {2,
"projectAdmin"memberCount": false1,
"projectDeletesize": false32839680,
"projectEdit"attachmentsSize": false0,
"modelsCreatesizeMB": false"31.32",
"modelsViewAllapprovalProcess": false
}
},
{
0,
"id": "0d2ce2cc990d0772-35888b87-45d6479a-a59a9ed6-f6b89ebed34eb0b46a204301"
} |
|
|
Anchor |
---|
| getCurrentProjectList |
---|
| getCurrentProjectList |
---|
|
Get the logged in user's project List
Deck of Cards |
---|
id | bimGetCurrentProjectList |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects URL: https://api-stage.bimplus.net/v2/projects Example: https://api-stage.bimplus.net/v2/projects |
Card |
---|
| Gets the entire list of projects in which the logged in user is a member |
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 |
---|
| [
,
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": "",
"created": "0001-01-01T00:00:00",
"createdby" : {
"id": "7c555899586b02be-5a5f43b8-44d14e27-930eb698-284930678bede067e85e38e2",
"emailname" : "testuser@bimplus.net"!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
"shortDescr": "Hey, i am your favourite test entry",
}"thumbnail": "",
"changedcreated": "00012013-0105-01T0001T09:0033:0018",
"changedbycreatedby" : {
"id" : "7c555899f4b1178d-5a5f385f-44d1449c-930ea2a7-284930678bed6f58b264d90c",
"email" : "testuser@bimplusowner@company1.netcom",
},
"addresschanged" : "My address somewhere2013-05-01T09:33:18",
"hasWriteAccesschangedby" : true,{
"teamSlugid" : "best-company",f4b1178d-385f-449c-a2a7-6f58b264d90c"
"modelCountemail" : 4"owner@company1.com",
},
"address" : "Address of company 1"
"hasWriteAccess": false,
"teamSlug": "company1",
"modelCount" : 3,
"memberCount" : 23,
"size" : 426393663488,
"sizeMB" : "4,070.06",
"rights": {
"projectAdmin": truefalse,
"projectDelete": truefalse,
"projectEdit": truefalse,
"modelsCreate": truefalse,
"modelsViewAll": truefalse
}
},
]
|
|
|
...
Get the user's project list from a team
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects URL: https://api-stage.bimplus.net/v2/<team_slug>/projects Example: https://api-stage.bimplus.net/v2/bimplus/projects |
Card |
---|
| Gets the project list with main properties from a particular team in which the user is a member of. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
This call also supports filtering and paging Card |
---|
| Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| [
{
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": "",
"created": "0001-01-01T00:00:00",
"createdby" : {
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": "",
"created": "0001-01-01T00:00:00",
"createdby" : {
"id": "7c555899-5a5f-44d1-930e-284930678bed",
"email" : "testuser@bimplus.net"
},
"changed": "0001-01-01T00:00:00",
"changedby" : {
"id": "7c555899-5a5f-44d1-930e-284930678bed",
"email" : "testuser@bimplus.net"
},
"address" : "My address somewhere",
"hasWriteAccess": true,
"teamSlug": "best-company",
"modelCount": 4,
"memberCount": 2,
"size" : 4263936,
"sizeMB" : "4,07",
"rights": {
"projectAdmin": true,
"projectDelete": true,
"projectEdit": true,
"modelsCreate": true,
"modelsViewAll": true
}
},
]
|
|
|
Anchor |
---|
| getProjectList |
---|
| getProjectList |
---|
|
Get the user's project list from a team
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects URL: https://api-stage.bimplus.net/v2/<team_slug>/projects Example: https://api-stage.bimplus.net/v2/bimplus/projects |
Card |
---|
| Gets the project list with main properties from a particular team in which the user is a member of. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
This call also supports filtering and paging |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| [
{
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": "",
"created": "0001-01-01T00:00:00 {
"id": "4e87944a-a477-4e4c-862e-e723dcb43066",
"name": "UC_Fly-over Kerensheide",
"shortDescr": "",
"thumbnail": "",
"created": "2013-05-10T07:13:38",
"createdby" : {
"id": "bda91f097c555899-2cc65a5f-45da44d1-bba0930e-5f92828f58bc284930678bed",
"email" : "UserA@bimplustestuser@bimplus.net"
},
"changed": "20130001-0501-16T0701T00:3400:5600",
"changedby" : {
"id": "7c555899-5a5f-44d1-930e-284930678bed",
"email" : "testuser@bimplus.net"
},
"address" : "My address somewhere",
"hasWriteAccess": true,
"teamSlug": "best-company",
"modelCount": 24,
"memberCount": 32,
"size" : 634884263936,
"sizeMB" : "04,0607",
"rights": {
"projectAdmin": falsetrue,
"projectDelete": falsetrue,
"projectEdit": true,
"modelsCreate": falsetrue,
"modelsViewAll": true
}
},
]
|
|
|
...
Get the Project Properties
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/586b02be-43b8-4e27-b698-e067e85e38e2
Optional query parameters
| | | |
---|
disciplines | string (bool) | true | When query parameter "disciplines=false" is defined, the API will return project properties except "disciplines" project property. e.g. https://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2?disciplines=false This api call is faster variant when client does not use returned discipline project property . Otherwise if query parameter "disciplines" is true (this is default) or is missing the call will return all project properties. e.g. https://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2?disciplines=true |
Card |
---|
|
Get all the project properties of a project using its id. |
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 |
---|
| {
"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 |
---|
| getProjectProp |
---|
| getProjectProp |
---|
|
Get the Project Properties
Deck of Cards |
---|
|
Card |
---|
| Get all the project properties of a project using its id. |
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 |
---|
| {
"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": {
"divisionName": "Model1",
"divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
"revisions": [
1
],
"visible": false,
"opaque": false,
"opacity": 0
},
{
"id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
"name": "ID_FinishModel",
"divisionId": "b539790e-2ffc-43cd-9582-b4aa27b36693",
"divisionName": "Model1",
"divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
"revisions": [
1,2
],
"visible": false,
"opaqueid": false"71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"opacity": 0
"email": "jayaraj.purushothaman@gmail.com"
},
}"changed": "2015-11-19T09:45:51",
"changedby": {
"id": "09e623d471e0ac3b-1e12fa49-4a77e540-b358ac2f-ea1d0b28e4a78caff3dd72ed",
"nameemail": "ID_RoomModel",jayaraj.purushothaman@gmail.com"
},
"divisionIdaddress": "b539790e-2ffc-43cd-9582-b4aa27b36693",
"modelCount": 1,
"divisionNamememberCount": "Model1"7,
"topicCount": 30,
"divisionTopologyIdattachmentCount": "25f38274-7158-436d-9356-f5c917ee44c9"13,
"size": 99317760,
"revisionssizeMB": [
"94,72",
"disciplines": [
{
1
]"id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"visiblename": false"ID_BuildingModel",
"opaquedivisionId": false"b539790e-2ffc-43cd-9582-b4aa27b36693",
"opacitydivisionName": 0"Model1",
}
],
"divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
"rightsrevisions": {[
"projectAdmin": true, 1
"projectDelete": true ],
"projectEditvisible": truefalse,
"modelsCreateopaque": truefalse,
"modelsViewAllopacity": true0
},
{
"id": "5cd37c7730114b52-d341bc05-4ab247c1-9f0d80b5-44467955b218c7d5485d5840"
} |
|
|
...
Update the project
...
...
default | true |
---|
label | URL / Resource / JSON Structure |
---|
...
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
JSON Structure:
...
Name
...
Mandatory / Optional
...
Type
...
Description
...
name
...
mandatory
...
string
...
Name of the project
...
shortDescr
...
optional
...
string
...
Short description of the project
...
created
...
will be ignored
...
string (date)
...
Creation date of the project
...
Card |
---|
|
Update properties of the specified project. |
...
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
|
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
|
{
"name" : "Your Awesome Building updated",
"shortDescr" : "Example for updating a project",
"address": "Changed address",
}
|
...
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
|
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"
} |
,
"name": "ID_FinishModel",
"divisionId": "b539790e-2ffc-43cd-9582-b4aa27b36693",
"divisionName": "Model1",
"divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
"revisions": [
1,2
],
"visible": false,
"opaque": false,
"opacity": 0
},
{
"id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
"name": "ID_RoomModel",
"divisionId": "b539790e-2ffc-43cd-9582-b4aa27b36693",
"divisionName": "Model1",
"divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
"revisions": [
1
],
"visible": false,
"opaque": false,
"opacity": 0
}
],
"rights": {
"projectAdmin": true,
"projectDelete": true,
"projectEdit": true,
"modelsCreate": true,
"modelsViewAll": true
},
"id": "5cd37c77-d341-4ab2-9f0d-44467955b218"
} |
|
|
Anchor |
---|
| updateProject |
---|
| updateProject |
---|
|
Update the project
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 JSON Structure: 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 |
---|
| Update properties of the specified project. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
"name" : "Your Awesome Building updated",
"shortDescr" : "Example for updating a project",
"address": "Changed address",
}
|
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| 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 |
---|
| createIssueInProject |
---|
| createIssueInProject |
---|
|
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 |
---|
id | bimGetIssueListFromProject |
---|
|
Card |
---|
| Get list of issues of given project. Response depends on the user rights : - for project admin or account owner - returns all existing issues in the project
- for project editor or viewer - returns only issues where the user is author or responsible ( although still exist the possibility to get all the issues, by using query parameter "?showAll=true" )
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
This call also supports filtering and paging
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| [
{
"name": "Wall info wrong",
"author": {
"id": "7c555899-5a5f-44d1-930e-284930678bed",
"email": "testuser1@allplan.com",
"firstname": "Test",
"lastname": "User1",
"company": "Allplan Bratislava",
"fullname": "Test User1"
},
"responsible": {
"id": "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
"email": "testuser1@allplan.com",
"firstname": "Test",
"lastname": "User2",
"company": "Allplan Bratislava",
"fullname": "Test User2"
},
"scene": null,
"attachmentsCount": 0,
"pinsCount": 0,
"commentsCount": 0,
"hyperlinksCount": 0,
"shortId": 4,
"projectId": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a",
"description": "This wall is wrong",
"status": "Open",
"createdAt": "2016-02-15T08:12:49.9831726+01:00",
"modifiedAt": "2016-02-15T08:12:49.9831726+01:00",
"dueDate": null,
"solution": "MySolution",
"type": "Problem",
"classification": "Problems",
"priority": "High",
"cc": [
"abc@bimplus.net"
],
"id": "01b5768a-bd19-4049-b72e-b44485514ef8"
},
...
]
|
|
|
Delete all the issues from the project
Deck of Cards |
---|
id | bimDeleteIssueListFromProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>issues URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues |
Card |
---|
| Delete all the issues belonging to 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 |
---|
| createAttachment |
---|
| createAttachment |
---|
|
Create a new attachment in the project
Deck of Cards |
---|
id | bimCreateAttachmentInProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/attachments URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments |
Card |
---|
| Creates a new attachment in a project. |
Card |
---|
| Bimplus supports creating and updating of attachments using requests with multipart/form-data content type. By standard, multipart/form-data content consists of several parts, each part containing a file data. But Bimplus supports only one file sent per call, so only first part of multipart form data content is used, the rest are ignored. The parts are separated by boundaries, each part contains content headers and content data. Examples : Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW
|
Code Block |
---|
| ------MyFormBoundarytlTJWL8i2mvYwGPW
Content-Disposition: form-data; name="TestFile"; filename="TestFile.xml"; classification="Report"; tag="ABCDE"
Content-Type: application/xml
**** Here are file data ******
------MyFormBoundarytlTJWL8i2mvYwGPW |
Where : - name and filename are mandatory saved as attachment's "name" and "filename" properties
- classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
- Content-Type is mandatory and is saved as attachment's property "type"
|
|
...
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 |
---|
id | bimGetIssueListFromProject |
---|
|
Card |
---|
|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
|
Resource: projects/<project_id>issues URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues
Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues
Optional query parameters
Name | Type | Default value | Description |
---|
shortinfo | boolean | false | When query parameter "shortinfo=true" is defined, the API function returns only classes of all tasks metric. |
Card |
---|
|
Get list of issues of given project. Response depends on the user rights : - for project admin or account owner - returns all existing issues in the project
- for project editor or viewer - returns only issues where the user is author or responsible ( although still exist the possibility to get all the issues, by using query parameter "?showAll=true" )
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
|
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
This call also supports filtering and paging
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 200201 OKCreated
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| [
{
"name": "Wall info wrong",
"author": {
"idobjectIds": "7c555899-5a5f-44d1-930e-284930678bed",
"email": "testuser1@allplan.com",[
"firstname": "Test", "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
"lastname": "User1" ],
"companyfileName": "Allplan BratislavaTestFile.xml",
"fullnametype": "Test User1"application/xml",
},
"responsiblesize": {211258,
"idcreatedAt": "0132ecbe2013-2ac5-4ae1-945d-d38fc3bc1e8212-11T10:47:39",
"emailcreator": "testuser1@allplan.com",
{
"firstnameid": "Teste18941f4-a809-2d01-d27d-cd251f2b6cb6",
"lastname": "User2",
"companyemail": "Allplan Bratislavatest@bimplus.net",
"fullname": "Test User2"
},
"scenefirstname": null,
"attachmentsCount": 0"First Name",
"pinsCount": 0,
"commentsCountlastname": "Second 0Name",
"hyperlinksCount": 0,
"shortId": 4,
"projectIdcompany": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8aBest-Company",
"description "fullname": "ThisFirst wallName isSecond wrongName",
"statusdisplayname": "Open"Best-Company",
},
"createdAtchanged" : "20162013-0212-15T0811T10:12:49.9831726+01:0047:39",
"modifiedAt "changedBy" : {
"id": "2016e18941f4-02-15T08:12:49.9831726+01:00a809-2d01-d27d-cd251f2b6cb6",
"dueDate": null,
"solutionemail": "MySolutiontest@bimplus.net",
"type": "Problem" },
"classificationhash": "Problems68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
"priorityattachmentType" : "HighDocument",
"cc": [
"classification" : "abc@bimplus.netReport",
],
"idtag" : "01b5768a-bd19-4049-b72e-b44485514ef8"
},
...
]
|
|
...
Delete all the issues from the project
Deck of Cards |
---|
id | bimDeleteIssueListFromProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>issues URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues Example: https://api-stage.bimplus.net/v2/bimplus/projects/ABCDE",
"sizeMB" : "0,21",
"version" : "1",
"relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e | /issues |
Card |
---|
| Delete all the issues belonging to 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
|
",
"rights" : {
"update" : true,
"share" : true,
"delete" : true,
"download" : true
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
} |
|
Anchor |
---|
| createChunkedAttachment |
---|
| createChunkedAttachment |
---|
|
Anchor |
---|
createAttachment | createAttachment |
|
Create a new attachment in the project using chunked upload
Deck of Cards |
---|
id | bimCreateAttachmentInProjectbimCreateChunkedAttachmentInProject |
---|
|
Card |
---|
| Creates Creates a new attachment in a project. The upload can be performed in chunks that allow it to exceed the 2GB file limit. After uploading the 1st chunk the file gets locked until finishing upload of the last chunk based on the 'Content-Range' header. |
Card |
---|
| Bimplus supports creating and updating of attachments only using requests with multipart/form-data content type. By standard, multipart/form-data content consists of several parts, each part containing a file data.But Bimplus supports only one file sent per call, so only first part of multipart form data content is used, the rest are ignored. The parts are separated by boundaries, each part contains content headers and content dataattachments in chunks. After the upload of the first chunk, the response contains a file ID, that should be passed as 'Chunk-FileId' header in upcoming requests.
Examples : Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-TypeRange: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW
| Code Block |
---|
| ------MyFormBoundarytlTJWL8i2mvYwGPWbytes 0-20971520/22471573
Chunk-FileId: 6cea110a-88f4-43ac-9a00-ebaf677be333
Content-Disposition: form-datainline; name="TestFileDocument"; filename="TestFile.xml"; classification="Report"; tag="ABCDE"
Content-Type: application/xml
**** Here are file data ******
------MyFormBoundarytlTJWL8i2mvYwGPWfile.pdf" |
Where : - name and filename are mandatory saved as attachment's Content-Disposition "name" and "filename" properties
- classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
- Content-Type is mandatory and is saved as attachment's property "type"
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "TestFile.xml",
"type": "application/xml",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
},
"changed" : "2013-12-11T10:47:39",
"changedBy" : {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
},
"hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
"attachmentType" : "Document",
"classification" : "Report",
"tag" : "ABCDE",
"sizeMB" : "0,21",
"version" : "1",
"relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"rights" : {
"update" : true,
"share" : true,
"delete" : true,
"download" : true
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
} |
|
|
...
Deck of Cards |
---|
id | bimGetProjectMaterialSurfaces |
---|
|
Card |
---|
| Get all material surfaces used in the 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
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| [{
"diffuseColor":8421504,
"transparency":0,
"argb":-8355712,
"reflection":0,
"refraction":1,
"scaleX":0,
"scaleY":0,
"translateX":0,
"translateY":0,
"rotation":0,
"diffuseReflectivity":100,
"colorKeyTolerance":0,
"multiToneFactor":0,
"colorMixing":false,
"alphaFromTexture":true,
"useColorKey":false,
"repeat":true,
"metric":true,
"emission":0,
"bumpAmplitude":0,
"roughness":0,
"colorKey":0,
"textures":[{
"objectIds":["cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
],
"fileName":"diffuse-texture-image.jpg",
"type":"image/jpeg",
"size":31590,
"createdAt":"2016-12-06T18:44:57.143",
"creator":{
"id":"78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
"email":null,
"firstname":null,
"lastname":null,
"company":null,
"fullname":"",
"displayname":null
},
"changed":"2016-12-06T18:44:57.143",
"changedBy":{
"id":"78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
"email":null
},
"hash":"de78a77e-8bc7-4ffa-b4ac-a201b100a1ed",
"attachmentType":"AllplanResource",
"tag":"eDIFFUSE1|eDIFFUSE2|eDIFFUSE3|eDIFFUSE4",
"sizeMB":"0,03",
"version":1,
"relatedId":"cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638",
"id":"1eeec814-bb81-4876-a608-fc28f864984f"
}
],
"id":"cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
},
...
]
|
|
|
Anchor |
---|
| createThumbnail |
---|
| createThumbnail |
---|
|
...
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:
...
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