Page History

...

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

Anchor

	detectClashObjects
	detectClashObjects

Detect clashes between disciplines & objects/topologies

Deck of Cards

id	bimDetectClashbimDetectClashObjects

Card

default	true
label	URL / Resource / JSON Structure

Resource: services/postprocess clashdetection

URL: https://api-stage.bimplus.net/v2/<team_slug>/services/postprocessclashdetection

Example:https://api-stage.bimplus.net/v2/bimplus/services/postprocessclashdetection

JSON Structure:

Name	Mandatory / Optional	Type	Description
runAsynclayerid1	mandatory	bool	True sets the clash process to run asynchronously
postProcess	mandatory	object	It runs as a windows service in the server
string(guid)	Layer/discipline id
layerid2	mandatory	string(guid)	Layer/discipline id
tolerancex	optional	int	projectId	mandatory	string	Id of the project
tolerancey	optional	int	Tolerance in x direction(mm)
objectsid	mandatory	JSON Array	Tolerance in y direction(mm)

Card

label	HTTP Method

POST

Card

label	Description

Detects all the clashes in a project. Beware, that this will more time as they will be typically 100s of clashes in a model

Detect clashes between disciplines & objects/topologies.

Card

label	Request

Code Block

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "runAsynclayerid1": "True0F106AF0-A919-44c5-B211-15BD5EF620B6",
    "postProcesslayerid2": {
"0F106AF0-A919-44c5-B211-15BD5EF620B6",
    "tolerancex": "15",
    "projectIdtolerancey": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"25",
    "objectsid": }
}[
        "a3105304-a785-4dff-b114-a57b665248f6",
        "f7fbde41-1c46-4c10-81cb-c97f16c9d16a",
        "aaf238a1-4a40-4185-991e-7673d82b040c"
    ]
}

Cardcard

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200201 OkCreated

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "postProcessclashcount": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    },
    "runAsync": false
}

...

4
}

Anchor

	calculateClashes
	calculateClashes

Calculate clashes in project using particular clash filter

...

Deck of Cards

id	bimDetectClashObjectsbimCalculateClashes

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashdetection/filters

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters

Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/filters

JSON Structure:

layerid1string()layerid2string()Layer/discipline idId of the project

Name	Mandatory / Optional	Type	Description
filterid	mandatory	guid	Layer/discipline id		ID of clash filter
projectid		mandatory	guid		Project ID
tolerancex	optional	int	double	Tolerance by clash detection in x-direction.
tolerancey	optional	intdouble	Tolerance by clash detection in x direction(mm)
objectsid	mandatory	JSON Array	Tolerance in y direction(mm)

Card

label	HTTP Method

POST

y-direction.
tolerancez	optional	double	Tolerance by clash detection in z-direction.
boxsize	optional	double	Size of visual clash element.
renew	optional	boolean	Defines faith of previously calculated clashes. If false - clashes will be updated, if true - all clashes will be deleted and new ones will be calculated. Default value is false

Card

label	Description

Detect clashes between disciplines & objects/topologies

.

Card

label	RequestHTTP Method

code

POST

borderColor

Green

Card

label

lang

xml

title

Headers

Description

Calculates, updates or recalculates ( see "renew" property ) clashes for a project, using the clash filter provided in the request json. Tolerances and boxsize are optional, if not set then the default values of the given filter will be used.

Remark: If there is only one tolerance value present - tolerancex - this value is used for all three tolerances.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json

Card

label	Request

Code Block

borderColor	RedGreen
lang	xml
title	JSONHeaders

