Clash Detection

Clash Detection Suppression Rules

Download API definition:

GET https://sampleHostName/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 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
No

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

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