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/tests?projectId[&continuationToken][&$top]

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

Notes

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
In
Required?
Description
projectId
query
Yes

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

continuationToken
query
No

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
query
No

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

Request headers

Name
Required?
Description
Include-User-Metadata
No

Optional. Include user metadata when true.

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
{
    "tests": [{
        "id": "1cKcvg7Ky0e66uT-2u8vpZ5ifQZec1dEhNDUO8ZloRk",
        "displayName": "ClashDetectionTest1",
        "description": "Clash Detection Test",
        "creationDateTime": "2021-06-17T14:45:47.66Z",
        "modificationDateTime": "2021-06-24T14:49:59.66Z",
        "_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"
        }
    }
}

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 Test Links

TableSchema
Name
Type
Description
createdBy

The link to get user details for the user that created the test.

lastModifiedBy

The link to get user details for the user that last modified the test.

test

The link to get the test details.

Clash Detection Test

Clash detection test

TableSchema
Name
Type
Description
id
String

The clash detection test id.

displayName
String

The display name of the clash detection test.

description
String

The description of the test.

creationDateTime
Date-time

The date/time when the test was created.

modificationDateTime
Date-time

The date/time when the test was last modified.

_links

The link to get the related links.

Clash Detection Tests

Array of clash detection tests metadata

TableSchema
Name
Type
Description
_links

The link to get the next set of suppression rules.

Link

Hyperlink container.

TableSchema
Name
Type
Description
href
String

Hyperlink container.

Forward-Only Paging Link

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

TableSchema
Name
Type
Description
next

Error

Contains error information.

TableSchema
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.

TableSchema
Name
Type
Description
error

Error information.