{
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "layerid1filterid": "0F106AF0d76a6719-A919d858-44c545d1-B211a8e9-15BD5EF620B6929efc58a356",
    "layerid2projectid": "0F106AF0738a1a0a-A919d5e4-44c54639-B211b450-15BD5EF620B6996dc5cd7e67",
    "tolerancex": "150.01",
    "toleranceytolerancex": "250.01",
    "objectsidtolerancex": ["0.01",
        "a3105304-a785-4dff-b114-a57b665248f6",
        "f7fbde41-1c46-4c10-81cb-c97f16c9d16a",
        "aaf238a1-4a40-4185-991e-7673d82b040c"
    ]"boxsize": "0.4",
  "renew": "false"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "creator": {
    "clashcountid": 4
}

...

Calculate clashes in project using particular clash filter

Resource: clashdetection/filters

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters

Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/filters

JSON Structure:

Deck of Cards

id	bimCalculateClashes

Card

default	true
label	URL / Resource / JSON Structure

Name

Mandatory / Optional

Type

Description

filterid

mandatory

guid

ID of clash filter

projectid

mandatory

guid

Project ID

tolerancex

optional

double

Tolerance by clash detection in x-direction.

tolerancey

optional

double

Tolerance by clash detection in y-direction.

tolerancez

optional

double

Tolerance by clash detection in z-direction.

boxsize

optional

double

Size of visual clash element.

renew

optional

boolean

Defines faith of previously calculated clashes. If false - clashes will be updated, if true - all clashes will be deleted and new ones will be calculated. Default value is false.

Card

label	HTTP Method

POST

Card

label	Description

Calculates, updates or recalculates ( see "renew" property ) clashes for a project, using the clash filter provided in the request json. Tolerances and boxsize are optional, if not set then the default values of the given filter will be used.

Remark: If there is only one tolerance value present - tolerancex - this value is used for all three tolerances.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "filterid": "d76a6719-d858-45d1-a8e9-929efc58a356",
  "projectid": "738a1a0a-d5e4-4639-b450-996dc5cd7e67",
  "tolerancex": "0.01",
  "tolerancex": "0.01",
  "tolerancex": "0.01",
  "boxsize": "0.4",
  "renew": "false"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "creator": {
    "id": "69b270be-8102-4a27-a335-ee9e579acb87",
    "email": "testB@test.net"
  },
  "createdat": "2016-02-15T13:18:28.32+01:00",
  "status": "DONE",
  "tolerancex": 1.0,
  "boxsize": 0.4,
  "open": ["69b270be-8102-4a27-a335-ee9e579acb87",
    "email": "testB@test.net"
  },
  "createdat": "2016-02-15T13:18:28.32+01:00",
  "status": "DONE",
  "tolerancex": 1.0,
  "boxsize": 0.4,
  "open": [
    {
      "id": "620ec33c-8686-40de-a670-3de5195fed42",
      "elements": [
        "42c0c745-3dfa-4a47-9d86-0576bb37880a",
        "40393b5d-6ab9-4f81-8599-c46e69216a9c"
      ],
      "element1": {
        "id": "e3bdf005-58ea-4087-b2e1-367564fe06f6",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "7d2f969a-0c86-4521-be7c-7cf48bb0e610",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 1,
      "volume": 22.969524192034
    },
    {
      "id": "620ec33c0dfa47b8-86860efb-40de4c57-a6708859-3de5195fed42ef90b4ad6453",
      "elements": [
        "42c0c74515461bb3-3dfa9994-4a474e54-9d868411-0576bb37880af94437e81e21",
        "40393b5d36a5af0f-6ab9bef8-4f81478f-8599bc2f-c46e69216a9c0b0e567260e2"
      ],
      "element1": {
        "id": "e3bdf0054eeeb292-58ea3672-4087483e-b2e194e5-367564fe06f60da5bb65a1a1",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "7d2f969aeeca2016-0c864fdf-45214966-be7c9143-7cf48bb0e610ce94ad4b972c",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 13,
      "volume": 220.969524192034055550000000000009
    }
  ],
  "unresolved": [
    {
      "id": "0dfa47b8ad2bddc6-0efb1a5d-4c574a0b-8859b815-ef90b4ad6453042cec0198a5",
      "elements": [
        "15461bb375757fc1-9994ba76-4e544f64-8411ab29-f94437e81e217f5e2d85cfd1",
        "36a5af0f6edb8bc0-bef89417-478f4072-bc2fa375-0b0e567260e298c11c692357"
      ],
      "element1": {
        "id": "4eeeb29219be02c9-36722080-483e4f54-94e5a545-0da5bb65a1a1154cc22b8628",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "eeca2016f3c9162d-4fdf7b4a-49664eba-9143a86f-ce94ad4b972c72404be65445",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 32,
      "volume": 03.0555500000000000094398162022732786
    }
  ],
  "unresolved": [
    {
      "id": "ad2bddc68f8c8720-1a5d2324-4a0b41d7-b815a669-042cec0198a5d8cefb9328ff",
      "elements": [
        "75757fc168813fe9-ba76ea07-4f6441c0-ab299a94-7f5e2d85cfd15990c4bedee6",
        "6edb8bc09fe08223-9417f723-40724293-a375b484-98c11c6923574b45d02a09b7"
      ],
      "element1": {
        "id": "19be02c9d520d19d-20803235-4f544eb d-a545934f-154cc22b86281dc47af9f96e",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "f3c9162de9a14ac4-7b4a6ee7-4eba414a-a86faaf0-72404be6544544cd72a68191",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 24,
      "volume": 30.439816202273278664799999999999991
    },
    {
      "id": "8f8c8720-2324-41d7-a669-d8cefb9328ff"],
      "elementsresolved": [
    
    "68813fe9-]
}

Anchor

	getAllClashes
	getAllClashes

Get all clashes for given project and clash filter

Deck of Cards

id	bimGetAllClashes

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashdetection/projects/filters

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/projects/<project_id>/filters

Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/projects/3f7d2d9e-1872-4d4f-ba99-868e94d3f380/filters

Card

label	HTTP Method

GET

Card

label	Description

Get all project clashes calculated using given filter.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "creator": {
    "id": "69b270be-8102-4a27-a335-ee9e579acb87",
    "email": "testB@test.net"
  },
  "createdat": "2016-02-15T13:18:28.32+01:00",
  "status": "DONE",
  "tolerancex": 1.0,
  "boxsize": 0.4,
  "openea07-41c0-9a94-5990c4bedee6",
        "9fe08223-f723-4293-b484-4b45d02a09b7"
      ],
      "element1": {
        "id": "d520d19d-3235-4eb d-934f-1dc47af9f96e",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "e9a14ac4-6ee7-414a-aaf0-44cd72a68191",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 4,
      "volume": 0.64799999999999991
    }
  ],
  "resolved": [
    {
  ]
}

...

Get all clashes for given project and clash filter

Deck of Cards

id	bimGetAllClashes

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashdetection/projects/filters

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/projects/<project_id>/filters

Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/projects/3f7d2d9e-1872-4d4f-ba99-868e94d3f380/filters

Card

label	HTTP Method

GET

Card

label	Description

Get all project clashes calculated using given filter.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "creator": {
       "id": "620ec33c-8686-40de-a670-3de5195fed42",
      "elements": [
        "42c0c745-3dfa-4a47-9d86-0576bb37880a",
        "40393b5d-6ab9-4f81-8599-c46e69216a9c"
      ],
      "element1": {
        "id": "69b270bee3bdf005-810258ea-4a274087-a335b2e1-ee9e579acb87367564fe06f6",
        "emailtype": "testB@test.netElement",
      },
  "createdatname": "2016-02-15T13:18:28.32+01:00",<Unnamed Element>"
  "status": "DONE",
  "tolerancex": 1.0 },
  "boxsize": 0.4,
    "openelement2": [{
    {
      "id": "620ec33c7d2f969a-86860c86-40de4521-a670be7c-3de5195fed427cf48bb0e610",
        "elementstype": ["Element",
        "42c0c745-3dfa-4a47-9d86-0576bb37880a","name": "<Unnamed Element>"
      },
  "40393b5d-6ab9-4f81-8599-c46e69216a9c"
      ]"nr": 1,
      "element1volume": { 22.969524192034
    },
    {
      "id": "e3bdf0050dfa47b8-58ea0efb-40874c57-b2e18859-367564fe06f6ef90b4ad6453",
        "typeelements": "Element",[
        "name": "<Unnamed Element>15461bb3-9994-4e54-8411-f94437e81e21",
        "36a5af0f-bef8-478f-bc2f-0b0e567260e2"
      }],
      "element2element1": {
        "id": "7d2f969a4eeeb292-0c863672-4521483e-be7c94e5-7cf48bb0e6100da5bb65a1a1",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nrelement2": 1,{
        "volumeid": 22.969524192034
    }"eeca2016-4fdf-4966-9143-ce94ad4b972c",
    {
      "idtype": "0dfa47b8-0efb-4c57-8859-ef90b4ad6453Element",
        "elementsname": "<Unnamed [Element>"
      },
  "15461bb3-9994-4e54-8411-f94437e81e21"    "nr": 3,
        "36a5af0f-bef8-478f-bc2f-0b0e567260e2""volume": 0.055550000000000009
    }
  ],
  "unresolved": [
   "element1": {
        "id": "4eeeb292ad2bddc6-36721a5d-483e4a0b-94e5b815-0da5bb65a1a1042cec0198a5",
        "typeelements": "Element",[
        "name": "<Unnamed Element>75757fc1-ba76-4f64-ab29-7f5e2d85cfd1",
        "6edb8bc0-9417-4072-a375-98c11c692357"
      }],
      "element2element1": {
        "id": "eeca201619be02c9-4fdf2080-49664f54-9143a545-ce94ad4b972c154cc22b8628",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nrelement2": 3,{
        "volumeid": 0.055550000000000009"f3c9162d-7b4a-4eba-a86f-72404be65445",
    }
  ],
  "unresolvedtype": ["Element",
    {
      "idname": "ad2bddc6-1a5d-4a0b-b815-042cec0198a5",<Unnamed Element>"
      "elements": [
  },
      "75757fc1-ba76-4f64-ab29-7f5e2d85cfd1"nr": 2,
        "6edb8bc0-9417-4072-a375-98c11c692357""volume": 3.4398162022732786
      ]},
      "element1": {
        "id": "19be02c98f8c8720-20802324-4f5441d7-a545a669-154cc22b8628d8cefb9328ff",
      "elements":  "type": "Element[
        "68813fe9-ea07-41c0-9a94-5990c4bedee6",
        "name": "<Unnamed Element>"9fe08223-f723-4293-b484-4b45d02a09b7"
      }],
      "element2element1": {
        "id": "f3c9162dd520d19d-7b4a3235-4eba4eb d-a86f934f-72404be654451dc47af9f96e",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nrelement2": 2,{
        "volumeid": 3.4398162022732786
    }"e9a14ac4-6ee7-414a-aaf0-44cd72a68191",
    {
      "idtype": "8f8c8720-2324-41d7-a669-d8cefb9328ffElement",
        "elementsname": [
"<Unnamed Element>"
      },
      "68813fe9-ea07-41c0-9a94-5990c4bedee6"nr": 4,
        "9fe08223-f723-4293-b484-4b45d02a09b7""volume": 0.64799999999999991
    }
  ],
      "element1resolved": {[
        "id": "d520d19d-3235-4eb d-934f-1dc47af9f96e",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "e9a14ac4-6ee7-414a-aaf0-44cd72a68191",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 4,
      "volume": 0.64799999999999991
    }
  ],
  "resolved": [
    
  ]
}

...

Get all clash filters for a team

...

id	bimGetAllClashFilters

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashdetection/filters

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters

Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/filters

Card

label	HTTP Method

GET

Card

label	Description

Get details of all clash filters for a particular team

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

[
  {
    "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,
    "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,
    "id": "ffc6ab25-b3a9-1ecd-95be-35b5e7475fad"
  }
  , ...
]

]
}

