Get clash detection report - Clash Detection

Clash Detection

Download API definition:

Get clash detection report

get https://dev-api.bentley.com/clash-detection/itwins/{itwinId}/reports/{id}[?cuid]

Retrieves the details of the clash detection report for the specified report id.

Discover clash report ids by calling GET /clash-detection/itwins/{itwinId}/reports

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

Yes

Report id

cuid

Clash unique id for which the clash should be retrieved.

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.v2+json is recommended.

Response 200 OK

json

{
    "metadata": {
        "id": "ce75597b-3de6-454c-8592-fa17928f8aa1",
        "iTwinId": "384ebc14-d362-4a5a-8dce-0a5b3ebbe8ba",
        "repositoryId": "721e1260-6549-4216-a689-be80cc6648cf",
        "changesetId": "a8a3a9ad-862e-4ee9-8d88-c2bd220a8f57",
        "configurationId": "772c3f9d-4445-4c2d-9b4e-127827b4f8b2",
        "executed": "2023-06-17T14:45:47.6600000+00:00",
        "duration": 0,
        "numValidations": 102,
        "numElements": 31,
        "numRules": 7,
        "numIssues": 2,
        "status": 1,
        "userId": "76c4a684-fbdf-44e3-ae9b-dbdf9de1dbf2",
        "testSettings": {
            "resultsLimit": 10
        },
        "jobId": "e0e5ca59-4b5f-433d-a5ee-5a825e734782",
        "configurationName": "string",
        "changesetName": "version 1",
        "repositoryName": "Test iModel",
        "modifiedBy": "string",
        "modifiedAt": "2023-06-17T14:45:47.6600000+00:00",
        "userMetadata": {
            "createdBy": {
                "email": "Test.User@bentley.com",
                "name": "Test User"
            },
            "modifiedBy": {
                "email": "Test.User@bentley.com",
                "name": "Test User"
            }
        }
    },
    "report": {
        "calculateOverlap": true,
        "elementsWLoaderrors": 0,
        "numProcessed": 5,
        "numResults": 5,
        "processingTime": 200,
        "clashes": [{
            "cuid": "11099285-2960-46cb-999a-14f857def177",
            "elementAId": "0x20000000701",
            "elementALabel": "Pipe 6 1-SWS-0104",
            "elementBId": "0x200000011a7",
            "elementBLabel": "Pipe 6 1-SWS-0107",
            "clashType": "Collision",
            "clearance": -1,
            "elementAModelId": "0x20000000030",
            "elementBModelId": "0x20000000030",
            "elementACategoryId": "0x20000000047",
            "elementBCategoryId": "0x20000000047",
            "suppressingRules": ["9158efd6-2f18-455d-a032-91cfc636563b"],
            "isMSupp": false,
            "status": 0,
            "boundingSphere": {
                "radius": 0,
                "center": {
                    "x": 0,
                    "y": 0,
                    "z": 0
                }
            },
            "id": 0
        }],
        "categoryList": [{
            "id": "0x20000000047",
            "label": "SWS-1-SWS-0104",
            "count": 1
        }],
        "modelList": [{
            "id": "0x20000000030",
            "label": "3D-PLANT",
            "count": 1
        }],
        "suppressionRules": [{
            "id": "9158efd6-2f18-455d-a032-91cfc636563b",
            "definition": "Test suppression rule.",
            "user": "76c4a684-fbdf-44e3-ae9b-dbdf9de1dbf2",
            "reason": "Test rule reason.",
            "parameters": {},
            "name": "Test rule"
        }]
    }
}

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

json

