Clash Detection

Clash Detection Tests

Download API definition:

POST https://sampleHostName/clashdetection/tests

Creates clash detection test for the specified criteria and returns the test id.

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

create-clash-detection-test-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 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.