Anchor

	createProjectClashFilter
	createProjectClashFilter

Create an clash filter in the project

Deck of Cards

id	bimCreateProjectClashFilter

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/clashfilters

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/clashfilters

Example: https://api-stage.bimplus.net/v2/bimplus/projects/48f5f0e5-4979-4c4f-b28a-fbba01d13181/clashfilters

JSON Structure : clash filter

Name	Mandatory / Optional	Type	Description
name	optional	string	Custom table name
description	optional	string	Custom table description
id	will be ignored	string(guid)	The id of the custom table. Will be taken from request url.
tolerancex	optional	double	Tolerance by clash detection in x-direction.
tolerancey	optional	double	Tolerance by clash detection in y-direction.
tolerancez	optional	double	Tolerance by clash detection in z-direction.
boxsize	optional	double	Size of visual clash element.
definitions	madatory	JSON Array	Array of two clash filter definition objects for a clash filter. An example template is specified in request json section.

JSON Structure : clash filter definition

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the filter
filterid	madatory	string(guid)	The id of the filter
selectionid	optional	string(guid)	The id of the selection
definition	madatory	string	The definition of a filter
selection	optional	object	Object of the selection
boxsize	optional	double	Size of visual clash element.
definitions	madatory	JSON Array	Array of two clash filter definition objects for a clash filter. An example template is specified in request json section.