{
    "error": {
        "code": "ResourceNotFound",
        "message": "Requested Resource is not available.",
        "details": [{
            "code": "iTwinNotFound",
            "message": "Requested iTwin is not available."
        }, {
            "code": "ClashReportIdNotFound",
            "message": "Requested Clash Report Id 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": "InvalidClashDetectionReportRequest",
        "message": "Invalid clash detection report request."
    }
}

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

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
}

Details of clashes

Details of clashes.

Number

Clash id.

cuid

String

Unique id of the clash report.

status

Number

The status of clash. Possible values - 0: New, 1: Open, 3: Resolved.

isMSupp

Boolean

Flag to check if clash is manually suppressed.

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.

boundingSphere

clash-detection-bounding-sphere

elementAModelId

String

Id of Element A Model.

elementBModelId

String

Id of Element B Model.

suppressingRules

String[]

Array of suppressing rules for the clash.

elementACategoryId

String

Id of Element A Category.

elementBCategoryId

String

Id of Element B Category.

json

{
    "type": "object",
    "title": "Details of clashes",
    "properties": {
        "id": {
            "type": "number",
            "description": "Clash id."
        },
        "cuid": {
            "type": "string",
            "description": "Unique id of the clash report."
        },
        "status": {
            "type": "number",
            "description": "The status of clash. Possible values - 0: New, 1: Open, 3: Resolved."
        },
        "isMSupp": {
            "type": "boolean",
            "description": "Flag to check if clash is manually suppressed."
        },
        "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."
        },
        "boundingSphere": {
            "$ref": "#/components/schemas/clash-detection-bounding-sphere"
        },
        "elementAModelId": {
            "type": "string",
            "description": "Id of Element A Model."
        },
        "elementBModelId": {
            "type": "string",
            "description": "Id of Element B Model."
        },
        "suppressingRules": {
            "type": "array",
            "items": {
                "type": "string",
                "description": "Suppressing rule Id."
            },
            "description": "Array of suppressing rules for the clash."
        },
        "elementACategoryId": {
            "type": "string",
            "description": "Id of Element A Category."
        },
        "elementBCategoryId": {
            "type": "string",
            "description": "Id of Element B Category."
        }
    },
    "description": "Details of clashes.",
    "additionalProperties": false
}

Clash Center

The clash center point. This contains x, y, and z properties for the exact spatial position of the center point.

Number

x-axis value for the center point.

Number

y-axis value for the center point.

Number

z-axis value for the center point.

json

{
    "type": "object",
    "title": "Clash Center",
    "properties": {
        "x": {
            "type": "number",
            "description": "x-axis value for the center point."
        },
        "y": {
            "type": "number",
            "description": "y-axis value for the center point."
        },
        "z": {
            "type": "number",
            "description": "z-axis value for the center point."
        }
    },
    "description": "The clash center point. This contains x, y, and z properties for the exact spatial position of the center point.",
    "additionalProperties": false
}

clash-result

Details of the the clash report.

clashes

clashes[]

Array of clashes.

modelList

model-lookup-entry[]

Model lookup table. Contains an array of model id, category display name and count pairs.

numResults

Number

Number of results generated.

categoryList

category-lookup-entry[]

Category lookup table. Contains an array of category id, category display name and count pairs.

numProcessed

Number

Number of elements processed.

processingTime

Number

Processing time of the run.

calculateOverlap

Boolean

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

suppressionRules

suppression-rule-lookup-entry[]

Suppression rule lookup table.

elementsWLoaderrors

Number

Number of element load errors.

json

{
    "type": "object",
    "properties": {
        "clashes": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/clashes"
            },
            "description": "Array of clashes."
        },
        "modelList": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/model-lookup-entry"
            },
            "description": "Model lookup table. Contains an array of model id, category display name and count pairs."
        },
        "numResults": {
            "type": "number",
            "description": "Number of results generated."
        },
        "categoryList": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/category-lookup-entry"
            },
            "description": "Category lookup table. Contains an array of category id, category display name and count pairs."
        },
        "numProcessed": {
            "type": "number",
            "description": "Number of elements processed."
        },
        "processingTime": {
            "type": "number",
            "description": "Processing time of the run."
        },
        "calculateOverlap": {
            "type": "boolean",
            "description": "Flag to calculate and report clash overlaps (minimum orthogonal overlap distance)."
        },
        "suppressionRules": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/suppression-rule-lookup-entry"
            },
            "description": "Suppression rule lookup table."
        },
        "elementsWLoaderrors": {
            "type": "number",
            "description": "Number of element load errors."
        }
    },
    "description": "Details of the the clash report.",
    "additionalProperties": false
}

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.

