Create clash detection tests - Clash Detection

Clash Detection

Download API definition:

Create clash detection tests

POST https://api.bentley.com/clash-detection/itwins/{itwinId}/tests

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

Discover 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

itwinId

Yes

The iTwin Id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Details of Clash Detection Test

name

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

clash-detection-test-set

Yes

Elements to include in clash test.

setB

clash-detection-test-set

Yes

Elements to include in clash test.

suppressionRules

String[]

The ids of the suppression rules.

advancedSettings

clash-detection-test-advanced-settings

Advanced settings for clash test.

tag

clash-detection-test-tag

Tag details to be associated with the clash test.

Example

json

{
    "name": "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": [
        "d313c62f-0187-434d-b56e-e3abb99be4b3"
    ],
    "advancedSettings": {
        "longClash": true,
        "calculateOverlap": false,
        "toleranceOverlapValidation": false
    },
    "tag": {
        "id": "60ec7a6d-6cec-49eb-872d-1c473ec6580d",
        "type": "iModels"
    }
}

Response 201 Created

Created

json

{
    "test": {
        "id": "f79c000a-1c38-45af-accd-87d80966ed49",
        "name": "APIM test Sample"
    }
}

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

json

{
    "error": {
        "code": "iTwinNotFound",
        "message": "Requested iTwin 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 create 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 body 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

retry-after

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

Definitions

Clash Detection Test Set

Criteria set for clash test.

modelIds

String[]

The ids of the models for the clash test.

categoryIds

String[]

The ids of the categories for the clash test.

selfCheck

Boolean

Flag to perform self-check on the test set.

clearance

Number

The clearance between elements.

json

{
    "title": "Clash Detection Test Set",
    "type": "object",
    "description": "Criteria set for clash test.",
    "properties": {
        "modelIds": {
            "type": "array",
            "description": "The ids of the models for the clash test.",
            "items": {
                "type": "string",
                "description": "The model id."
            }
        },
        "categoryIds": {
            "type": "array",
            "description": "The ids of the categories for the clash test.",
            "items": {
                "type": "string",
                "description": "The category id."
            }
        },
        "selfCheck": {
            "type": "boolean",
            "description": "Flag to perform self-check on the test set."
        },
        "clearance": {
            "type": "number",
            "description": "The clearance between elements."
        }
    },
    "additionalProperties": false
}

Clash Detection Test iModel details

String

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

type

String

Assign a name to the tag type eg. iModels.

json

{
    "title": "Clash Detection Test iModel details",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Assign a guid to the tag eg. iModel-id."
        },
        "type": {
            "type": "string",
            "description": "Assign a name to the tag type eg. iModels."
        }
    },
    "additionalProperties": false
}

Clash Detection Test Advanced Settings

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.

json

{
    "title": "Clash Detection Test Advanced Settings",
    "type": "object",
    "properties": {
        "longClash": {
            "type": "boolean",
            "description": "Flag to enable long clash job processing (no processing time limit enforced - just result limit)."
        },
        "calculateOverlap": {
            "type": "boolean",
            "description": "Flag to calculate and report clash overlaps (minimum orthogonal overlap distance)."
        },
        "toleranceOverlapValidation": {
            "type": "boolean",
            "description": "Flag to enable tolerance overlap validation. If 'suppressTouching' and 'calculateOverlap' are set, clashes are suppressed for overlaps less than touching tolerance."
        }
    },
    "additionalProperties": false,
    "required": [
        "longClash",
        "calculateOverlap",
        "toleranceOverlapValidation"
    ]
}

Clash Detection Test

test

clash-detection-test-response

Clash detection test creation responses.

json

{
    "title": "Clash Detection Test",
    "type": "object",
    "properties": {
        "test": {
            "type": "object",
            "description": "Clash detection test creation responses.",
            "$ref": "#/components/schemas/clash-detection-test-response"
        }
    },
    "additionalProperties": false
}

Clash Detection Test

String

Unique id of the test.

name

String

Name of the test.

json

{
    "title": "Clash Detection Test",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique id of the test."
        },
        "name": {
            "type": "string",
            "description": "Name of the test."
        }
    },
    "additionalProperties": false
}

Details of Clash Detection Test

Specify the test criteria to create a clash detection test.

name

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

clash-detection-test-set

Elements to include in clash test.

setB

clash-detection-test-set

Elements to include in clash test.

suppressionRules

String[]

The ids of the suppression rules.

advancedSettings

clash-detection-test-advanced-settings

Advanced settings for clash test.

tag

clash-detection-test-tag

Tag details to be associated with the clash test.

json

{
    "title": "Details of Clash Detection Test",
    "type": "object",
    "description": "Specify the test criteria to create a clash detection test.",
    "properties": {
        "name": {
            "type": "string",
            "description": "The name of the test."
        },
        "description": {
            "type": "string",
            "description": "The description of the test."
        },
        "suppressTouching": {
            "type": "boolean",
            "description": "Flag to suppress touching."
        },
        "includeSubModels": {
            "type": "boolean",
            "description": "Flag to include sub-models."
        },
        "touchingTolerance": {
            "type": "number",
            "description": "The touching tolerance to be applied."
        },
        "setA": {
            "$ref": "#/components/schemas/clash-detection-test-set",
            "description": "Elements to include in clash test."
        },
        "setB": {
            "$ref": "#/components/schemas/clash-detection-test-set",
            "description": "Elements to include in clash test."
        },
        "suppressionRules": {
            "type": "array",
            "description": "The ids of the suppression rules.",
            "items": {
                "type": "string",
                "description": "The id of the suppression rule."
            }
        },
        "advancedSettings": {
            "$ref": "#/components/schemas/clash-detection-test-advanced-settings",
            "description": "Advanced settings for clash test."
        },
        "tag": {
            "$ref": "#/components/schemas/clash-detection-test-tag",
            "description": "Tag details to be associated with the clash test."
        }
    },
    "additionalProperties": false,
    "required": [
        "name",
        "description",
        "setA",
        "setB",
        "suppressTouching",
        "includeSubModels",
        "touchingTolerance"
    ]
}

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

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

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Error

Contains error information.

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.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?