Clash Service
- Detect all the clashes in a project
- Detect clashes between disciplines & objects/topologies
- Get all clash filters for a team
- Get details of single clash filter
- Calculate clashes in project using particular clash filter
Clash Service
Clashes could be detected in a project by calling this service. The person who uploaded the model which contains the clash will get a notification along with the clash count after the clash process is completed. This process will be called during model import in the future.
Detect all the clashes in a project
URL: https://api-stage.bimplus.net/v2/<team_slug>/services/postprocess
Example:https://api-stage.bimplus.net/v2/bimplus/services/postprocess
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
runAsync |
mandatory |
bool |
True sets the clash process to run asynchronously |
postProcess |
mandatory |
object |
It runs as a windows service in the server |
projectId |
mandatory |
string |
Id of the project |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "runAsync": "True", "postProcess": { "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30" } }
Status: 200 Ok
{ "postProcess": { "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30" }, "runAsync": false }
Detect clashes between disciplines & objects/topologies
URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection
Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
layerid1 |
mandatory |
string(guid) |
Layer/discipline id |
layerid2 |
mandatory |
string(guid) |
Layer/discipline id |
tolerancex |
optional |
int |
Id of the project |
tolerancey | optional | int | Tolerance in x direction(mm) |
objectsid | mandatory | JSON Array | Tolerance in y direction(mm) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "layerid1": "0F106AF0-A919-44c5-B211-15BD5EF620B6", "layerid2": "0F106AF0-A919-44c5-B211-15BD5EF620B6", "tolerancex": "15", "tolerancey": "25", "objectsid": [ "a3105304-a785-4dff-b114-a57b665248f6", "f7fbde41-1c46-4c10-81cb-c97f16c9d16a", "aaf238a1-4a40-4185-991e-7673d82b040c" ] }
Status: 201 Created
{ "clashcount": 4 }
Get all clash filters for a team
URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters
Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/filters
GET
Get details of all clash filters for a particular team
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 Ok
[ { "name": "Shell", "description": "Clashes of all main building elements objects. For example walls, floors, roof, stairs, openings, columns...with each other.", "tolerancex": 0.01, "boxsize": 0.4, "definitions": [ { "name": "Shell1", "filterid": "0c39a1c5-2551-4587-8fd9-ec8b59372bcd", "definition": "[I]0F106AF0-A919-44C5-B211-15BD5EF620B6", "id": "d76a6719-d858-45d1-a8e9-929efc58a356" }, { "name": "Shell2", "filterid": "0c39a1c5-2551-4587-8fd9-ec8b59372bcd", "definition": "[I]0F106AF0-A919-44C5-B211-15BD5EF620B6", "id": "d76a6719-d858-45d1-a8e9-929efc58a356" } ], "id": "d76a6719-d858-45d1-a8e9-929efc58a356" }, { "name": "Window/Door", "description": "Clashes of all doors/windows objects with all building elements objects.", "tolerancex": 0.01, "boxsize": 0.4, "definitions": [ { "name": "Window/Door1", "filterid": "954ec08b-5c55-4f86-9d01-d49cc3b2f666", "definition": "[I]*[I]10074EEF-9418-4d64-9C6D-23932835A7F1", "id": "ffc6ab25-b3a9-1ecd-95be-35b5e7475fad" }, { "name": "Window/Door2", "filterid": "954ec08b-5c55-4f86-9d01-d49cc3b2f666", "definition": "[I]*[I]30114B52-BC05-47C1-80B5-C7D5485D5845,30114B52-BC05-47C1-80B5-C7D5485D5846", "id": "ffc6ab25-b3a9-1ecd-95be-35b5e7475fad" } ], "id": "ffc6ab25-b3a9-1ecd-95be-35b5e7475fad" } , ... ]
Get details of single clash filter
URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters/<filter_id>
Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/filters/d76a6719-d858-45d1-a8e9-929efc58a356
GET
Get details of single clash filter for a particular team
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 Ok
{ "name": "Shell", "description": "Clashes of all main building elements objects. For example walls, floors, roof, stairs, openings, columns...with each other.", "tolerancex": 0.01, "boxsize": 0.4, "definitions": [ { "name": "Shell1", "filterid": "0c39a1c5-2551-4587-8fd9-ec8b59372bcd", "definition": "[I]0F106AF0-A919-44C5-B211-15BD5EF620B6", "id": "d76a6719-d858-45d1-a8e9-929efc58a356" }, { "name": "Shell2", "filterid": "0c39a1c5-2551-4587-8fd9-ec8b59372bcd", "definition": "[I]0F106AF0-A919-44C5-B211-15BD5EF620B6", "id": "d76a6719-d858-45d1-a8e9-929efc58a356" } ], "id": "d76a6719-d858-45d1-a8e9-929efc58a356" }
Calculate clashes in project using particular clash filter
URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters
Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/filters
POST