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 itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
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.
The number of rules to get in each page. Max 50, but 10 is the default if this parameter is not included.
Request headers
Optional. Select preferred representation.
Optional. Include user metadata when true.
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "suppressionRules": [{ "id": "ZuO3OCC8sUuVcgeXz1Ih_TGCT5rBByBBqcycpQKmKtY", "displayName": "MySuppressionRule1011202134318", "_links": { "rule": { "href": "https://api.bentley.com/clashdetection/suppressionrules/ZuO3OCC8sUuVcgeXz1Ih_TGCT5rBByBBqcycpQKmKtY" } } }], "_links": { "next": { "href": "https://api.bentley.com/clashdetection/suppressionrules?projectId=38b7e366-bc20-4bb1-9572-0797cf5221fd&continuationToken=eyJ0b3AiOjEwLCJza2lwVG9rZW4iOiJNZz09In0" } } }
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified project was not found.
{ "error": { "code": "ProjectNotFound", "message": "Requested project is not available." } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Clash Detection Suppression Rules
Array of clash detection suppression rules metadata (summary)
Clash Detection Suppression Rules
Array of clash detection suppression rules metadata
Clash Detection Rule Link
Clash Detection Suppression Rule
Clash detection suppression rule summary (id and display name)
The clash detection suppression rule id.
The display name of the clash detection suppression rule.
Clash Detection Suppression Rule
The id of the suppression rule.
The name of the suppression rule.
The template id of the suppression rule.
The reason for the suppression rule.
The parameters for the suppression rule.
The date/time when the test was created.
The date/time when the test was last modified.
The links to get the related suppression rule response links.
Clash Detection Suppression Rule Links
Link
Hyperlink container.
Hyperlink container.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
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.