Card

label	HTTP Method

POST

Card

label	Description

Create a new clash filter in specified project

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name":"TEST",
  "description":"test",
  "tolerancex":0.01,
  "boxsize":0.4,
  "definitions":[{
      "filterid":"0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
      "definition":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
      "selectionId":"8541a1c5-2551-4587-8fd9-ec8b59372bcd"
    },
    {
      "filterid":"0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
      "definition":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6"
    }
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "name":"TEST",
  "description":"test",
  "tolerancex":0.01,
  "boxsize":0.4,
  "definitions":[{
      "name":"Filter1",
      "filterid":"0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
      "definition":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
      "selectionid":"8541a1c5-2551-4587-8fd9-ec8b59372bcd",
      "id":"c9d5ca15-2561-4c58-85da-870a89242b87"
    },
    {
      "name":"Filter2",
      "filterid":"0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
      "definition":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
      "id":"c9d5ca15-2561-4c58-85da-870a89242b87"
    }
  ],
  "id":"c9d5ca15-2561-4c58-85da-870a89242b87"
}

Anchor

	getAllProjectClashFilters
	getAllProjectClashFilters

Get all clash filters for a project

Deck of Cards

id	bimGetAllProjectClashFilters

Card

default	true
label	URL / Resource / JSON Structure

