Get clash detection test details - Clash Detection

Clash Detection

Get clash detection test details

This operation is deprecated. Please upgrade to the current version of this API as soon as possible.

get https://dev-api.bentley.com/clashdetection/tests/{id}

Gets the clash detection test details for the specified test id.

Discover test ids by calling GET /clashdetection/tests

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

Yes

Test id

Request headers

Include-User-Metadata

Optional. Include user metadata when true.

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "test": {
        "id": "ZuO3OCC8sUuVcgeXz1Ih_WGuaQp4SaVBqhAjSSNDdYs",
        "displayName": "ClashDetectionTest1",
        "description": "Clash Detection Test",
        "creationDateTime": "2021-06-17T14:45:47.6600000+00:00",
        "modificationDateTime": "2021-06-24T14:49:59.6600000+00:00",
        "setA": {
            "modelIds": ["0x21", "0x66", "0x68", "0x6a", "0x6c"],
            "categoryIds": [],
            "selfCheck": true,
            "clearance": 0.111
        },
        "setB": {
            "modelIds": [],
            "categoryIds": [],
            "selfCheck": false,
            "clearance": 0
        },
        "suppressTouching": true,
        "touchingTolerance": 0,
        "includeSubModels": true,
        "suppressionRules": [],
        "advancedSettings": {
            "longClash": true,
            "calculateOverlap": false,
            "toleranceOverlapValidation": false
        },
        "_links": {
            "createdBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/99cf5e21-735c-4598-99eb-fe3940f96353"
            },
            "lastModifiedBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/99cf5e21-735c-4598-99eb-fe3940f96353"
            }
        },
        "userMetadata": {
            "createdBy": {
                "email": "John.Johnson@org.com",
                "name": "John Johnson"
            },
            "modifiedBy": {
                "email": "John.Johnson@org.com",
                "name": "John Johnson"
            }
        }
    }
}

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

{
    "$ref": "#/components/examples/401.HeaderNotFound.example"
}

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

Link

Hyperlink container.

href

String

Hyperlink container.

json

{
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink container."
        }
    },
    "description": "Hyperlink container."
}

Error

Contains error information.

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.

json

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

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

Error

Error information.

json

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

Clash Detection Test

String

The id of the test.

setA

clash-detection-test-set

setB

clash-detection-test-set

_links

clash-detection-test-user-links

description

String

The description of the test.

displayName

String

The display name of the test.

advancedSettings

clash-detection-test-advanced-settings

creationDateTime

Date-time

The date/time when the test was created.

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.

modificationDateTime

Date-time

The date/time when the test was last modified.

json

{
    "type": "object",
    "title": "Clash Detection Test",
    "properties": {
        "id": {
            "type": "string",
            "description": "The id of the test."
        },
        "setA": {
            "$ref": "#/components/schemas/clash-detection-test-set"
        },
        "setB": {
            "$ref": "#/components/schemas/clash-detection-test-set"
        },
        "_links": {
            "$ref": "#/components/schemas/clash-detection-test-user-links"
        },
        "description": {
            "type": "string",
            "description": "The description of the test."
        },
        "displayName": {
            "type": "string",
            "description": "The display name of the test."
        },
        "advancedSettings": {
            "$ref": "#/components/schemas/clash-detection-test-advanced-settings"
        },
        "creationDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the test was created."
        },
        "includeSubModels": {
            "type": "boolean",
            "description": "Flag to include sub-models."
        },
        "suppressTouching": {
            "type": "boolean",
            "description": "Flag to suppress touching."
        },
        "suppressionRules": {
            "type": "array",
            "items": {
                "type": "string",
                "description": "The id of the suppression rule."
            },
            "description": "The ids of the suppression rules."
        },
        "touchingTolerance": {
            "type": "number",
            "description": "The touching tolerance to be applied."
        },
        "modificationDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the test was last modified."
        }
    }
}

Clash Detection Test Set

Criteria set for clash test.

query

Object

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

modelIds

String[]

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

clearance

Number

The clearance between elements.

queryName

Object

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

selfCheck

Boolean

Flag to perform self-check on the test set.

categoryIds

String[]

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

json

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

Clash Detection Test User Links

createdBy

Link

lastModifiedBy

Link

json

{
    "type": "object",
    "title": "Clash Detection Test User Links",
    "properties": {
        "createdBy": {
            "$ref": "#/components/schemas/Link"
        },
        "lastModifiedBy": {
            "$ref": "#/components/schemas/Link"
        }
    }
}

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

{
    "type": "object",
    "title": "Clash Detection Test Advanced Settings",
    "required": [
        "longClash",
        "calculateOverlap",
        "toleranceOverlapValidation"
    ],
    "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."
        }
    }
}

Was this page helpful?