Clash Detection

Models And Categories

Download API definition:

POST https://sampleHostName/clashdetection/modelsAndCategories/imodels/{id}

Extracts the models and categories for the latest named version of an iModel.

  • A status of 202 is returned if the extraction job was successfully started. The job completes asynchronously so the user can periodically call GET /clashdetection/modelsAndCategories/imodels until a status of 'available' is returned with the response.

  • Discover iModel ids by calling GET /imodels

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 parameters

Name
In
Required?
Description
id
template
Yes

iModel id

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

extract-models-and-categories-body

Name
Type
Required?
Description
No data.

Response 202 Accepted

Accepted

Response headers

Name
Description
Location

The resource location

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.