Gets the clash detection result details for the specified result id.
- Discover result ids by calling GET /clashdetection/runs
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
Result id
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "result": [{ "clashType": "Collision", "clearance": -1, "elementAId": "0x20000000701", "elementALabel": "Pipe 6 1-SWS-0104", "elementACategoryIndex": 0, "elementAModelIndex": 0, "elementBId": "0x200000011a7", "elementBLabel": "Pipe 6 1-SWS-0107", "elementBCategoryIndex": 1, "elementBModelIndex": 0, "center": { "x": 39.01577949523926, "y": -20.889575958251953, "z": 5.114925384521484 }, "suppressingRuleIndexArray": [0], "status": "New" }], "categoryList": [{ "id": "0x20000000047", "displayName": "SWS-1-SWS-0104" }, { "id": "0x20000000049", "displayName": "SWS-1-SWS-0107" } ], "modelList": [{ "id": "0x20000000030", "displayName": "3D-PLANT" }], "suppressingRuleList": [{ "id": "ZuO3OCC8sUuVcgeXz1Ih_TGCT5rBByBBqcycpQKmKtY", "displayName": "test1" }] }
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified result was not found.
{ "error": { "code": "ClashDetectionResultNotFound", "message": "Requested result is not available." } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
The number of requests exceeds the rate-limit for the client subscription.
Clash Detection Result
Clash
The details for a clash between two elements.
The type of clash detected - possible values: Collision, Clearance, Touching, Not Initialized.
When the clash type is Clearance, the value is returned in meters. Otherwise -1 is returned.
The unique id of element A.
The display label of element A.
The zero-based index used to lookup the element A category in the categoryList.
The zero-based index used to lookup the element A model in the modelList.
The unique id of element B.
The display label of element B.
The zero-based index used to lookup the element B category in the categoryList.
The zero-based index used to lookup the element B model in the modelList.
The array of zero-based indices used to lookup the suppressing rules.
The status of clash result - possible values: New, Open, Resolved, Not Available.
Category Lookup Entry
Unique identifier of the category.
Display name of the category.
Model Lookup Entry
Unique identifier of the model.
Display name of the model.
Suppression Rule Lookup Entry
Unique identifier of the suppression rule.
Display name of the suppression rule.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
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.