Get clash detection reports - Clash Detection

Clash Detection

Download API definition:

Get clash detection reports

GET https://api.bentley.com/clash-detection/itwins/{itwinId}/reports[?$top][&$continuationToken]

Retrieves the clash detection reports for the specified iTwin 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 parameters

itwinId

Yes

The iTwin Id

$top

Limit of entries on one page. Default value is 10, maximum allowed is 100.

$continuationToken

Token for next set of data.

Request headers

repository-id

Repository id (iModel id) of the clash report that needs to be retrieved.

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

{
    "count": 2,
    "reports": [{
        "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.66Z",
        "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-09-17T14:45:47.66Z",
        "userMetadata": {
            "createdBy": {
                "email": "Test.User@bentley.com",
                "name": "Test User"
            },
            "modifiedBy": {
                "email": "Test.User@bentley.com",
                "name": "Test User"
            }
        },
        "vStatuses": {
            "new": 0,
            "open": 0,
            "resolved": 0,
            "ms": 0,
            "rs": 0,
            "multiSup": 0
        },
        "id": "e4298853-b4d0-4cc6-9b5c-1003bcbf31a9"
    }],
    "_links": {
        "self": {
            "href": "https://dev-api.bentley.com/apis/clash-detection-v2/operations/itwins/1b7d4045-a99e-441e-9318-93df23b49a57/reports"
        },
        "next": {
            "href": "https://dev-api.bentley.com/apis/clash-detection-v2/operations/itwins/1b7d4045-a99e-441e-9318-93df23b49a57/reports?$top=1&$continuationToken=Mg=="
        },
        "prev": null
    }
}

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": "InvalidClashDetectionReportsRequest",
        "message": "Invalid clash detection reports 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

Reference for response pages

self

href-link, null

Link for the current page.

href-link, null

Link to the next page.

href-link, null

Link to the previous page.

json

{
    "title": "Reference for response pages",
    "type": "object",
    "properties": {
        "self": {
            "type": "object",
            "nullable": true,
            "description": "Link for the current page.",
            "$ref": "#/components/schemas/href-link"
        },
        "next": {
            "type": "object",
            "nullable": true,
            "description": "Link to the next page.",
            "$ref": "#/components/schemas/href-link"
        },
        "prev": {
            "type": "object",
            "nullable": true,
            "description": "Link to the previous page.",
            "$ref": "#/components/schemas/href-link"
        }
    },
    "additionalProperties": false
}

Link

href

String, null

The link to the page.

json

{
    "title": "Link",
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "nullable": true,
            "description": "The link to the page."
        }
    },
    "additionalProperties": false
}

Clash Detection Results

reports

Clash-results-rows[]

Array of clash reports.

count

Number

Results count for the given iTwin.

_links

get-page-ref

Links for the paginated response.

json

{
    "title": "Clash Detection Results",
    "type": "object",
    "properties": {
        "reports": {
            "description": "Array of clash reports.",
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Clash-results-rows"
            }
        },
        "count": {
            "type": "number",
            "description": "Results count for the given iTwin."
        },
        "_links": {
            "type": "object",
            "description": "Links for the paginated response.",
            "$ref": "#/components/schemas/get-page-ref"
        }
    },
    "additionalProperties": false
}

Clash-results-rows

Clash report details.

String

Unique id of the clash report.

iTwinId

String

The unique id of iTwin.

repositoryId

String

The unique id of iModel.

changesetId

String

The unique id of changeset.

configurationId

String

The unique id of configuration.

executed

Date-time

Execution date time of validation run.

duration

Number

Duration of the validation run.

numValidations

Number

Number of validations that occurred..

numElements

Number

Number of elements processed.

numRules

Number

Number of rules processed.

numIssues

Number

Number of issues generated.

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.

testSettings

clash-detection-test-settings

Settings to run the clash detection test.

jobId

String

Unique id for the job.

configurationName

String

The name of the configuration.

changesetName

String

The name of the changeset.

repositoryName

String

The name of the iModel.

modifiedBy

String

Unique id of user that modified the run.

modifiedAt

Date-time

Modification date time of validation run.

userMetadata

get-test-result-usermetadata

User Metadata - available if Include-User-Metadata flag is set to true.

vStatuses

get-results-vStatuses

Validation Statuses.

json

