The Clash Detection API allows you to manage clash detection suppression rules, tests, runs, and results. You can run tests and monitor the progress.

clash-detection

## iTwin Clash Detection API
iTwin Clash Detection API checks for geometrical collision between various design element groups in the digital twin. In general terms, this involves checking if the geometrical extents of design elements are colliding or coming under clearance limits with other geometries in the digital twin. This API includes two main components: tests and results and the ability to manage them.

### Clash Tests
Clash tests define two sets of design elements based on engineering models or categories defined in the digital twin. For example, all design elements for mechanical equipment can be part of the first group, and all piping elements can be placed together in the second group.

Clash tests have advanced options for setting up clearance or suppression rules.
- Clearance around a design element. For example, all pipes must have 6in clearance for insulation requirements.
- Suppress touching with an ability to define tolerance to suppress clashes when two design elements are touching each other. For example, a steel beam and a steel column touching at the connection.
- Suppression criteria are defined based on logical rules. For example, all clashes between a wooden door and a concrete wall should be suppressed.

### Clash Results
Results are provided for each type of test. They contain clashing results for pairs of elements in the digital twin based on criteria defined in the clash test.

### Typical Clash Detection Workflow
The process for detecting clashes in iModels consists of the following steps:
- Add a clash detection test.
- Specify an iModel, version, and clash detection type.
- Designate the two sets to check against.
- Run the clash detection test.
- Retrieve and review the clash detection results.



---

Gets the clash detection result details for the specified result id.

