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.

Anchor

	detectClash
	detectClash

Detect all the clashes in a project

Deck of Cards

id	bimDetectClash

Card

default	true
label	URL / Resource / JSON Structure

Resource: services/postprocess

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

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

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

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

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

Anchor

	detectClashObjects
	detectClashObjects

Detect clashes between disciplines & objects/topologies

Deck of Cards

id	bimDetectClashObjects

Card

default	true
label	URL / Resource / JSON Structure

Resource: clashdetection

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)

Card

label	HTTP Method

POST

Card

label	Description

Detect clashes between disciplines & objects/topologies.

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

{
    "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"
    ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "clashcount": 4
}

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/d76a6719-d858-45d1-a8e9-929efc58a356

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": "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"
}

Anchor

	calculateClashes
	calculateClashes

Calculate clashes in project using particular clash filter

Deck of Cards

id	bimCalculateClashes

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:

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": [
    {
      "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": "0dfa47b8-0efb-4c57-8859-ef90b4ad6453",
      "elements": [
        "15461bb3-9994-4e54-8411-f94437e81e21",
        "36a5af0f-bef8-478f-bc2f-0b0e567260e2"
      ],
      "element1": {
        "id": "4eeeb292-3672-483e-94e5-0da5bb65a1a1",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "eeca2016-4fdf-4966-9143-ce94ad4b972c",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 3,
      "volume": 0.055550000000000009
    }
  ],
  "unresolved": [
    {
      "id": "ad2bddc6-1a5d-4a0b-b815-042cec0198a5",
      "elements": [
        "75757fc1-ba76-4f64-ab29-7f5e2d85cfd1",
        "6edb8bc0-9417-4072-a375-98c11c692357"
      ],
      "element1": {
        "id": "19be02c9-2080-4f54-a545-154cc22b8628",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "f3c9162d-7b4a-4eba-a86f-72404be65445",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 2,
      "volume": 3.4398162022732786
    },
    {
      "id": "8f8c8720-2324-41d7-a669-d8cefb9328ff",
      "elements": [
        "68813fe9-ea07-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": [
    
  ]
}

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,
  "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": "0dfa47b8-0efb-4c57-8859-ef90b4ad6453",
      "elements": [
        "15461bb3-9994-4e54-8411-f94437e81e21",
        "36a5af0f-bef8-478f-bc2f-0b0e567260e2"
      ],
      "element1": {
        "id": "4eeeb292-3672-483e-94e5-0da5bb65a1a1",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "eeca2016-4fdf-4966-9143-ce94ad4b972c",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 3,
      "volume": 0.055550000000000009
    }
  ],
  "unresolved": [
    {
      "id": "ad2bddc6-1a5d-4a0b-b815-042cec0198a5",
      "elements": [
        "75757fc1-ba76-4f64-ab29-7f5e2d85cfd1",
        "6edb8bc0-9417-4072-a375-98c11c692357"
      ],
      "element1": {
        "id": "19be02c9-2080-4f54-a545-154cc22b8628",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "element2": {
        "id": "f3c9162d-7b4a-4eba-a86f-72404be65445",
        "type": "Element",
        "name": "<Unnamed Element>"
      },
      "nr": 2,
      "volume": 3.4398162022732786
    },
    {
      "id": "8f8c8720-2324-41d7-a669-d8cefb9328ff",
      "elements": [
        "68813fe9-ea07-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": [
    
  ]
}

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 19

New Version 20

Key

Clash Service

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

Get all clashes for given project and clash filter