Clash Detection

Clash Detection Runs

Download API definition:

GET https://sampleHostName/clashdetection/runs?projectId

Retrieves a list of Clash Detection runs for the project specified by the project id.

Notes

The Prefer header can be used to specify how much clash detection run metadata is desired

  • "return=minimal" (default) - returns the minimum clash detection run metadata

  • "return=representation" - returns the full clash detection run 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 the clash detection runs.

Request headers

Name
Required?
Description
Prefer
No

Optional. Select preferred representation.

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.