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 itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
The id of the project associated with the suppression rule templates.
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 rule templates to get in each page. Max 50, but 15 is the default if this parameter is not included.
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "suppressionRuleTemplates": [{ "id": "080c182c-c9ce-44e6-9932-de9f098befbc", "displayName": "Suppression/Definition/Generic/CompareProperties", "description": "Suppress clashes by comparing properties between the two clashing elements", "prompt": "Suppress clashes if property -Property- on one of the clashing elements is -Operator- the same property on the other clashing element", "templateExpression": { "propertyKey": { "relationshipPath": "ArchitecturalPhysical:Door", "propertyName": "Roll" }, "operator": { "value": "=" } } }], "_links": { "next": { "href": "https://api.bentley.com/clashdetection/suppressionRuleTemplates?projectId=38b7e366-bc20-4bb1-9572-0797cf5221fd&continuationToken=eyJ0b3AiOjMsInNraXBUb2tlbiI6Ik5RPT0ifQ" } } }
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." } }
The number of requests exceeds the rate-limit for the client subscription.
Suppresion Rule Template
The id of the suppression rule template.
The display name of the suppression rule template.
The description of the suppression rule template.
The prompt for the suppression rule template.
The expression of the suppression rule template.
Forward-Only Paging Link
Link to get the next page of data, if applicable. Link to the previous page is not available.
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.