Page History

...

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

...

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

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 23

New Version 24

Key

Detect all the clashes in a project