Project Service
...
...
Anchor |
---|
| projectService |
---|
| projectService |
---|
|
Project Service
...
A Project is basically a holder which contains building models.
...
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 | lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON | lang | xml |
---|
| {
"name" : "Your Awesome Building",
"shortDescr" : "Example for creating a project",
"address" : "My address somewhere"
}
|
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status | lang | xml |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON | lang | xml |
---|
| {
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnailteamName": null,
"created": ""Best Company",
"teamSlug": "best-company",
"hasWriteAccess" : true,
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id "createdby" : {
"id": "7c555899-5a5f-44d1-930e-284930678bed",
"email" : "testuser@bimplus.net"
},
"changed": "0d2ce2cc2013-3588-45d6-a59a-f6b89ebed34e"
}
|
|
|
...
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 whole project list in which the logged in user has a project role |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
"id": "586b02be-43b8-4e27-b698-e067e85e38e2",
"name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
"shortDescr": "Hey, i am your favourite test entry06-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",
"thumbnail": null,
"created""id": "20130d2ce2cc-05-01T09:33:18",
"changed": "2013-05-01T09:33:18",
"hasWriteAccess": false,
"teamSlug": "company1",
"rights": {
"projectAdmin": false,
"projectDelete": false,
"projectEdit": false,
"modelsCreate": false,
"modelsViewAll": false
}
},
{
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "0001-01-01T00:00:00",
"changed": "0001-01-01T00:00:00",
"hasWriteAccess": true,
"teamSlug": "best-company",
"rights3588-45d6-a59a-f6b89ebed34e"
}
|
|
|
Anchor |
---|
| createCopyProjectFromSourceProject |
---|
| createCopyProjectFromSourceProject |
---|
|
Create copy of the source project
Deck of Cards |
---|
id | bimCreateCopyProjectFromSourceProject |
---|
|
Card |
---|
label | Url / Resource /Json |
---|
| Resource: projects/copyfrom URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/copyfrom Example:https://api-stage.bimplus.net/v2/bimplus/projects/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 |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
"id":"1eb8efe0-7611-47e7-a06d-102ec8e2fff6",
"name":"Copy of the Mallorca V1",
"shortDescr":"Description 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 |
---|
| {
"topicCount": 0,
"attachmentCount": 2,
"projectAttachmentCount": 0,
"name": "Copy of the Mallorca V1",
"shortDescr": "Description of the new copy of the Mallorca V1",
"hasWriteAccess": false,
"teamSlug": null,
"thumbnail": null,
"created": "2014-02-13T12:39:36",
"createdby": {
"projectAdminid": true"e0837206-4bff-65d4-b79f-f3878c3567fd",
"projectDeleteemail": true"demo@bimplus.net",
"projectEditfirstname": true"bim+",
"modelsCreate": true,
"lastname": "a service by Allplan"
},
"modelsViewAllchanged": true"2019-01-24T11:51:40.55",
}
},
"changedby": {
"id": "4e87944ae0837206-a4774bff-4e4c65d4-862eb79f-e723dcb43066f3878c3567fd",
"nameemail": "UC_Fly-over Kerensheidedemo@bimplus.net",
"shortDescrfirstname": null"bim+",
"thumbnaillastname": null,"a service by Allplan"
},
"createdmodelCount": "2013-05-10T07:13:38"2,
"memberCount": 1,
"size": 32839680,
"changedattachmentsSize": "2013-05-16T07:34:56"0,
"hasWriteAccesssizeMB": false,
"teamSlug": "company2"31.32",
"rightsapprovalProcess": {
"projectAdmin": false,
0,
"projectDeleteid": false,
"projectEdit": false,
"modelsCreate": false,
"modelsViewAll": true
}
}
]
|
|
|
...
"990d0772-8b87-479a-9ed6-b0b46a204301"
} |
|
|
Anchor |
---|
| getCurrentProjectList |
---|
| getCurrentProjectList |
---|
|
Get the logged in user's project List
...
Deck of Cards |
---|
id | bimGetProjectListbimGetCurrentProjectList |
---|
|
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 entire list of projects in which the logged in user is a member of. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers | lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status | lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON | lang | xml |
---|
| [
{
"id": "586b02be-43b8-4e27-b698-e067e85e38e2",
"name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
"shortDescr": "Hey, i am your favourite test entry",
"thumbnail": null"",
"created": "2013-05-01T09:33:18",
"changedcreatedby": "2013-05-01T09:33:18",: {
"hasWriteAccess": false,
"id" "teamSlug": "company1",
: "f4b1178d-385f-449c-a2a7-6f58b264d90c"
"rightsemail" : {
"owner@company1.com",
},
"projectAdminchanged": false"2013-05-01T09:33:18",
"projectDeletechangedby" : false,{
"projectEditid" : false,"f4b1178d-385f-449c-a2a7-6f58b264d90c"
"modelsCreateemail" : false"owner@company1.com",
},
"modelsViewAll": false
"address" : "Address of company }1"
},
{"hasWriteAccess": false,
"idteamSlug": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34ecompany1",
"namemodelCount" : "Your Awesome Building",3,
"shortDescr": "Example for creating a project",
"thumbnail": nullmemberCount" : 3,
"created": "0001-01-01T00:00:00",
"changed": "0001-01-01T00:00:00"size" : 63488,
"hasWriteAccess": true,
"teamSlug"sizeMB" : "best-company0.06",
"rights": {
"projectAdmin": truefalse,
"projectDelete": truefalse,
"projectEdit": truefalse,
"modelsCreate": truefalse,
"modelsViewAll": truefalse
}
},
{
"id": "4e87944a0d2ce2cc-a4773588-4e4c45d6-862ea59a-e723dcb43066f6b89ebed34e",
"name": "UC_Fly-over KerensheideYour Awesome Building",
"shortDescr": null,
"Example for creating a "thumbnail": nullproject",
"createdthumbnail": "2013-05-10T07:13:38",
"changedcreated": "20130001-0501-16T0701T00:3400:5600",
"hasWriteAccesscreatedby" : false,{
"teamSlugid": "company27c555899-5a5f-44d1-930e-284930678bed",
"rights": {
"email" : "testuser@bimplus.net"
"projectAdmin": false},
"projectDeletechanged": false"0001-01-01T00:00:00",
"projectEditchangedby" : false,{
"modelsCreateid": false"7c555899-5a5f-44d1-930e-284930678bed",
"modelsViewAllemail" : true"testuser@bimplus.net"
},
}
]
|
|
|
...
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 |
Card |
---|
| Get all the project properties of a project using its id. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
"shortDescr": "Hey, i am your favourite test entry",
"thumbnail": null,
"created": null,
"changed": null,
"disciplines": ["address" : "My address somewhere",
"hasWriteAccess": true,
"teamSlug": "best-company",
"modelCount": 4,
"memberCount": 2,
"size" : 4263936,
"sizeMB" : "4,07",
"rights": {
"projectAdmin": true,
{
"id"projectDelete": "0f106af0-a919-44c5-b211-15bd5ef620b6"true,
"nameprojectEdit": "ID_BuildingModel"true,
"divisionIdmodelsCreate": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"true,
"divisionNamemodelsViewAll": null,true
"revisions": []
}
},
]
|
|
|
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",
{
"id": "63b069d2-81df-4418-91de-8a954fa12924",
"name": "ID_DesignModel_Timber",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionNameshortDescr": null,
"Example for creating a project",
"revisionsthumbnail": []"",
}"created": "0001-01-01T00:00:00",
"createdby" : {
"id": "30114b527c555899-bc055a5f-47c144d1-80b5930e-c7d5485d5840284930678bed",
"nameemail" : "ID_FinishModel",testuser@bimplus.net"
},
"divisionIdchanged": "ac21b9a10001-8853-4658-9fbf-0cf62340bd1801-01T00:00:00",
"divisionNamechangedby" : null,{
"revisionsid": []"7c555899-5a5f-44d1-930e-284930678bed",
},
"email" : "testuser@bimplus.net"
{
},
"idaddress" : "09e623d4-1e12-4a77-b358-ea1d0b28e4a7My address somewhere",
"namehasWriteAccess": "ID_RoomModel"true,
"divisionIdteamSlug": "ac21b9a1-8853-4658-9fbf-0cf62340bd18best-company",
"divisionNamemodelCount": null4,
"revisionsmemberCount": []2,
"size" : }4263936,
],
"rightssizeMB": {
: "4,07",
"rights": {
"projectAdmin": falsetrue,
"projectDelete": falsetrue,
"projectEdit": falsetrue,
"modelsCreate": falsetrue,
"modelsViewAll": true
}
},
{
"id": "586b02be4e87944a-43b8a477-4e274e4c-b698862e-e067e85e38e2e723dcb43066"
}
|
|
|
...
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 or replace a specified existing project with a new one. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"properties": {
,
"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"
},
"address" : ""
"hasWriteAccess": true,
"teamSlug": "best-company",
"modelCount": 2,
"memberCount": 3,
"size": 63488,
"sizeMB": "0,06",
"rights": {
"MainFloorAreaprojectAdmin": "456m²"false,
"ArchitectprojectDelete": {false,
"nameprojectEdit": "NemetschekTech.GmbH"true,
"phone1modelsCreate": "089/12793-1115"false,
"phone2modelsViewAll": "0171/71384483",true
"email": "MyName@Nemetschek.com",}
"city": "Munich",
"zip": "81829",
"street": "Konrad-Zuse-Platz1"
},
"Customer": {
"name": "Bimplus customer",
"phone1": "001-201-1279345",
"email": "MyName@Nemetschek.com",
"city": "New Jersy",
"zip": "08201"
}
}
}
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
...
Anchor |
---|
| getProjectProp |
---|
| getProjectProp |
---|
|
Get the Project Properties
...
Create an issue in the project
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>issuesURL: | | | |
---|
disciplines | string (bool) | true | When query parameter "disciplines=false" is defined, the API will return project properties except "disciplines" project property. e.g. |
Example: <team_slug>/projects/<project_id>/issues0d2ce2cc358845d6a59a-f6b89ebed34e/issuesJSON Structure: Name | Mandatory / Optional | Type | Description |
---|
shortId | will be ignored | number | Readable unique issue number (always starts with 1 for each project) | projectId | will be ignored | string (guid) | Id of the project | name | optional | string | Name of the issue | description | optional | string | Description of the issue | author | optional | object | Author of the issue | responsible | optional | object | Responsible person for the issue | status | optional | string | Status of the issue. Should have one of the values: Open, Solved or Closed | createdAt | will be ignored | string (date) | Creation date of the issue | dueDate | optional | string (date) | The date in which the issue is planned to be finished | solution | optional | string | The proposed solution for the issue | classification | optional | string | The classification to which the issues belongs | priority | optional | string | The priority of the issue. Should have one of the values: Low, Medium or High |
|
Card |
---|
| Creates a new issue in a project. While creating an issue in a project, the view of the model is automatically saved. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author" : { "id" : "92fa66c6-4114-d68e-974c-0ff78a49fda8" },
"responsible" : { "id" : "11fa66c6-4114-d68e-974c-0ff78a49fda8" },
"status": "open",
"dueDate": "2013-06-05T10:05:00",
"classification": "",
"priority": "very high"
}
|
|
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": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com"
},
"changed": "2015-11-19T09:45:51",
"changedby": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com"
},
"address": " |
| Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"shortId": 1
"projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"namemodelCount": "Fire Exit Wrong"1,
"memberCount": 7,
"descriptiontopicCount": "The fire exit is in the wrong place"30,
"attachmentCount": 13,
"size": 99317760,
"authorsizeMB" : { "id" : "92fa66c6-4114-d68e-974c-0ff78a49fda8" },
94,72",
"disciplines": [
"responsible" : {
"id" : "11fa66c60f106af0-4114a919-d68e44c5-974cb211-0ff78a49fda815bd5ef620b6" },,
"statusname": "openID_BuildingModel",
"createdAt": "2013-06-02T10:05:00+00:00",
"dueDatedivisionId": "2013-06-05T10:05:00+00:00b539790e-2ffc-43cd-9582-b4aa27b36693",
"solution": null,
"classificationdivisionName": "Model1",
"priority": "very high",
"revision": null "divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
"revisions": [
1
],
"visible": false,
"id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
}
|
|
|
...
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 |
Card |
---|
| Get all the issues assigned to a specified project. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
"shortId": 1 "opaque": false,
"opacity": 0
},
{
"id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
"name": "ID_FinishModel",
"projectIddivisionId": "0d2ce2ccb539790e-35882ffc-45d643cd-a59a9582-f6b89ebed34eb4aa27b36693",
"name": "Fire Exit Wrong",
"descriptiondivisionName": "TheModel1",
fire exit is in the wrong place",
"authordivisionTopologyId": "Mr. Smart25f38274-7158-436d-9356-f5c917ee44c9",
"status": "open",
"createdAtrevisions": "2013-06-02T10:05:00+00:00",
"dueDate": "2013-06-05T10:05:00+00:00",
"solution": null,
"classification": "",
"priority": "very high",
"revision": null,
"id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
},
{
"shortId": 2[
1,2
],
"visible": false,
"projectIdopaque": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"false,
"name": "Geometry information missing for wall",
"descriptionopacity": "The geometry information is missing for the wall in the kitchen",
"author": "Mr. Architect",
"status": "open",
"createdAt": "2013-06-02T10:05:00+00:00",
"dueDate": "2013-06-05T10:05:00+00:00",
"solution": null,
"classification": "",
"priority": "high",
"revision": null,
"id": "a171bc90-b03f-4ddd-9794-cf77f424f4e2"
}
]
|
|
|
...
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: |
|
...
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 |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
...
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 JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body. Name | Mandatory / Optional | Type | Description |
---|
objectIdsoptionalwill be ignored | string (guid) | The id objects to which the file has to be attachedfileName | optional file to be attached to the typeMime type | sizeInMB | optional | integer | Size of the file to be attached to the project | createdAtShort description of the project | teamName | will be ignored | string | Name of the team to which the project belongs | teamSlug | will be ignored | string | Creation date attachmentcreatorteam to which the project belongs | hasWriteAccess | will be ignored |
object | The user who created the attachment | attachmentTypeboolean | Don't use this property. This property is not deleted to support the older clients | created | will be ignored | string (date) |
Type of attachment. It could be one of the following : Thumbnail, Ifc, SketchUp, AllplanResource, AllplanDrawing, AllplanLayout, AllplanLayoutDocument, AutodeskResource, Revit, AutoCadDrawing Please note that there exists a filter for it. See the filter section | classification | optional | string | Classify the attachments. The existing classifications are : Plan, Cost, Contract, Drawing , Specification, Report, Image | |
Card |
---|
| Creates a new attachment in a project. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
|
Image Removed |
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" |
| Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f47c555899-a8095a5f-2d0144d1-d27d930e-cd251f2b6cb6284930678bed",
"email" : "test@bimplustestuser@bimplus.net",
},
"firstnamechanged": "First Name2013-06-02T10:04:15",
"lastnamechangedby" : "Second Name",{
"companyid": "Best-Company7c555899-5a5f-44d1-930e-284930678bed",
"fullnameemail" : "First Name Second Name",testuser@bimplus.net"
},
"displaynameaddress" : "Best-CompanyChanged address",
"infomodelCount": ""0,
"gendermemberCount": ""1,
"phoneWorktopicCount": ""0,
"phoneHomeattachmentCount": ""0,
"faxsize": ""0,
"mobilesizeMB": "0",
"birthDateid": "00000d2ce2cc-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}
|
|
|
...
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- |
|
...
Get the Attachment List from the project
Deck of Cards |
---|
id | bimGetAttachmentListFromProject |
---|
|
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 |
---|
| Get all the attachments belonging to a specified project. The normal attachment GET call (i.e projects/<project_id>/attachments) returns all the attachments inside a project i.e it iterates through all the objects inside a project and returns everything. If we want to retrieve the only the attachments that belongs to the project directly, then use ?projectOnly=true filter (i.e projects/<project_id>/attachments?projectOnly=true) |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"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",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
} |
|
|
...
Delete all the attachments from the project
Deck of Cards |
---|
id | bimDeleteAttachmentListFromProject |
---|
|
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 |
---|
| Delete all the attachments belonging to a specified 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 |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Card |
---|
| multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW
|
Code Block |
---|
Code Block |
---|
borderColor | Green |
---|
| Status: 200 OK
|
|
|
...
| ------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"
|
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 |
|
|
...
Get the project topology tree
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/topology URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/topology Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/topology |
Card |
---|
| Get the project topology tree. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"parent": null,
"name": null,
"type": "Project",
"childrensize": [211258,
"createdAt": "2013-12-11T10:47:39",
{
"creator": {
"parentid": "0d2ce2cce18941f4-3588a809-45d62d01-a59ad27d-f6b89ebed34ecd251f2b6cb6",
"email": "test@bimplus.net",
"namefirstname": null"First Name",
"lastname": "Second Name",
"typecompany": "ID_TopologyDivisionBest-Company",
"fullname": "First Name Second Name",
"childrendisplayname": []"Best-Company",
},
"idchanged" : "195db0842013-3715-4ebc-b164-3ee47a495b2e"12-11T10:47:39",
"changedBy" : {
}
],
"id": "0d2ce2cce18941f4-3588a809-45d62d01-a59ad27d-f6b89ebed34ecd251f2b6cb6"
}
|
|
|
...
Get the spot list from the project
Deck of Cards |
---|
id | bimGetSpotListFromProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/pins URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/pins Example: https://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/pins |
Card |
---|
| Get the spot list from the project |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
,
"email": "test@bimplus.net",
},
"hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
"attachmentType" : "Document",
"classification" : "Report",
"issueIdtag" : "5eac4d92-c65b-49c8-927c-9f255879a5c2ABCDE",
"objectIdsizeMB" : "442af981-4175-4f1d-90f0-ef1c8641f0cb0,21",
"topologyNodeIdversion" : "4be5ffd3-1e5e-42a7-9844-23b55fb392531",
"positionrelatedId": {
"x": 78696.44,
: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"yrights" : 9652.251,
{
"zupdate" : 580true,
},
"normalVector": {"share" : true,
"xdelete" : 0true,
"ydownload" : 0,true
},
"zid": "6cea110a-88f4-43ac-9a00-ebaf677be333"
} |
|
|
Anchor |
---|
| createChunkedAttachment |
---|
| createChunkedAttachment |
---|
|
Create a new attachment in the project using chunked upload
Deck of Cards |
---|
id | bimCreateChunkedAttachmentInProject |
---|
|
Card |
---|
| 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 attachments 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-Range: bytes 0-20971520/22471573
Chunk-FileId: 6cea110a-88f4-43ac-9a00-ebaf677be333
Content-Disposition: inline; name="Document"; filename="file.pdf" |
Where : - name and filename are mandatory saved as 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": [1
},
"createdAt": "2014-05-09T12:17:18",
"id": "3ba43939-5805-4aac-b7a5-8cf3b5833ac3"
},
{
"issueId": "5333bb42-2cb9-4f11-afd8-120c79edef37",
"objectId": "ae1a139a-1e13-491f-b6d8-a46f699e295e",
"topologyNodeId": "37a26e8b-566e-4d6e-8ab2-f35a715e83e2",
"position": {
"x": 41677.4336,
"y": 10095.9512,
"z": -9020
},
"normalVector": {
"x": 0,
"y": 0,
"z": 1"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}],
"createdAtfileName": "2014-05-09T12:17:33TestFile.xml",
"idtype": "fa9acf26-efdf-4297-80b5-2422bbf6e35a"application/xml",
},
{ "size": 211258,
"issueIdcreatedAt": "5eac4d922013-c65b-49c8-927c-9f255879a5c212-11T10:47:39",
"objectIdcreator": "effc5f9f-dcae-4e5f-9a67-189d4a285612",
{
"topologyNodeIdid": "4be5ffd3e18941f4-1e5ea809-42a72d01-9844d27d-23b55fb39253cd251f2b6cb6",
"positionemail": {
"test@bimplus.net",
"xfirstname": -440"First Name",
"ylastname": 10767.11"Second Name",
"zcompany": -8243.917"Best-Company",
},
"normalVector": { "fullname": "First Name Second Name",
"xdisplayname": "Best-1Company",
},
"changed" : "y": 02013-12-11T10:47:39",
"z""changedBy" : 0{
},
"createdAt"id": "2014-05-27T08:56:46e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"idemail": "a014fcf3-c72e-4def-bc41-58b349b31591"
test@bimplus.net",
},
{
"issueIdhash": "5333bb4268a59c1f-2cb91914-4f1143b8-afd892fc-120c79edef371cee4ad1c90c",
"objectIdattachmentType" : "367af808-de74-41b4-a3fb-1bfb50559da3Document",
"topologyNodeIdclassification" : "9fc99e93-2f33-4247-b3a4-2a6658a9b750Report",
"tag" : "positionABCDE": {,
"sizeMB" : "x": 22525.0254"0,21",
"version" : "y1": 10334.1377,
"z": -9172"relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"rights" : {
},
"normalVectorupdate" : {true,
"xshare" : 0true,
"ydelete" : 0true,
"zdownload" : 1true
},
"createdAtid": "2014-05-21T13:34:07",
"id": "2b693990-a611-4b05-9efd-7485a9aeebbb"
},
{
6cea110a-88f4-43ac-9a00-ebaf677be333"
} |
|
|
Anchor |
---|
| getAttachments |
---|
| getAttachments |
---|
|
Get the Attachment List from the project
Deck of Cards |
---|
id | bimGetAttachmentListFromProject |
---|
|
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 |
---|
| Get all the attachments belonging to a specified project. The normal attachment GET call (i.e projects/<project_id>/attachments) returns all the attachments inside a project i.e it iterates through all the objects inside a project and returns everything. If we want to retrieve the only the attachments that belongs to the project directly, then use ?projectOnly=true filter (i.e projects/<project_id>/attachments?projectOnly=true) This call also supports filtering and paging |
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 |
---|
| [
{
"issueIdobjectIds": "5eac4d92-c65b-49c8-927c-9f255879a5c2",[
"objectId": "83821c970d2ce2cc-00203588-480e45d6-b863a59a-9981df590c0af6b89ebed34e",
],
"topologyNodeIdfileName": "aa7e1b6f-7324-459b-a114-9833806f89edTestFile.xml",
"positiontype": {"application/xml",
"x"size": 664.999939211258,
"createdAt": "2013-12-11T10:47:39",
"ycreator": 7197.733,{
"zid": -58535.82
"e18941f4-a809-2d01-d27d-cd251f2b6cb6",
}"email": "test@bimplus.net",
"normalVectorfirstname": {
"First Name",
"xlastname": -1"Second Name",
"ycompany": 0"Best-Company",
"zfullname": 0
"First Name }Second Name",
"createdAtdisplayname": "2014-05-27T09:18:17Best-Company",
},
"idchanged" : "f2a9c63f2013-2514-4c1f-be78-758a984b5430"12-11T10:47:39",
}
] |
|
|
...
Get the project disciplines
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/disciplines URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/disciplines Example: https://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/disciplines |
Card |
---|
| Get the layers of a project. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
"changedBy" : {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
},
"idhash": "0f106af068a59c1f-a9191914-44c543b8-b21192fc-15bd5ef620b61cee4ad1c90c",
"nameattachmentType" : "ID_BuildingModelDocument",
"divisionIdclassification" : "ac21b9a1-8853-4658-9fbf-0cf62340bd18Report",
"tag" : "divisionNameABCDE": null,
"sizeMB" : "revisions": []0,21",
},
"version" {
: "1",
"idrelatedId" : "63b069d20d2ce2cc-81df3588-441845d6-91dea59a-8a954fa12924f6b89ebed34e",
"namerights" : "ID_DesignModel_Timber",{
"divisionIdupdate" : "ac21b9a1-8853-4658-9fbf-0cf62340bd18"true,
"divisionNameshare" : nulltrue,
"revisionsdelete" : []true,
},
{
"download" : true
},
"id": "30114b526cea110a-bc0588f4-47c143ac-80b59a00-c7d5485d5840ebaf677be333",
"name": "ID_FinishModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
},
{
"id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
"name": "ID_RoomModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
}
]
|
|
|
...
Anchor |
---|
| deleteAttachments |
---|
| deleteAttachments |
---|
|
Delete all the attachments from the project
Deck of Cards |
---|
id | bimDeleteAttachmentListFromProject |
---|
|
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 |
---|
| Delete all the attachments 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 |
---|
| getProjectTopology |
---|
| getProjectTopology |
---|
|
Get the project topology tree
...
Create / Upload a thumbnail to the project
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/thumbnailtopology URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/thumbnailtopology Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnailtopology |
Card |
---|
| Creates or uploads a thumbnail to Get the project topology tree. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
titlelang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 200 OK
|
Code Block |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
|
Thumbnail API call: Image Removed |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
fileName: "MyThumbnail.jpg"
type: "image/jpeg"
size: 5262
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
|
|
|
...
| {
"parent": null,
"name": My Project,
"type": "Project",
"children": [
{
"ifcId": "1o1vYcpcH5KRRKl5voLOXN",
"ifcType": "IfcBuilding",
"parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": null,
"type": "ID_TopologyDivision",
"children": [],
"id": "195db084-3715-4ebc-b164-3ee47a495b2e"
}
],
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
|
|
|
Anchor |
---|
| getSpotListFromProject |
---|
| getSpotListFromProject |
---|
|
Get the spot list from the project
Deck of Cards |
---|
id | bimGetSpotListFromProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/pins URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/pins Example: https://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/pins |
Card |
---|
| Get the spot list from 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 |
---|
| [
{
"issueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
"objectId": "442af981-4175-4f1d-90f0-ef1c8641f0cb",
"topologyNodeId": "4be5ffd3-1e5e-42a7-9844-23b55fb39253",
"position": {
"x": 78696.44,
"y": 9652.251,
"z": 580
},
"normalVector": {
"x": 0,
"y": 0,
"z": 1
},
"createdAt": "2014-05-09T12:17:18",
"id": "3ba43939-5805-4aac-b7a5-8cf3b5833ac3"
},
{
"issueId": "5333bb42-2cb9-4f11-afd8-120c79edef37",
"objectId": "ae1a139a-1e13-491f-b6d8-a46f699e295e",
"topologyNodeId": "37a26e8b-566e-4d6e-8ab2-f35a715e83e2",
"position": {
"x": 41677.4336,
"y": 10095.9512,
"z": -9020
},
"normalVector": {
"x": 0,
"y": 0,
"z": 1
},
"createdAt": "2014-05-09T12:17:33",
"id": "fa9acf26-efdf-4297-80b5-2422bbf6e35a"
},
{
"issueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
"objectId": "effc5f9f-dcae-4e5f-9a67-189d4a285612",
"topologyNodeId": "4be5ffd3-1e5e-42a7-9844-23b55fb39253",
"position": {
"x": -440,
"y": 10767.11,
"z": -8243.917
},
"normalVector": {
"x": -1,
"y": 0,
"z": 0
},
"createdAt": "2014-05-27T08:56:46",
"id": "a014fcf3-c72e-4def-bc41-58b349b31591"
},
{
"issueId": "5333bb42-2cb9-4f11-afd8-120c79edef37",
"objectId": "367af808-de74-41b4-a3fb-1bfb50559da3",
"topologyNodeId": "9fc99e93-2f33-4247-b3a4-2a6658a9b750",
"position": {
"x": 22525.0254,
"y": 10334.1377,
"z": -9172
},
"normalVector": {
"x": 0,
"y": 0,
"z": 1
},
"createdAt": "2014-05-21T13:34:07",
"id": "2b693990-a611-4b05-9efd-7485a9aeebbb"
},
{
"issueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
"objectId": "83821c97-0020-480e-b863-9981df590c0a",
"topologyNodeId": "aa7e1b6f-7324-459b-a114-9833806f89ed",
"position": {
"x": 664.999939,
"y": 7197.733,
"z": -58535.82
},
"normalVector": {
"x": -1,
"y": 0,
"z": 0
},
"createdAt": "2014-05-27T09:18:17",
"id": "f2a9c63f-2514-4c1f-be78-758a984b5430"
}
] |
|
|
Anchor |
---|
| getProjectDisciplines |
---|
| getProjectDisciplines |
---|
|
Get the project disciplines
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/disciplines URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/disciplines Example: https://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/disciplines |
Card |
---|
| Get the layers of a 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 |
---|
| [
{
"id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"name": "ID_BuildingModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": "Model 1",
"divisionTopologyId": "60c8362a-eb91-412d-ac67-c5d787bf36cb",
"revisions": [
1
],
"visible": false,
"opaque": false,
"opacity": 0
},
{
"id": "63b069d2-81df-4418-91de-8a954fa12924",
"name": "ID_DesignModel_Timber",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": "Model 1",
"divisionTopologyId": "60c8362a-eb91-412d-ac67-c5d787bf36cb",
"revisions": [
1,2
],
"visible": false,
"opaque": false,
"opacity": 0
},
{
"id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
"name": "ID_FinishModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": "Model 1",
"divisionTopologyId": "60c8362a-eb91-412d-ac67-c5d787bf36cb",
"revisions": [
1,2
],
"visible": false,
"opaque": false,
"opacity": 0
},
{
"id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
"name": "ID_RoomModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": "Model 1",
"divisionTopologyId": "60c8362a-eb91-412d-ac67-c5d787bf36cb",
"revisions": [
1
],
"visible": false,
"opaque": false,
"opacity": 0
}
]
|
|
|
Anchor |
---|
| getProjectMaterialSurfaces |
---|
| getProjectMaterialSurfaces |
---|
|
Get material surfaces of the project
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 |
---|
|
Create / Upload a thumbnail to the project
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/thumbnail URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/thumbnail Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail |
Card |
---|
| Creates or uploads a thumbnail to the project. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
fileName: "MyThumbnail.jpg"
type: "image/jpeg"
size: 5262
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
|
|
|
Anchor |
---|
| downloadThumbnail |
---|
| downloadThumbnail |
---|
|
Download the thumbnail
Deck of Cards |
---|
id | bimDownloadThumbnailOfProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: thumbnail/<thumbnail_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/<thumbnail_id> Example: https://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e |
Card |
---|
| Downloads the thumbnail. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 |
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 200 OK
|
Response content type is the same as is the "type" of the thumbnail, e.g. "image/jpeg" |
|
Anchor |
---|
| getStructureList |
---|
| getStructureList |
---|
|
Get the structure list from a project
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: structures/<structure_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/structures Example:https://api-stage.bimplus.net/v2/bimplus/projects/179439d6-df16-41cc-bd2c-74d05b7995d5/structures |
Card |
---|
| Get the structure list from a 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 |
---|
| [
{
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 1,
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
},
{
"name": "TestStructure2",
"description": "Another Structure",
"type": "SpecificationStructure",
"nr": 2,
"color": 0,
"id": "279439d6-df16-41cc-bd2c-74d05b7995d5"
}
] |
|
|
Anchor |
---|
| deleteStructureList |
---|
| deleteStructureList |
---|
|
Delete all the structures from a project
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/structures URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/structures Example:https://api-stage.bimplus.net/v2/bimplus/projects/db540336-47a3-426e-b3bf-1e532bfac8ea/structures |
Card |
---|
| Deletes all the structures from 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 |
---|
| getStructureTopologyProject |
---|
| getStructureTopologyProject |
---|
|
Get the topology of all structures belonging to a project
Deck of Cards |
---|
id | bimGetStructureTopologyProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: structures/<project_id>/topology URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<project_id>/topology Example: https://api-stage.bimplus.net/v2/bimplus/structures/db540336-47a3-426e-b3bf-1e532bfac8ea>/topology |
Card |
---|
| Get the topology of all structures 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
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
"parent": null,
"name": "Test for Structure",
"type": "ID_Project",
"children": [
{
"parent": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"name": "TestStructure",
"type": "Structure",
"children": [
{
"parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "Structure",
"children": [
{
"parent": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"name": "WallConnection",
"type": "StructureElement",
"children": [
{
"parent": "35b986c2-e9cd-482e-9281-6000671a49f0",
"name": "Wall-005",
"type": "ID_ArchWall",
"children": [],
"id": "df4a81d6-42fb-4187-bbce-82a2fc093b2f"
}
],
|
|
|
...
Download the thumbnail
Deck of Cards |
---|
id | bimDownloadThumbnailOfProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: thumbnail/<thumbnail_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/<thumbnail_id> Example: https://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e |
Card |
---|
| Downloads the thumbnail. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
...
Get the structure list from a project
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: structures/<structure_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/structures Example:https://api-stage.bimplus.net/v2/bimplus/projects/179439d6-df16-41cc-bd2c-74d05b7995d5/structures |
Card |
---|
| Get the structure list from a project |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 1,
"color": 0,
"id": "179439d635b986c2-df16e9cd-41cc482e-bd2c9281-74d05b7995d56000671a49f0"
},
{
],
"name": "TestStructure2",
"descriptionid": "Another Structure",
adf506ae-3628-4501-9af1-22bcf27e4ab4"
"type": "SpecificationStructure",
}
"nr": 2,
"color": 0],
"id": "279439d6-df16-41cc-bd2c-74d05b7995d5"
}
] |
|
|
...
Delete all the structures from a project
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: projects/<project_id>/structures URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/structures Example:https://api-stage.bimplus.net/v2/bimplus/projects/db540336-47a3-426e-b3bf-1e532bfac8ea/structures |
Card |
---|
| Deletes all the structures from a specified project |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
...
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
],
"id": "622272da-f1ff-45ab-a3f0-c8f1255c80e8"
} |
|
|
Anchor |
---|
| getAllComments |
---|
| getAllComments |
---|
|
Deck of Cards |
---|
id | bimGetStructureTopologyProjectbimGetAllComments |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: structures: comments, hyperlinks
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/ topology URL: comments OR https://api-stage.bimplus.net/v2/<team_slug>/structuresprojects/<project_id>/topologyhyperlinks Example: https://api-stage.bimplus.net/v2/bimplus/projects/db540336-47a3-426e-b3bf-1e532bfac8ea>/comments OR https://api-stage.bimplus.net/v2/bimplus/structuresprojects/db540336-47a3-426e-b3bf-1e532bfac8ea>/topologyhyperlinks
|
Card |
---|
| Get the topology of all structures belonging to a specified Get all the comments, hyperlinks from the project |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | Greenxml |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status | lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
lang | xml |
---|
| {
"parent": null,
"name": "Test for Structure",
"type": "ID_Project",
"children": [
{
"parent": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"name": "TestStructure",
"type": "Structure",
"children": [
{
"parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "Structure",
"children": [
{
"parent": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"name": "WallConnection",
"type": "StructureElement",
"children": [
{
"parent": "35b986c2-e9cd-482e-9281-6000671a49f0",
"name": "Wall-005",
"type": "ID_ArchWall",
"children": [],
"id": "df4a81d6-42fb-4187-bbce-82a2fc093b2f"
}
],
"id": "35b986c2-e9cd-482e-9281-6000671a49f0"
}
],
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}
],
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
],
"id": "622272da-f1ff-45ab-a3f0-c8f1255c80e8"
} |
|
|
Anchor |
---|
| getAllCommentsdeleteProject | getAllComments |
---|
|
...
Delete
...
the project
Deck of Cards |
---|
id | bimGetAllCommentsbimDeleteProject |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: comments, hyperlinksprojects/<project_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/comments OR https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/hyperlinks Example: https://api-stage.bimplus.net/v2/bimplus/projects/db5403360d2ce2cc-47a33588-426e45d6-b3bf-1e532bfac8ea>/comments OR https://api-stage.bimplus.net/v2/bimplus/projects/db540336-47a3-426e-b3bf-1e532bfac8ea>/hyperlinksa59a-f6b89ebed34e |
Card |
---|
| Get all the comments, hyperlinks from the project Deletes a specified project. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | Greenxml |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status | lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"parent": null,
"name": "Test for Structure",
"type": "ID_Project",
"children": [
{
"parent": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"name": "TestStructure",
"type": "Structure",
"children": [
{
"parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "Structure",
"children": [
{
"parent": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"name": "WallConnection",
"type": "StructureElement",
"children": [
{
"parent": "35b986c2-e9cd-482e-9281-6000671a49f0",
"name": "Wall-005",
"type": "ID_ArchWall",
"children": [],
"id": "df4a81d6-42fb-4187-bbce-82a2fc093b2f"
}
],
"id": "35b986c2-e9cd-482e-9281-6000671a49f0"
}
],
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}
],
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
],
"id": "622272da-f1ff-45ab-a3f0-c8f1255c80e8"
} |
|
|
...
Delete the project
...
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:
- get list of projects
- get project attachments
- get project issues ( only paging, not filtering )
Paging
Using following query parameters :
- page - requested number of page
- pageSize - size of page
- sortColumn - name of the column ( property ) by which the list is sorted
- sortDirection - asceding or descending
Examples :
GET https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments?page=1&pageSize=5&sortColumn=fileName&sortDirection=descending
GET https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues?page=2&pageSize=10
GET https://api-stage.bimplus.net/v2/<team_slug>/projects?sortColumn=name&sortDirection=ascending
Filtering :
Using a filter added as a query parameter. Filter has following format : ?filter=<property><operator><value>
For the "property" you may use any property of the requested resource, or even inner property, e.g. creator.Email
Supported operators are : "=", "!=", "<", ">", ">=", "<=" and "*"
It is also possible to combine expressions in filter using AND operator : ?filter=<property1><operator1><value1>%26<property2><operator2><value2>%26,,,
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?filter=name=MyProject* - get projects where name starts with "MyProject"
GET https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments?filter=size>500000 - get attachments with size greater then ...
...
default | true |
---|
label | URL / Resource / JSON Structure |
---|
...
GET
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 |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
...
...
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
...
/attachments?filter=creator.email=myuser@allplan.com%26createdAt>2016-07-27T07:00:00 - get attachments created by the given user since the time