Gets the clash detection suppression rule details for the specified rule id.
- Discover rule ids by calling GET /clashdetection/r
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
Rule id
Request headers
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
{ "suppressionRule": { "displayName": "ClashDetectionTest1", "reason": "Clash Detection Test", "creationDateTime": "2021-06-17T14:45:47.66Z", "modificationDateTime": "2021-06-24T14:49:59.66Z", "templateId": "ZuO3OCC8sUuVcgeXz1Ih_fFWlDoxH2FNmf0lWD6M8Dg", "parameters": "{\"propertyName\":\"Pitch\",\"lowerBound\":\"1\",\"upperBound\":\"2\"}", "_links": { "createdBy": { "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/99cf5e21-735c-4598-99eb-fe3940f96353" }, "lastModifiedBy": { "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/99cf5e21-735c-4598-99eb-fe3940f96353" } }, "userMetadata": { "createdBy": { "email": "John.Johnson@org.com", "name": "John Johnson" }, "modifiedBy": { "email": "John.Johnson@org.com", "name": "John Johnson" } } } }
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 rule was not found.
{ "error": { "code": "ClashDetectionSuppressionRuleNotFound", "message": "Requested suppression rule 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." } }
The number of requests exceeds the rate-limit for the client subscription.
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.
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.