Resource: /projects/<project_id>/clashfilters

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/clashfilters

Example:https://api-stage.bimplus.net/v2/bimplus/projects/48f5f0e5-4979-4c4f-b28a-fbba01d13181/clashfilters

Card

label	HTTP Method

GET

Card

label	Description

Get all clash filters for a particular project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

[{
    "name":"Reinforcement",
    "description":"Clashes between reinforcement objects.",
    "tolerancex":0.002,
    "boxsize":0.05,
    "id":"a9971843-0418-4ac4-a392-1bf5043fb562"
  },
  {
    "name":"TEST",
    "description":"test",
    "tolerancex":0.01,
    "boxsize":0.4,
    "id":"c9d5ca15-2561-4c58-85da-870a89242b87"
  }
  ...
]

Anchor

	getAllClashFilters
	getAllClashFilters

Get all clash filters for a team

Deck of Cards

id	bimGetAllClashFilters

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashdetection/filters

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters

Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/filters

Card

label	HTTP Method

GET

Card

label	Description

Get details of all clash filters for a particular team

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

[
  {
    "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,
    "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,
    "id": "ffc6ab25-b3a9-1ecd-95be-35b5e7475fad"
  }
  , ...
]

Anchor

	getClashFilter
	getClashFilter

Get details of single clash filter

Deck of Cards

id	bimGetClashFilter

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashdetection/filters

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters/<filter_id>

Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection/filters/c9d5ca15-2561-4c58-85da-870a89242b87

Card

label	HTTP Method

GET

Card

label	Description

Get details of single clash filter for a particular team

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

{	
	"name": "Test",
	"description": "test",
	"tolerancex": 0.01,
	"boxsize": 0.4,
	"definitions": [{
			"name": "Filter1",
			"filterid": "0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
			"definition": "[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
			"selectionid": "8541a1c5-2551-4587-8fd9-ec8b59372bcd",
			"selection": {
				"id": "8541a1c5-2551-4587-8fd9-ec8b59372bcd",
				"projectid": "2191084f-dd8f-407c-b47d-f1f4c9256ddc",
				"divisionid": "00000000-0000-0000-0000-000000000000",
				"revisionnr": null,
				"type": "RevisionElements",
				"elements": null,
				"revisionelements": [{
						"objectId": "e2c7c0e8-8524-445d-8f55-98fbd515271f",
						"revisionNr": 1
					}, {
						"objectId": "e2c7c0e8-8524-445d-8f55-98fbd515271f",
						"revisionNr": 1
					}
				],
				"topology": null,
				"filter": null,
				"structure": null,
				"topologystructure": null
			},
			"id": "c9d5ca15-2561-4c58-85da-870a89242b87"
		}, {
			"name": "Filter2",
			"filterid": "0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
			"definition": "[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
			"id": "c9d5ca15-2561-4c58-85da-870a89242b87"
		}
	],
	"id": "c9d5ca15-2561-4c58-85da-870a89242b87"

}