count

Number

Count of the model.

label

String

Name of the model.

json

{
    "type": "object",
    "title": "Model Lookup Entry",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of the model."
        },
        "count": {
            "type": "number",
            "description": "Count of the model."
        },
        "label": {
            "type": "string",
            "description": "Name of the model."
        }
    },
    "additionalProperties": false
}

Clash-result-metadata

Metadata of the the clash report.

String

Unique id of the clash report.

jobId

String

Unique id for the job.

status

Number

The status of the clash detection run. Started = 0, Completed = 1, Failed = 2.

userId

String

Unique id of user that started the run.

iTwinId

String

The unique id of iTwin.

duration

Number

Duration of the validation run.

executed

Date-time

Execution date time of validation run.

numRules

Number

Number of rules processed.

numIssues

Number

Number of issues generated.

modifiedAt

Date-time

Modification date time of validation run.

modifiedBy

String

Unique id of user that modified the run.

changesetId

String

The unique id of changeset.

numElements

Number

Number of elements processed.

repositoryId

String

The unique id of iModel.

testSettings

clash-detection-test-settings

userMetadata

get-test-result-usermetadata

changesetName

String

The name of the changeset.

numValidations

Number

Number of validations that occurred..

repositoryName

String

The name of the iModel.

configurationId

String

The unique id of configuration.

configurationName

String

The name of the configuration.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique id of the clash report."
        },
        "jobId": {
            "type": "string",
            "description": "Unique id for the job."
        },
        "status": {
            "type": "number",
            "description": "The status of the clash detection run. Started = 0, Completed = 1, Failed = 2."
        },
        "userId": {
            "type": "string",
            "description": "Unique id of user that started the run."
        },
        "iTwinId": {
            "type": "string",
            "description": "The unique id of iTwin."
        },
        "duration": {
            "type": "number",
            "description": "Duration of the validation run."
        },
        "executed": {
            "type": "string",
            "format": "date-time",
            "description": "Execution date time of validation run."
        },
        "numRules": {
            "type": "number",
            "description": "Number of rules processed."
        },
        "numIssues": {
            "type": "number",
            "description": "Number of issues generated."
        },
        "modifiedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Modification date time of validation run."
        },
        "modifiedBy": {
            "type": "string",
            "description": "Unique id of user that modified the run."
        },
        "changesetId": {
            "type": "string",
            "description": "The unique id of changeset."
        },
        "numElements": {
            "type": "number",
            "description": "Number of elements processed."
        },
        "repositoryId": {
            "type": "string",
            "description": "The unique id of iModel."
        },
        "testSettings": {
            "$ref": "#/components/schemas/clash-detection-test-settings"
        },
        "userMetadata": {
            "$ref": "#/components/schemas/get-test-result-usermetadata"
        },
        "changesetName": {
            "type": "string",
            "description": "The name of the changeset."
        },
        "numValidations": {
            "type": "number",
            "description": "Number of validations that occurred.."
        },
        "repositoryName": {
            "type": "string",
            "description": "The name of the iModel."
        },
        "configurationId": {
            "type": "string",
            "description": "The unique id of configuration."
        },
        "configurationName": {
            "type": "string",
            "description": "The name of the configuration."
        }
    },
    "description": "Metadata of the the clash report.",
    "additionalProperties": false
}

Category Lookup Entry

String

Unique identifier of the category.

count

Number

Count of the category.

label

String

Name of the category.

json

