Get clash detection run - Clash Detection

Clash Detection

Get clash detection run

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

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

Retrieves details of a clash detection run for the run specified by the run id.

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

Run 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

{
    "run": {
        "id": "1cKcvg7Ky0e66uT-2u8vpSTBs9cXiSlMrE8Zym2jD0Y",
        "displayName": "ClashDetectionTest1 2021-06-17 14:45:47Z",
        "executedDateTime": "2021-06-17T14:45:47.0730000+00:00",
        "count": "0",
        "userName": "John Johnson",
        "status": "queued",
        "resultId": "1cKcvg7Ky0e66uT-2u8vpU1fL3jpQOxEs7jYnNkoTYgkwbPXF4kpTKxPGcptow9G",
        "_links": {
            "result": {
                "href": "https://api.bentley.com/clashdetection/results/1cKcvg7Ky0e66uT-2u8vpU1fL3jpQOxEs7jYnNkoTYgkwbPXF4kpTKxPGcptow9G"
            },
            "test": {
                "href": "https://api.bentley.com/clashdetection/tests/1cKcvg7Ky0e66uT-2u8vpZ5ifQZec1dEhNDUO8ZloRk"
            }
        }
    }
}

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

json

{
    "error": {
        "code": "ClashDetectionRunNotFound",
        "message": "Requested run 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 Run status

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

queued

String

started

String

completed

String

failed

String

downloadingIModel

String

storingResults

String

inProgress

String

completedToLimit

String

cancelled

String

invalidSuppressionRules

String

completedWithElementLoadErrors

String

json

{
    "enum": [
        "queued",
        "started",
        "completed",
        "failed",
        "downloadingIModel",
        "storingResults",
        "inProgress",
        "completedToLimit",
        "cancelled",
        "invalidSuppressionRules",
        "completedWithElementLoadErrors"
    ],
    "type": "string",
    "description": "The status of the clash detection run. One of 'queued', 'started', 'completed', 'failed', 'downloadingIModel', 'storingResults', 'inProgress', 'completedToLimit', 'cancelled', 'invalidSuppressionRules', 'completedWithElementLoadErrors'",
    "title": "Clash Detection Run status"
}

Clash Detection Run

Run metadata.

String

Run id.

count

String

The number of clashes found.

_links

clash-detection-run-links

Clash Detection Run status

clash-detection-run-status

resultId

String

Result id.

userName

String

The name of the user that started the run.

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.

json

{
    "type": "object",
    "title": "Clash Detection Run",
    "properties": {
        "id": {
            "type": "string",
            "description": "Run id."
        },
        "count": {
            "type": "string",
            "description": "The number of clashes found."
        },
        "_links": {
            "$ref": "#/components/schemas/clash-detection-run-links"
        },
        "status": {
            "enum": [
                "queued",
                "started",
                "completed",
                "failed",
                "downloadingIModel",
                "storingResults",
                "inProgress",
                "completedToLimit",
                "cancelled",
                "invalidSuppressionRules",
                "completedWithElementLoadErrors"
            ],
            "type": "string",
            "description": "The status of the clash detection run. One of 'queued', 'started', 'completed', 'failed', 'downloadingIModel', 'storingResults', 'inProgress', 'completedToLimit', 'cancelled', 'invalidSuppressionRules', 'completedWithElementLoadErrors'",
            "title": "Clash Detection Run status",
            "$ref": "#/components/schemas/clash-detection-run-status"
        },
        "resultId": {
            "type": "string",
            "description": "Result id."
        },
        "userName": {
            "type": "string",
            "description": "The name of the user that started the run."
        },
        "displayName": {
            "type": "string",
            "description": "The display name of the run is the test name and execution date/time."
        },
        "executedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the test was executed."
        }
    },
    "description": "Run metadata."
}

Clash Detection Run Links

test

Link

result

Link

json

{
    "type": "object",
    "title": "Clash Detection Run Links",
    "properties": {
        "test": {
            "$ref": "#/components/schemas/Link"
        },
        "result": {
            "$ref": "#/components/schemas/Link"
        }
    }
}

Was this page helpful?