Updates a clash detection test for the specified criteria and returns the id and details of the successfully updated test.
-
Note: If Tag details are not provided to a Tagged Test then it will be un-tagged.
-
Discover test ids by calling GET /clash-detection/itwins/{itwinId}/tests
-
Discover suppression rule ids by calling GET /clash-detection/itwins/{itwinId}/suppression-rules
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
Test id
The iTwin Id
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.
Request body
Update Clash Detection Test
The name of the test.
The description of the test.
Flag to suppress touching.
Flag to include sub-models.
The touching tolerance to be applied.
The ids of the suppression rules.
Example
{ "name": "Test name", "description": "Description of clash detection test", "tag": { "id": "00000000-0000-0000-0000-000000000000", "type": "imodels" }, "setA": { "modelIds": [ "0x00000000000" ], "categoryIds": [ "0x00000000000" ], "selfCheck": false, "clearance": 0 }, "setB": { "modelIds": [ "0x00000000000" ], "categoryIds": [ "0x00000000000" ], "selfCheck": false, "clearance": 0 }, "suppressTouching": true, "touchingTolerance": 0, "includeSubModels": true, "suppressionRules": [], "advancedSettings": { "longClash": false, "calculateOverlap": false, "toleranceOverlapValidation": false } }
Response 200 OK
OK
{ "test": { "name": "Test name", "description": "Description of clash detection test", "tag": { "id": "00000000-0000-0000-0000-000000000000", "type": "imodels" }, "setA": { "modelIds": [ "0x00000000000" ], "categoryIds": [ "0x00000000000" ], "selfCheck": false, "clearance": 0 }, "setB": { "modelIds": [ "0x00000000000" ], "categoryIds": [ "0x00000000000" ], "selfCheck": false, "clearance": 0 }, "suppressTouching": true, "touchingTolerance": 0, "includeSubModels": true, "suppressionRules": [], "advancedSettings": { "longClash": false, "calculateOverlap": false, "toleranceOverlapValidation": false } } }
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 test was not found.
{ "error": { "code": "ClashDetectionTestNotFound", "message": "Requested test is not available." } }
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)
{ "error": { "code": "InvalidClashDetectionRequest", "message": "Invalid update clash detection test request.", "details": [{ "code": "InvalidRequestBody", "message": "Required property 'name' is missing in the request body.", "target": "name" }, { "code": "InvalidRequestBody", "message": "Required property 'description' is missing in the request body.", "target": "description" }, { "code": "InvalidRequestBody", "message": "Required property 'setA' is missing in the request body.", "target": "setA" }, { "code": "InvalidRequestBody", "message": "Required property 'modelIds' is missing in setA of the request body.", "target": "modelIds" }, { "code": "InvalidRequestBody", "message": "Required property 'categoryIds' is missing in setA of the request body.", "target": "categoryIds" }, { "code": "InvalidRequestBody", "message": "Required property 'selfCheck' is missing in setA of the request body.", "target": "selfCheck" }, { "code": "InvalidRequestBody", "message": "Required property 'clearance' is missing in setA of the request body.", "target": "clearance" }, { "code": "InvalidRequestBody", "message": "Required property 'setB' is missing in the request body.", "target": "setB" }, { "code": "InvalidRequestBody", "message": "Required property 'modelIds' is missing in setB of the request body.", "target": "modelIds" }, { "code": "InvalidRequestBody", "message": "Required property 'categoryIds' is missing in setB of the request body.", "target": "categoryIds" }, { "code": "InvalidRequestBody", "message": "Required property 'selfCheck' is missing in setB of the request body.", "target": "setB" }, { "code": "InvalidRequestBody", "message": "Required property 'clearance' is missing in setB of the request body.", "target": "clearance" }, { "code": "InvalidRequestBody", "message": "Required property 'suppressTouching' is missing in the request body.", "target": "suppressTouching" }, { "code": "InvalidRequestBody", "message": "Required property 'touchingTolerance' is missing in the request body.", "target": "touchingTolerance" }, { "code": "InvalidRequestBody", "message": "Required property 'includeSubModels' is missing in the request body.", "target": "includeSubModels" }, { "code": "InvalidRequestBody", "message": "Required property 'suppressionRules' is missing in the request body.", "target": "suppressionRules" }, { "code": "InvalidRequestBody", "message": "The request body is not a valid JSON object." }, { "code": "InvalidRequestBody", "message": "The request is invalid." }, { "code": "InvalidRequestBody", "message": "Request body was not provided." } ] } }
Response 429 Too many requests
This response indicates that the client sent more requests than allowed by this API for the current tier of the client.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Clash Detection Test Set
Criteria set for clash test.
The ids of the models for the clash test.
The ids of the categories for the clash test.
Flag to perform self-check on the test set.
The clearance between elements.
Clash Detection Test iModel details
Assign a guid to the tag eg. iModel-id.
Assign a name to the tag type eg. iModels.
Clash Detection Test Advanced Settings
Flag to enable long clash job processing (no processing time limit enforced - just result limit).
Flag to calculate and report clash overlaps (minimum orthogonal overlap distance).
Flag to enable tolerance overlap validation. If 'suppressTouching' and 'calculateOverlap' are set, clashes are suppressed for overlaps less than touching tolerance.
Clash Detection Test
Update Clash Detection Test
Specify the test criteria to update a clash detection test.
The name of the test.
The description of the test.
Flag to suppress touching.
Flag to include sub-models.
The touching tolerance to be applied.
The ids of the suppression rules.
DetailedError
Contains error information and an array of more specific errors.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Detailed 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.
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.
Was this page helpful?