- A link to get result details for a clash detection run can be obtained by calling [GET /clashdetection/run](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-run/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-clashdetection-result

OAuth access token with scope `clashdetection:read`

Authorization

Setting to `application/vnd.bentley.itwin-platform.v1+json` is recommended.

Accept

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

This response indicates that the specified result was not found.

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Deletes the clash detection run for the specified run id.

- Run ids can be discovered by calling [GET /clashdetection/runs](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-runs/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

delete-clashdetection-run

OAuth access token with scope `clashdetection:modify`

Indicates that the run was successfully deleted. There is no response body in this case.

This response indicates that the specified run was not found.

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

---

Retrieves details of a clash detection run for the run specified by the run id.

- Run ids can be discovered by calling [GET /clashdetection/runs](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-runs/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-clashdetection-run

---

Retrieves a list of Clash Detection runs for the project specified by the project id.

### Notes

The Prefer header can be used to specify how much clash detection run metadata is desired

- "return=minimal" (default) - returns the minimum clash detection run metadata

- "return=representation" - returns the full clash detection run metadata

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-clashdetection-runs

The project id of the project from which to retrieve the clash detection runs.

projectId

Optional.  Select preferred representation.

Prefer

This response indicates that the specified project was not found.

---

Runs a Clash Detection test for the specified test id and returns the run id.

- A link is included to retrieve the run status as the agent job completes asynchronously.

- Test ids can be discovered by calling [GET /clashdetection/tests](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-tests/)

- iModel ids can be discovered by calling [GET /imodels](/api-groups/data-management/apis/imodels/operations/get-project-imodels/)

- Named version ids can be discovered by calling [GET /imodels/{id}/namedversions](/api-groups/data-management/apis/imodels/operations/get-imodel-named-versions/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

run-clashdetection-test

This response indicates that the specified test was not found.

---

Creates a clash detection suppression rule for the specified criteria and returns the rule id.

- Rule template ids can be discovered by calling [GET /clashdetection/suppressionRuleTemplates](/api-groups/validation/apis/clash-detection/operations/get-suppression-rule-templates/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

create-clashdetection-suppression-rule

---

Deletes the clash detection suppression rule for the specified test id.

- Rule ids can be discovered by calling [GET /clashdetection/suppressionRules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-clashdetection-suppression-rule

Indicates that the suppression rule was successfully deleted. There is no response body in this case.

This response indicates that the specified suppression rule was not found.

---

Gets the clash detection suppression rule details for the specified rule id.

- Rule ids can be discovered by calling [GET /clashdetection/suppressionRules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-clashdetection-suppression-rule

This response indicates that the specified rule was not found.

---

Retrieves a list of clash detection suppression rules for the project specified by the project id.

### Notes

The Prefer header can be used to specify how much rule metadata is desired

- "return=minimal" (default) - returns the minimum suppression rule metadata

- "return=representation" - returns the full suppression rule metadata

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-clashdetection-suppression-rules

The project id of the project from which to retrieve clash detection suppression rules.

Parameter that enables continuing to the next page of the previous paged query. This must be passed exactly as it is in the response body's _links.next property. If this is specified and $top is omitted, the next page will be the same size as the previous page.

continuationToken

The number of rules to get in each page. Max 50, but 10 is the default if this parameter is not included.

$top

Optional. Selected preferred representation.

---

Retrieves a list of Clash Detection suppression rule templates for the project specified by the project id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-suppression-rule-templates

The id of the project associated with the suppression rule templates.

The number of rule templates to get in each page. Max 50, but 15 is the default if this parameter is not included.

---

Updates a clash detection suppression rule for the specified criteria and returns the id of the successfully updated rule.

- Rule ids can be discovered by calling [GET /clashdetection/suppressionRules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

update-clashdetection-suppression-rule

---

Creates clash detection test for the specified criteria and returns the test id.

- Rule ids can be discovered by calling [GET /clashdetection/suppressionRules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

create-clashdetection-tests

---

Deletes the clash detection test for the specified test id.

- Test ids can be discovered by calling [GET /clashdetection/tests](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-tests/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-clashdetection-test

Indicates that the test was successfully deleted. There is no response body in this case.

---

Gets the clash detection test details for the specified test id.

- Test ids can be discovered by calling [GET /clashdetection/tests](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-tests/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-clashdetection-test

---

Retrieves a list of Clash Detection tests for the project specified by the project id.

### Notes

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-clashdetection-tests

The project id of the project from which to retrieve clash detection tests.

The number of tests to get in each page. Max 50, but 10 is the default if this parameter is not included.

---

Updates a clash detection test for the specified criteria and returns the id of the successfully updated test.

- Test ids can be discovered by calling [GET /clashdetection/tests](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-tests/)

- Rule ids can be discovered by calling [GET /clashdetection/suppressionRules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

update-clashdetection-test

---

Gets the models and categories for the named version of an iModel.

- A status of 202 is returned if a data extraction needs to be processed.  The job completes asynchronously so the user can repeat this request periodically until a status of 200 is returned with the response.

- iModel ids can be discovered by calling [GET /imodels](/api-groups/data-management/apis/imodels/operations/get-project-imodels/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-models-and-categories

The id of the project containing the iModel from which to retrieve the models and categories.

This response indicates that the specified iModel or project was not found.

---

Gets the schemas for the latest named version of an iModel.

- A status of 202 is returned if a schema extraction needs to be processed.  The job completes asynchronously so the user can repeat this request periodically until a status of 200 is returned with the response.

- iModel ids can be discovered by calling [GET /imodels](/api-groups/data-management/apis/imodels/operations/get-project-imodels/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `clashdetection:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-schema-info

The id of the project containing the iModel from which to retrieve the schema info.

View and interact with your iTwin in a web browser using Bentley cloud services.


visualization

Export engineering design data from iModels to other formats like IFC or LandXML.


export

Synchronize engineering design data from native formats to web-viewable iTwins.


synchronization

Transform Engineering Data for Data Alignment or Performance Improvements


transformations

Coordinate concurrent access to iModels and track the timeline of engineering changes.


imodels

Manage and publish catalogs of approved digital components.


library

Securely store 3D scalable meshes, point clouds, and photos.


reality-data

storage

Manage projects associated with your iTwin.


projects

Manage users who interact with your iTwin.


users

Convert photos into high resolution 3D reality meshes.


contextcapture

Detect collisions and check clearance between geometric elements.


The Classification Validation API allows you to manage classification validation tests, runs, and results. You can run tests and monitor the progress.

classification-validation

The Property Validation API allows you to manage property value validation rules, tests, runs, and results. You can run tests and monitor the progress.

validation

Access the Design Element Classification machine learning model.


designelementclassification

Build custom dashboards and integrate iTwin data with other business applications.


insights

Compare engineering design versions and identify elements that changed.


changed-elements

Store, manage, and access field data in the cloud.


forms

Create, analyze, and prioritize issues.


issues-v1

The Webhooks API allows you to subscribe to events happening in iTwin Platform.


Clash Detection Suppression Rules

Download API definition:

Get clash detection suppression rules

Notes

Authentication