Anchor

	updateProjectClashFilter
	updateProjectClashFilter

Update the clash filter

Deck of Cards

id	bimUpdateProjectClashFilter

...

Get details of single clash filter

Deck of Cards

id	bimGetClashFilter

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashdetection/filtersclashfilters/<clashfilter_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashdetection/filters/<filterclashfilters/<clashfilter_id>

Example: https://api-stage.bimplus.net/v2/bimplus/clashdetectionclashfilters/filters/c9d5ca15-2561-4c58-85da-870a89242b87

JSON Structure: see Create a clash filter in project

Card

label	HTTP Method

GET PUT

Card

label	Description

Get details of single Update the specified clash filter for a particular team

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{	
	  "name":"TEST",
  "Test",
	"description": "test",
	"tolerancex": 0.01,
	"boxsize": 0.4,
	"definitions": [{
			"name": "Filter1",
			"filterid": "description":"test",
  "tolerancex":0.01,
  "boxsize":0.4,
  "definitions":[{
      "filterid":"0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
      "definition":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
      "selectionId":"8541a1c5-2551-4587-8fd9-ec8b59372bcd"
    },
    {
      "filterid":"0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
			      "definition":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6"
    }
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "name":"TEST",
  "description":"test",
  "tolerancex":0.01,
  "boxsize":0.4,
  "definitions":[{
      "name":"Filter1",
      "filterid":"0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
      "definition":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
      "selectionid":"8541a1c5-2551-4587-8fd9-ec8b59372bcd",
      "id":"c9d5ca15-2561-4c58-85da-870a89242b87"
    },
    {
      "name":"Filter2",
      "filterid":"0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
      "definition":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
      "id":"[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
			"selectionid": "8541a1c5-2551-4587-8fd9-ec8b59372bcd",
			"selection": {
				"id": "8541a1c5-2551-4587-8fd9-ec8b59372bcd",
				"projectid": "2191084f-dd8f-407c-b47d-f1f4c9256ddc",
				"divisionid": "00000000-0000-0000-0000-000000000000",
				"revisionnr": null,
				"type": "RevisionElements",
				"elements": null,
				"revisionelements": [{
						"objectId": "e2c7c0e8-8524-445d-8f55-98fbd515271f",
						"revisionNr": 1
					}, {
						"objectId": "e2c7c0e8-8524-445d-8f55-98fbd515271f",
						"revisionNr": 1
					}
				],
				"topology": null,
				"filter": null,
				"structure": null,
				"topologystructure": null
			},
			"id": "c9d5ca15-2561-4c58-85da-870a89242b87"
		}, {
			"name": "Filter2",
			"filterid": "0c39a1c5-2551-4587-8fd9-ec8b59372bcd",
			"definition": "[I]0F106AF0-A919-44C5-B211-15BD5EF620B6",
			"id": "c9d5ca15-2561-4c58-85da-870a89242b87"
		}
	],
	"id": "c9d5ca15-2561-4c58-85da-870a89242b87"

}    }
  ],
  "id":"c9d5ca15-2561-4c58-85da-870a89242b87"
}

Anchor

	deleteProjectClashFilter
	deleteProjectClashFilter

Delete the clash filter

Deck of Cards

id	bimDeleteProjectClashFilter

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashfilters/<clashfilter_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/clashfilters/<clashfilter_id>

Example: https://api-stage.bimplus.net/v2/bimplus/clashfilters/c9d5ca15-2561-4c58-85da-870a89242b87

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified clash filter.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 22

New Version 23

Key

Clash Service

Detect all the clashes in a project

Detect clashes between disciplines & objects/topologies

Calculate clashes in project using particular clash filter

Calculate clashes in project using particular clash filter

Get all clashes for given project and clash filter

Get all clashes for given project and clash filter

Get all clash filters for a team

Create an clash filter in the project

Get all clash filters for a project

Get all clash filters for a team

Get details of single clash filter

Update the clash filter

Get details of single clash filter

Delete the clash filter