Get Started
Documentation
Samples
Table of contents
Overview
Tutorials
Samples
Changelog
Clash Detection

Clash Detection Suppression Rules

Download API definition:
Create clash detection suppression rule
POST https://api.bentley.com/clashdetection/suppressionrules

Creates a clash detection suppression rule for the specified criteria and returns the rule id.

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 page.

Request

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope clashdetection:modify

Accept
Yes

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

Request body

Create Clash Detection Suppression Rule

Name
Type
Required?
Description
displayName
String
Yes

The name of the suppression rule.

reason
String
Yes

The description of the suppression rule.

parameters
Object
Yes

The parameters of the suppression rule must match the parameters of the template.

templateId
String
Yes

The template id of the suppression rule.

Example

json
Response
Response 201 Created
Created
json
Response 401 Unauthorized
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.
json
Response 404 Not Found
This response indicates that the specified project was not found.
json
Response 422 Unprocessable Entity
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)
json
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
json
Response headers
Name
Description
retry-after
The number of requests exceeds the rate-limit for the client subscription.
Definitions
Create Clash Detection Suppression Rule
Specify the rule criteria to create a suppression rule.
TableSchema
Name
Type
Description
displayName
String
The name of the suppression rule.
reason
String
The description of the suppression rule.
parameters
Object
The parameters of the suppression rule must match the parameters of the template.
templateId
String
The template id of the suppression rule.
Clash Detection Suppression Rule
TableSchema
Name
Type
Description
id
String
The id of the suppression rule.
displayName
String
The name of the suppression rule.
templateId
String
The template id of the suppression rule.
reason
String
The reason for the suppression rule.
parameters
String
The parameters for the suppression rule.
_links
create-clash-detection-suppression-rule-response-links
The links to get the related suppression rule response links.
Clash Detection Suppression Rule Links
TableSchema
Name
Type
Description
self
Link
The link to get the suppresion rule.
createdBy
Link
The link to get user details of the user that created the test.
Link
Hyperlink container.
TableSchema
Name
Type
Description
href
String
Hyperlink container.
Error
Contains error information.
TableSchema
Name
Type
Description
code
String
One of a server-defined set of error codes.
message
String
A human-readable representation of the error.
target
String
The target of the error.
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
TableSchema
Name
Type
Description
error
Error
Error information.