Table of contents
Clash Detection
Download API definition:
put https://dev-api.bentley.com/clash-detection/itwins/{itwinId}/tests/{id}

Updates a clash detection test for the specified criteria and returns the id and details of the successfully updated test.

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

Name
Required?
Description
id
Yes

Test id

itwinId
Yes

The iTwin Id

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.

Request body

Update Clash Detection Test

Name
Type
Required?
Description
name
String
Yes

The name of the test.

description
String
Yes

The description of the test.

includeSubModels
Boolean
Yes

Flag to include sub-models.

suppressTouching
Boolean
Yes

Flag to suppress touching.

suppressionRules
String[]
Yes

The ids of the suppression rules.

touchingTolerance
Number
Yes

The touching tolerance to be applied.

Example

json
{
    "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

json
{
    "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.

json
{
    "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.

json
{
    "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)

json
{
    "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.

json
{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

Name
Description
retry-after

Number of seconds to wait until client is allowed to make more requests.

Error

Contains error information.

Name
Type
Description
code
String

One of a server-defined set of error codes.

target
String, null

The target of the error.

message
String

A human-readable representation of the error.

DetailedError

Contains error information and an array of more specific errors.

Name
Type
Description
code
String

One of a server-defined set of error codes.

target
String, null

The target of the error.

details

Optional array of more specific errors.

message
String

A human-readable representation 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.

Name
Type
Description
error

Error information.

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.

Name
Type
Description
error

Error Detailed information.

Clash Detection Test Set

Criteria set for clash test.

Name
Type
Description
modelIds
String[]

The ids of the models for the clash test.

clearance
Number

The clearance between elements.

selfCheck
Boolean

Flag to perform self-check on the test set.

categoryIds
String[]

The ids of the categories for the clash test.

Clash Detection Test iModel details

Name
Type
Description
id
String

Assign a guid to the tag eg. iModel-id.

type
String

Assign a name to the tag type eg. iModels.

Update Clash Detection Test

Specify the test criteria to update a clash detection test.

Name
Type
Description
name
String

The name of the test.

description
String

The description of the test.

includeSubModels
Boolean

Flag to include sub-models.

suppressTouching
Boolean

Flag to suppress touching.

suppressionRules
String[]

The ids of the suppression rules.

touchingTolerance
Number

The touching tolerance to be applied.

Clash Detection Test

Name
Type
Description

Clash Detection Test Advanced Settings

Name
Type
Description
longClash
Boolean

Flag to enable long clash job processing (no processing time limit enforced - just result limit).

calculateOverlap
Boolean

Flag to calculate and report clash overlaps (minimum orthogonal overlap distance).

toleranceOverlapValidation
Boolean

Flag to enable tolerance overlap validation. If 'suppressTouching' and 'calculateOverlap' are set, clashes are suppressed for overlaps less than touching tolerance.

Was this page helpful?