Table of contents
Clash Detection
Download API definition:
This operation is deprecated. Please upgrade to the current version of this API as soon as possible.
POST https://api.bentley.com/clashdetection/tests

Creates clash detection test for the specified criteria and returns the test id.

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 headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Request body

Create Clash Detection Test

Name
Type
Required?
Description
projectId
String
Yes

The project id where the test is to be created.

displayName
String
Yes

The name of the test.

description
String
Yes

The description of the test.

suppressTouching
Boolean
Yes

Flag to suppress touching.

includeSubModels
Boolean
Yes

Flag to include sub-models.

touchingTolerance
Number
Yes

The touching tolerance to be applied.

setA
Yes

Elements to include in clash test.

setB
Yes

Elements to include in clash test.

suppressionRules
String[]
Yes

The ids of the suppression rules.

advancedSettings
No

Advanced settings for clash test.

Example

json
{
    "projectId": "38b7e366-bc20-4bb1-9572-0797cf5221fd",
    "displayName": "Test4",
    "description": "test 4",
    "setA": {
        "modelIds": [
            "0x21",
            "0x66",
            "0x68",
            "0x6a",
            "0x6c"
        ],
        "categoryIds": [],
        "selfCheck": true,
        "clearance": 0.001
    },
    "setB": {
        "modelIds": [],
        "categoryIds": [],
        "selfCheck": false,
        "clearance": 0
    },
    "suppressTouching": false,
    "touchingTolerance": 0,
    "includeSubModels": false,
    "suppressionRules": [
        "ZuO3OCC8sUuVcgeXz1Ih_Z44rgIyaT1Nia7oxeYeNew"
    ],
    "advancedSettings": {
        "longClash": true,
        "calculateOverlap": false,
        "toleranceOverlapValidation": false
    }
}

Response 201 Created

Created

json
{
    "test": {
        "id": "ZuO3OCC8sUuVcgeXz1Ih_WGuaQp4SaVBqhAjSSNDdYs",
        "displayName": "APIM-test4",
        "description": "APIM test 4",
        "setA": {
            "modelIds": [
                "0x21",
                "0x66",
                "0x68",
                "0x6a",
                "0x6c"
            ],
            "categoryIds": [],
            "selfCheck": true,
            "clearance": 0.001
        },
        "setB": {
            "modelIds": [],
            "categoryIds": [],
            "selfCheck": false,
            "clearance": 0
        },
        "suppressTouching": false,
        "touchingTolerance": 0,
        "includeSubModels": false,
        "suppressionRules": [
            "ZuO3OCC8sUuVcgeXz1Ih_Z44rgIyaT1Nia7oxeYeNew"
        ],
        "advancedSettings": {
            "longClash": true,
            "calculateOverlap": false,
            "toleranceOverlapValidation": false
        },
        "_links": {
            "self": {
                "href": "https://api.bentley.com/clashdetection/tests/ZuO3OCC8sUuVcgeXz1Ih_WGuaQp4SaVBqhAjSSNDdYs"
            }
        }
    }
}

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 project was not found.

json
{
    "error": {
        "code": "ProjectNotFound",
        "message": "Requested project 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 clash detection request.",
        "details": [{
                "code": "InvalidRequestBody",
                "message": "Required property 'projectId' is missing in the request body.",
                "target": "projectId"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Required property 'displayName' is missing in the request body.",
                "target": "displayName"
            },
            {
                "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 'query' is missing in setA of the request body.",
                "target": "query"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Required property 'queryName' is missing in setA of the request body.",
                "target": "queryName"
            },
            {
                "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 'query' is missing in setB of the request body.",
                "target": "query"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Required property 'queryName' is missing in setB of the request body.",
                "target": "queryName"
            },
            {
                "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 user has sent too many requests in a given amount of time.

json
{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

Name
Description
retry-after

The number of requests exceeds the rate-limit for the client subscription.

Clash Detection Test Set

Criteria set for clash test.

TableSchema
Name
Type
Description
modelIds
String[]

The ids of the models to include in the clash test.

categoryIds
String[]

The ids of the categories to include in the clash test.

query
String,null

EC Sql query expression to select elements for the test set.

queryName
String,null

Name of EC Sql query expression to select elements for the test set.

selfCheck
Boolean

Flag to perform self-check on the test set.

clearance
Number

The clearance between elements.

Clash Detection Test Advanced Settings

TableSchema
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.

Clash Detection Test

TableSchema
Name
Type
Description
id
String

The id of the test.

displayName
String

The name of the test.

description
String

The description of the test.

setA

Elements to include in clash test.

setB

Elements to include in clash test.

suppressTouching
Boolean

Flag to suppress touching.

touchingTolerance
Number

The touching tolerance to be applied.

includeSubModels
Boolean

Flag to include sub-models.

suppressionRules
String[]

The ids of the suppression rules.

advancedSettings

Advanced settings for clash test.

_links

The link to get the test details.

Clash Detection Test Detail Link

TableSchema
Name
Type
Description
self

The link to get the test details.

Create Clash Detection Test

Specify the test criteria to create a clash detection test.

TableSchema
Name
Type
Description
projectId
String

The project id where the test is to be created.

displayName
String

The name of the test.

description
String

The description of the test.

suppressTouching
Boolean

Flag to suppress touching.

includeSubModels
Boolean

Flag to include sub-models.

touchingTolerance
Number

The touching tolerance to be applied.

setA

Elements to include in clash test.

setB

Elements to include in clash test.

suppressionRules
String[]

The ids of the suppression rules.

advancedSettings

Advanced settings for clash test.

Link

Hyperlink container.

TableSchema
Name
Type
Description
href
String

Hyperlink container.

Error

Contains error information.

TableSchema
Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String, null

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.

TableSchema
Name
Type
Description
error

Error information.