Table of contents
Clash Detection
Download API definition:
This operation is deprecated. Please upgrade to the current version of this API as soon as possible.
GET https://api.bentley.com/clashdetection/runs?projectId

Retrieves a list of Clash Detection runs for the project specified by the project id.

Notes

The Prefer header can be used to specify how much clash detection run metadata is desired

  • "return=minimal" (default) - returns the minimum clash detection run metadata

  • "return=representation" - returns the full clash detection run metadata

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

Name
Required?
Description
projectId
Yes

The project id of the project from which to retrieve the clash detection runs.

Request headers

Name
Required?
Description
Prefer
No

Optional. Select preferred representation.

Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

OK

json
{
    "runs": [{
        "id": "1cKcvg7Ky0e66uT-2u8vpSTBs9cXiSlMrE8Zym2jD0Y",
        "displayName": "ClashDetectionTest1 2021-06-17 14:45:47Z",
        "_links": {
            "result": {
                "href": "https://api.bentley.com/clashdetection/results/1cKcvg7Ky0e66uT-2u8vpU1fL3jpQOxEs7jYnNkoTYgkwbPXF4kpTKxPGcptow9G"
            },
            "test": {
                "href": "https://api.bentley.com/clashdetection/tests/1cKcvg7Ky0e66uT-2u8vpZ5ifQZec1dEhNDUO8ZloRk"
            }
        }
    }]
}

Response 401 Unauthorized

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

json
{
    "error": {
        "code": "ProjectNotFound",
        "message": "Requested project is not available."
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json
{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

Name
Description
retry-after

The number of requests exceeds the rate-limit for the client subscription.

Clash Detection Run status

The status of the clash detection run. One of 'queued', 'started', 'completed', 'failed', 'downloadingIModel', 'storingResults', 'inProgress', 'completedToLimit', 'cancelled', 'invalidSuppressionRules', 'completedWithElementLoadErrors'

Name
Type
Description
queued
String
started
String
completed
String
failed
String
downloadingIModel
String
storingResults
String
inProgress
String
completedToLimit
String
cancelled
String
invalidSuppressionRules
String
completedWithElementLoadErrors
String

Clash Detection Run

Run metadata.

Name
Type
Description
id
String

Run id.

displayName
String

The display name of the run is the test name and execution date/time.

executedDateTime
Date-time

The date/time when the test was executed.

count
String

The number of clashes found.

userName
String

The name of the user that started the run.

Clash Detection Run status

The status of the clash detection run. One of 'queued', 'started', 'completed', 'failed', 'downloadingIModel', 'storingResults', 'inProgress', 'completedToLimit', 'cancelled', 'invalidSuppressionRules', 'completedWithElementLoadErrors'

resultId
String

Result id.

_links

The links to get the result and test details.

Clash Detection Run Links

Name
Type
Description
result

The link to get the result details.

test

The link to get the test details.

Clash Detection Run

Clash detection run summary (id and display name)

Name
Type
Description
id
String

The clash detection run id.

displayName
String

The display name of the clash detection run.

Clash Detection Runs

Array of clash detection runs metadata (summary)

Name
Type
Description

Clash Detection Runs

Array of clash detection runs metadata

Name
Type
Description

Link

Hyperlink container.

Name
Type
Description
href
String

Hyperlink container.

Error

Contains error information.

Name
Type
Description
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.

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.

Name
Type
Description
error

Error information.