{
    "type": "object",
    "description": "Clash report details.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique id of the clash report."
        },
        "iTwinId": {
            "type": "string",
            "description": "The unique id of iTwin."
        },
        "repositoryId": {
            "type": "string",
            "description": "The unique id of iModel."
        },
        "changesetId": {
            "type": "string",
            "description": "The unique id of changeset."
        },
        "configurationId": {
            "type": "string",
            "description": "The unique id of configuration."
        },
        "executed": {
            "type": "string",
            "format": "date-time",
            "description": "Execution date time of validation run."
        },
        "duration": {
            "type": "number",
            "description": "Duration of the validation run."
        },
        "numValidations": {
            "type": "number",
            "description": "Number of validations that occurred.."
        },
        "numElements": {
            "type": "number",
            "description": "Number of elements processed."
        },
        "numRules": {
            "type": "number",
            "description": "Number of rules processed."
        },
        "numIssues": {
            "type": "number",
            "description": "Number of issues generated."
        },
        "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."
        },
        "testSettings": {
            "$ref": "#/components/schemas/clash-detection-test-settings",
            "description": "Settings to run the clash detection test."
        },
        "jobId": {
            "type": "string",
            "description": "Unique id for the job."
        },
        "configurationName": {
            "type": "string",
            "description": "The name of the configuration."
        },
        "changesetName": {
            "type": "string",
            "description": "The name of the changeset."
        },
        "repositoryName": {
            "type": "string",
            "description": "The name of the iModel."
        },
        "modifiedBy": {
            "type": "string",
            "description": "Unique id of user that modified the run."
        },
        "modifiedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Modification date time of validation run."
        },
        "userMetadata": {
            "$ref": "#/components/schemas/get-test-result-usermetadata",
            "description": "User Metadata - available if Include-User-Metadata flag is set to true."
        },
        "vStatuses": {
            "$ref": "#/components/schemas/get-results-vStatuses",
            "description": "Validation Statuses."
        }
    },
    "additionalProperties": false
}

Validation Statuses

new

Number

A clash that shows up for the first time.

open

Number

A clash that existed previously and shows up again.

resolved

Number

A clash that is not seen anymore (due to a design change or a clash test change).

Number

A clash that is exclusively rule suppressed. (A clash that is rule suppressed and is not Resolved)

Number

A clash that is exclusively suppressed manually. (A clash that is manually suppressed, not rules suppressed and is not Resolved)

multiSup

Number

A clash that is suppressed both by a rule and manually suppressed. (A clash that is both manually suppressed and rule suppressed and is not Resolved)

json

{
    "title": "Validation Statuses",
    "type": "object",
    "description": "Validation Statuses",
    "properties": {
        "new": {
            "type": "number",
            "description": "A clash that shows up for the first time."
        },
        "open": {
            "type": "number",
            "description": "A clash that existed previously and shows up again."
        },
        "resolved": {
            "type": "number",
            "description": "A clash that is not seen anymore (due to a design change or a clash test change)."
        },
        "rs": {
            "type": "number",
            "description": "A clash that is exclusively rule suppressed. (A clash that is rule suppressed and is not Resolved)"
        },
        "ms": {
            "type": "number",
            "description": "A clash that is exclusively suppressed manually. (A clash that is manually suppressed, not rules suppressed and is not Resolved)"
        },
        "multiSup": {
            "type": "number",
            "description": "A clash that is suppressed both by a rule and manually suppressed. (A clash that is both manually suppressed and rule suppressed and is not Resolved)"
        }
    },
    "additionalProperties": false
}

User Details

User Details.

createdBy

result-usermetadata-createdby

User details.

modifiedBy

result-usermetadata-modifiedby

User details.

json

{
    "title": "User Details",
    "type": "object",
    "description": "User Details.",
    "properties": {
        "createdBy": {
            "$ref": "#/components/schemas/result-usermetadata-createdby",
            "description": "User details."
        },
        "modifiedBy": {
            "$ref": "#/components/schemas/result-usermetadata-modifiedby",
            "description": "User details."
        }
    },
    "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

{
    "title": "Created By User Details",
    "type": "object",
    "description": "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."
        }
    },
    "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

{
    "title": "Modified By User Details",
    "type": "object",
    "description": "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."
        }
    },
    "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

{
    "title": "Clash Detection Test Settings",
    "type": "object",
    "properties": {
        "resultsLimit": {
            "oneOf": [
                {
                    "type": "number"
                },
                {
                    "type": "string"
                }
            ],
            "description": "The maximum clash/failure limit for the clash detection test. Default is 100000."
        }
    },
    "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

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",
    "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?