Get clash detection result details - Clash Detection

Clash Detection

Get clash detection result 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/results/{id}

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

Discover result ids by calling GET /clashdetection/runs

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

Result id

Request headers

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

{
    "result": [{
        "clashType": "Collision",
        "clearance": -1,
        "elementAId": 2199023257345,
        "elementALabel": "Pipe 6 1-SWS-0104",
        "elementACategoryIndex": 0,
        "elementAModelIndex": 0,
        "elementBId": 2199023260071,
        "elementBLabel": "Pipe 6 1-SWS-0107",
        "elementBCategoryIndex": 1,
        "elementBModelIndex": 0,
        "center": {
            "x": 39.0157794952393,
            "y": -20.889575958252,
            "z": 5.11492538452148
        },
        "suppressingRuleIndexArray": [0],
        "status": "New"
    }],
    "categoryList": [{
        "id": 2199023255623,
        "displayName": "SWS-1-SWS-0104"
    }, {
        "id": 2199023255625,
        "displayName": "SWS-1-SWS-0107"
    }],
    "modelList": [{
        "id": 2199023255600,
        "displayName": "3D-PLANT"
    }],
    "suppressingRuleList": [{
        "id": "ZuO3OCC8sUuVcgeXz1Ih_TGCT5rBByBBqcycpQKmKtY",
        "displayName": "test1"
    }]
}

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

json

{
    "error": {
        "code": "ClashDetectionResultNotFound",
        "message": "Requested result 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

Clash

The details for a clash between two elements.

center

clash-center

status

String

The status of clash result - possible values: New, Open, Resolved, Not Available.

clashType

String

The type of clash detected - possible values: Collision, Clearance, Touching, Not Initialized.

clearance

Number

When the clash type is Clearance, the value is returned in meters. Otherwise -1 is returned.

elementAId

String

The unique id of element A.

elementBId

String

The unique id of element B.

elementALabel

String

The display label of element A.

elementBLabel

String

The display label of element B.

elementAModelIndex

Integer

The zero-based index used to lookup the element A model in the modelList.

elementBModelIndex

Integer

The zero-based index used to lookup the element B model in the modelList.

elementACategoryIndex

Integer

The zero-based index used to lookup the element A category in the categoryList.

elementBCategoryIndex

Integer

The zero-based index used to lookup the element B category in the categoryList.

suppressingRuleIndexArray

Integer[]

The array of zero-based indices used to lookup the suppressing rules.

json

{
    "type": "object",
    "properties": {
        "center": {
            "$ref": "#/components/schemas/clash-center"
        },
        "status": {
            "type": "string",
            "description": "The status of clash result - possible values: New, Open, Resolved, Not Available."
        },
        "clashType": {
            "type": "string",
            "description": "The type of clash detected - possible values: Collision, Clearance, Touching, Not Initialized."
        },
        "clearance": {
            "type": "number",
            "description": "When the clash type is Clearance, the value is returned in meters. Otherwise -1 is returned."
        },
        "elementAId": {
            "type": "string",
            "description": "The unique id of element A."
        },
        "elementBId": {
            "type": "string",
            "description": "The unique id of element B."
        },
        "elementALabel": {
            "type": "string",
            "description": "The display label of element A."
        },
        "elementBLabel": {
            "type": "string",
            "description": "The display label of element B."
        },
        "elementAModelIndex": {
            "type": "integer",
            "description": "The zero-based index used to lookup the element A model in the modelList."
        },
        "elementBModelIndex": {
            "type": "integer",
            "description": "The zero-based index used to lookup the element B model in the modelList."
        },
        "elementACategoryIndex": {
            "type": "integer",
            "description": "The zero-based index used to lookup the element A category in the categoryList."
        },
        "elementBCategoryIndex": {
            "type": "integer",
            "description": "The zero-based index used to lookup the element B category in the categoryList."
        },
        "suppressingRuleIndexArray": {
            "type": "array",
            "items": {
                "type": "integer",
                "description": "The zero-based index."
            },
            "description": "The array of zero-based indices used to lookup the suppressing rules."
        }
    },
    "description": "The details for a clash between two elements."
}

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
}

Clash Center

The clash center point.

Number

json

{
    "type": "object",
    "title": "Clash Center",
    "properties": {
        "x": {
            "type": "number"
        },
        "y": {
            "type": "number"
        },
        "z": {
            "type": "number"
        }
    },
    "description": "The clash center point."
}

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
}

Model Lookup Entry

String

Unique identifier of the model.

displayName

String

Display name of the model.

json

{
    "type": "object",
    "title": "Model Lookup Entry",
    "minimum": 1,
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of the model."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the model."
        }
    }
}

Category Lookup Entry

String

Unique identifier of the category.

displayName

String

Display name of the category.

json

{
    "type": "object",
    "title": "Category Lookup Entry",
    "minimum": 1,
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of the category."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the category."
        }
    }
}

Clash Detection Result

result

Clash[]

Array of all the clashes in this clash detection result.

modelList

model-lookup-entry[]

Model lookup table.

categoryList

category-lookup-entry[]

Category lookup table.

suppressingRuleList

suppression-rule-lookup-entry[]

Suppression rule lookup table.

json

{
    "type": "object",
    "title": "Clash Detection Result",
    "properties": {
        "result": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Clash"
            },
            "description": "Array of all the clashes in this clash detection result."
        },
        "modelList": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/model-lookup-entry"
            },
            "description": "Model lookup table."
        },
        "categoryList": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/category-lookup-entry"
            },
            "description": "Category lookup table."
        },
        "suppressingRuleList": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/suppression-rule-lookup-entry"
            },
            "description": "Suppression rule lookup table."
        }
    }
}

Suppression Rule Lookup Entry

String

Unique identifier of the suppression rule.

displayName

String

Display name of the suppression rule.

json

{
    "type": "object",
    "title": "Suppression Rule Lookup Entry",
    "minimum": 1,
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of the suppression rule."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the suppression rule."
        }
    }
}

Was this page helpful?