Get Started
Documentation
Samples

Clash Detection

Overview
Tutorials
Samples
Reference
Changelog

Clash Detection Suppression Rules

Download API definition:
Get clash detection suppression rules
GET https://api.bentley.com/clashdetection/suppressionrules?projectId[&continuationToken][&$top]

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

Request

Request parameters

Name
In
Required?
Description
projectId
query
Yes

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

continuationToken
query
No

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.

$top
query
No

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

Request headers

Name
Required?
Description
Prefer
No

Optional. Select preferred representation.

Include-User-Metadata
No

Optional. Include user metadata when true.

Authorization
Yes

OAuth access token with scope clashdetection:read

Accept
Yes

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

Response

Response 200 OK

OK

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 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
Clash Detection Suppression Rules
Array of clash detection suppression rules metadata (summary)
TableSchema
Name
Type
Description
runs
clash-detection-suppression-rule-summary[]
Clash Detection Suppression Rules
Array of clash detection suppression rules metadata
TableSchema
Name
Type
Description
runs
update-clash-detection-suppression-rule-response[]
Clash Detection Rule Link
TableSchema
Name
Type
Description
rule
Link
The link to get the suppression rule.
Clash Detection Suppression Rule
Clash detection suppression rule summary (id and display name)
TableSchema
Name
Type
Description
id
String
The clash detection suppression rule id.
displayName
String
The display name of the clash detection suppression rule.
_links
clash-detection-suppression-rule-link
The links to get the suppression rules.
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.
creationDateTime
Date-time
The date/time when the test was created.
modificationDateTime
Date-time
The date/time when the test was last modified.
_links
update-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 suppression rule.
lastModifiedBy
Link
The link to get user details of the user that last modified the suppression rule.
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.