Clash Detection

Clash Detection Runs

Download API definition:

POST https://sampleHostName/clashdetection/runs

Runs a Clash Detection test for the specified test id and returns the run id. The maximum number of clashes may be specified with the resultsLimit parameter in the request body. If none is specified, the default is 100,000.

  • This API has a rate limit of 6 API calls per second. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying.

  • A link is included to retrieve the run status as the agent job completes asynchronously.

  • Discover test ids by calling GET /clashdetection/tests

  • Discover iModel ids by calling GET /imodels

  • Discover named version ids by calling GET /imodels/{id}/namedversions

Authentication

Requires Authorization header with valid Bearer token for scope clashdetection:modify.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.


Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope clashdetection:modify

Accept
No

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

Request body

clash-detection-run-body

Name
Type
Required?
Description
No data.

Response 201 Created

Created

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