{
    "type": "object",
    "title": "Category Lookup Entry",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of the category."
        },
        "count": {
            "type": "number",
            "description": "Count of the category."
        },
        "label": {
            "type": "string",
            "description": "Name of the category."
        }
    },
    "additionalProperties": false
}

Clash Detection Result

report

clash-result

metadata

Clash-result-metadata

json

{
    "type": "object",
    "title": "Clash Detection Result",
    "properties": {
        "report": {
            "$ref": "#/components/schemas/clash-result"
        },
        "metadata": {
            "$ref": "#/components/schemas/Clash-result-metadata"
        }
    },
    "additionalProperties": false
}

User Details

User Details.

createdBy

result-usermetadata-createdby

modifiedBy

result-usermetadata-modifiedby

json

{
    "type": "object",
    "title": "User Details",
    "properties": {
        "createdBy": {
            "$ref": "#/components/schemas/result-usermetadata-createdby"
        },
        "modifiedBy": {
            "$ref": "#/components/schemas/result-usermetadata-modifiedby"
        }
    },
    "description": "User Details.",
    "additionalProperties": false
}

Clash Detection Test Settings

resultsLimit

One of: number string

The maximum clash/failure limit for the clash detection test. Default is 100000.

json

{
    "type": "object",
    "title": "Clash Detection Test Settings",
    "properties": {
        "resultsLimit": {
            "oneOf": [
                {
                    "type": "number"
                },
                {
                    "type": "string"
                }
            ],
            "description": "The maximum clash/failure limit for the clash detection test. Default is 100000."
        }
    },
    "additionalProperties": false
}

Created By User Details

Created By User Details.

name

String

Name of user that created the run.

String

Email id of user that created the run.

json

{
    "type": "object",
    "title": "Created By User Details",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of user that created the run."
        },
        "email": {
            "type": "string",
            "description": "Email id of user that created the run."
        }
    },
    "description": "Created By User Details.",
    "additionalProperties": false
}

Suppression Rule Lookup Entry

String

Unique identifier of the suppression rule.

name

String

Name of the suppression rule.

user

String

Unique id of user that created the suppression rule.

reason

String

Reason for the suppression rule.

definition

String

Description of the suppression rule.

parameters

One of: object string, null

Parameters will vary based on the chosen template. Some templates, like 'suppress clashes if clashing elements are in the same category, do not require any parameters.

json

{
    "type": "object",
    "title": "Suppression Rule Lookup Entry",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of the suppression rule."
        },
        "name": {
            "type": "string",
            "description": "Name of the suppression rule."
        },
        "user": {
            "type": "string",
            "description": "Unique id of user that created the suppression rule."
        },
        "reason": {
            "type": "string",
            "description": "Reason for the suppression rule."
        },
        "definition": {
            "type": "string",
            "description": "Description of the suppression rule."
        },
        "parameters": {
            "oneOf": [
                {
                    "type": "object"
                },
                {
                    "type": "string"
                }
            ],
            "nullable": true,
            "description": "Parameters will vary based on the chosen template. Some templates, like 'suppress clashes if clashing elements are in the same category, do not require any parameters."
        }
    },
    "additionalProperties": false
}

Modified By User Details

Modified By User Details.

name

String

Name of user that modified the run.

String

Email of user that modified the run.

json

{
    "type": "object",
    "title": "Modified By User Details",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of user that modified the run."
        },
        "email": {
            "type": "string",
            "description": "Email of user that modified the run."
        }
    },
    "description": "Modified By User Details.",
    "additionalProperties": false
}

Bounding Sphere

Bounding sphere of the source element.

center

clash-center

radius

Number

The clash radius.

json

{
    "type": "object",
    "title": "Bounding Sphere",
    "properties": {
        "center": {
            "$ref": "#/components/schemas/clash-center"
        },
        "radius": {
            "type": "number",
            "description": "The clash radius."
        }
    },
    "description": "Bounding sphere of the source element.",
    "additionalProperties": false
}

Was this page helpful?