...
Model Service
| Note |
|---|
Not used in the current edition! |
...
A Model is basically a technical building plan which could be created or imported.
Create a new model
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: projects URL: http://api-dev.bimplus.net/v2/<team_slug>/projects Example: http://api-dev.bimplus.net/v2/bimplus/projects 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 |
|---|
| | Creates a new project. |
| 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" : "Your Awesome Building",
"shortDescr" : "Example for creating a project"
}
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
|
|
|
Get the list of existing models inside a project
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: divisions URL: http://api-dev.bimplus.net/v2/<team_slug>/projects/<project_id>/divisions Example: http://api-dev.bimplus.net/v2/bimplus-gmbh/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions |
| Card |
|---|
| | Gets the list of existing models inside 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": "Model A - Vogel",
"description": null,
"projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
"topologyId": "fc4be8b1-bf85-4c6f-b9c2-bac6474ddb1d",
"id": "d81494b9-9731-4d2e-8fbe-da62f5270182"
},
{
"name": "Model B - house sketchup",
"description": null,
"projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
"topologyId": "2d20d707-9c18-44c0-92f4-282948cd5cf5",
"id": "deec1913-2c6e-4580-a40f-7e1ad33a6300"
},
{
"name": "Model C - Nemetschek",
"description": null,
"projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
"topologyId": "d762b01d-6e63-4c68-9192-fc62faccbe87",
"id": "e687b45b-d90d-4361-94ab-baf269588c0a"
}
] |
|
|
| Anchor |
|---|
| getModelDetails |
|---|
| getModelDetails |
|---|
|
Get the model details
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: divisions/<division_id> URL: http://api-dev.bimplus.net/v2/<team_slug>/divisions/<division_id> Example: http://api-dev.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a |
| Card |
|---|
| | Get all the details of a model 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": "Model C - Nemetschek",
"description": null,
"projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
"topologyId": "d762b01d-6e63-4c68-9192-fc62faccbe87",
"disciplines": [
"0f106af0-a919-44c5-b211-15bd5ef620b6",
"09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
],
"id": "e687b45b-d90d-4361-94ab-baf269588c0a"
} |
|
|
| Anchor |
|---|
| updateProject |
|---|
| updateProject |
|---|
|
Update the project
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: divisions/<division_id> URL: http://api-dev.bimplus.net/v2/<team_slug>/divisions/<division_id> Example: http://api-dev.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
name | optional | string | Name of the project | shortDescr | optional | string | Short description of the project | created | will be ignored | string (date) | Creation date of the project | changed | will be ignored | string (date) | Changed date of the project |
|
| Card |
|---|
| | Update or replace a specified existing model 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": {
"MainFloorArea": "456m²",
"Architect": {
"name": "NemetschekTech.GmbH",
"phone1": "089/12793-1115",
"phone2": "0171/71384483",
"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 |
|---|
| objectService |
|---|
| objectService |
|---|
|
...