Get clash detection tests - Clash Detection

Clash Detection

Get clash detection tests

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

get https://dev-api.bentley.com/clashdetection/tests?projectId[&continuationToken][&$top]

Retrieves a list of Clash Detection tests for the project specified by the project 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

projectId

Yes

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

continuationToken

Parameter that enables continuing to the next page of the previous paged query. This must be passed exactly as it is in the response body's _links.next property. If this is specified and $top is omitted, the next page will be the same size as the previous page.

$top

The number of tests to get in each page. Max 50, but 10 is the default if this parameter is not included.

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

Response 200 OK

json

{
    "tests": [{
        "id": "1cKcvg7Ky0e66uT-2u8vpZ5ifQZec1dEhNDUO8ZloRk",
        "displayName": "ClashDetectionTest1",
        "description": "Clash Detection Test",
        "creationDateTime": "2021-06-17T14:45:47.6600000+00:00",
        "modificationDateTime": "2021-06-24T14:49:59.6600000+00:00",
        "_links": {
            "createdBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/99cf5e21-735c-4598-99eb-fe3940f96353"
            },
            "lastModifiedBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/99cf5e21-735c-4598-99eb-fe3940f96353"
            },
            "test": {
                "href": "https://api.bentley.com/clashdetection/tests/1cKcvg7Ky0e66uT-2u8vpZ5ifQZec1dEhNDUO8ZloRk"
            }
        },
        "userMetadata": {
            "createdBy": {
                "email": "John.Johnson@org.com",
                "name": "John Johnson"
            },
            "modifiedBy": {
                "email": "John.Johnson@org.com",
                "name": "John Johnson"
            }
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/clashdetection/tests?projectId=38b7e366-bc20-4bb1-9572-0797cf5221fd&continuationToken=eyJ0b3AiOjUsInNraXBUb2tlbiI6Ik1nPT0ifQ"
        }
    }
}

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

json

{
    "error": {
        "code": "ProjectNotFound",
        "message": "Requested project 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 Tests

Array of clash detection tests metadata

tests

clash-detection-test-summary[]

_links

forward-only-paging-links

json

{
    "type": "object",
    "title": "Clash Detection Tests",
    "properties": {
        "tests": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/clash-detection-test-summary"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/forward-only-paging-links"
        }
    },
    "description": "Array of clash detection tests metadata"
}

Forward-Only Paging Link

Link to get the next page of data, if applicable. Link to the previous page is not available.

Link

json

{
    "type": "object",
    "title": "Forward-Only Paging Link",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "description": "Link to get the next page of data, if applicable. Link to the previous page is not available."
}

Clash Detection Test

Clash detection test

String

The clash detection test id.

_links

clash-detection-test-summary-links

description

String

The description of the test.

displayName

String

The display name of the clash detection test.

creationDateTime

Date-time

The date/time when the test was created.

modificationDateTime

Date-time

The date/time when the test was last modified.

json

{
    "type": "object",
    "title": "Clash Detection Test",
    "properties": {
        "id": {
            "type": "string",
            "description": "The clash detection test id."
        },
        "_links": {
            "$ref": "#/components/schemas/clash-detection-test-summary-links"
        },
        "description": {
            "type": "string",
            "description": "The description of the test."
        },
        "displayName": {
            "type": "string",
            "description": "The display name of the clash detection test."
        },
        "creationDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the test was created."
        },
        "modificationDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the test was last modified."
        }
    },
    "description": "Clash detection test"
}

Clash Detection Test Links

test

Link

createdBy

Link

lastModifiedBy

Link

json

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

Was this page helpful?

Notes

Authentication

Request

Request parameters

Request headers

Response

Response 200 OK

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Response headers

Definitions

Link

Error

Error Response

Clash Detection Tests

Forward-Only Paging Link

Clash Detection Test

Clash Detection Test Links