Clash Detection

Models And Categories

Download API definition:

GET https://sampleHostName/clashdetection/modelsAndCategories/imodels/{id}?projectId

Gets the models and categories for the named version of an iModel. This request relies on a previous call to start the extraction job on an agent. Since this extraction completes asynchronously, the user can send this request periodically until a status of 'available' is returned in the response.

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
id
template
Yes

iModel id

projectId
query
Yes

The id of the project containing the iModel from which to retrieve the models and categories.

Request headers

Name
Required?
Description
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 iModel or 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.