Get Started
Documentation
Samples

Clash Detection

Overview
Tutorials
Samples
Reference
Changelog

Clash Detection Runs

Download API definition:
Get clash detection runs
GET https://api.bentley.com/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

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
Yes

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

Response

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 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.
Definitions
Clash Detection Run
Run metadata.
TableSchema
Name
Type
Description
id
String
Run id.
displayName
String
The display name of the run is the test name and execution date/time.
executedDateTime
Date-time
The date/time when the test was executed.
count
String
The number of clashes found.
userName
String
The name of the user that started the run.
status
String
The status of the clash detection run. One of 'queued', 'started', 'completed', 'failed', 'downloadingIModel', 'storingResults', 'inProgress', 'completedToLimit', 'cancelled', 'invalidSuppressionRules', 'completedWithElementLoadErrors'
resultId
String
Result id.
_links
clash-detection-run-links
The links to get the result and test details.
Clash Detection Run Links
TableSchema
Name
Type
Description
result
Link
The link to get the result details.
test
Link
The link to get the test details.
Clash Detection Run
Clash detection run summary (id and display name)
TableSchema
Name
Type
Description
id
String
The clash detection run id.
displayName
String
The display name of the clash detection run.
Clash Detection Runs
Array of clash detection runs metadata (summary)
TableSchema
Name
Type
Description
runs
clash-detection-run-summary[]
Clash Detection Runs
Array of clash detection runs metadata
TableSchema
Name
Type
Description
runs
clash-detection-run[]
Link
Hyperlink container.
TableSchema
Name
Type
Description
href
String
Hyperlink container.
Error
Contains error information.
TableSchema
Name
Type
Description
code
String
One of a server-defined set of error codes.
message
String
A human-readable representation of the error.
target
String
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.
TableSchema
Name
Type
Description
error
Error
Error information.