Clash Test
GET
containers/:containerId/modelsets/:modelSetId/versions/:version/tests
Retrieves a list of summaries for all clash tests that have been executed for a given model set version. If no tests have yet been completed for the specified model set version, no tests are returned.
The response contains a list of matching clash test summaries, restricted by the number specified by the pageLimit
property. If set (that is, if there are more results than can be displayed at once), you can provide the continuationToken
property in the response in a separate call to retrieve additional results.
Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/bim360/clash/v3/containers/:containerId/modelsets/:modelSetId/versions/:version/tests |
Authentication Context | user context required |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
x-ads-region enum: string | The region to which your request should be routed. If not set, the request is routed automatically but may incur a small latency increase.
Possible values: |
* Required
Request
URI Parameters
containerId string: UUID | The GUID that uniquely identifies the container. |
modelSetId string: UUID | The GUID that uniquely identifies the model set. |
version int | The model set version number. |
Request
Query Parameters
status enum: string | Filters the list of returned clash tests by this status. Possible values: Pending , Processing , Success , Failed . |
pageLimit int | The maximum number of clash tests to return in a page. If not set, the default page limit is used, as determined by the server. |
continuationToken string | The token indicating the start of the page. If not set, the first page is retrieved. |
Response
HTTP Status Code Summary
200 OK | Success |
400 Bad Request | The parameters of the requested operation are invalid. |
401 Unauthorized | The provided bearer token is not valid. |
403 Forbidden | The user or service represented by the bearer token does not have permission to perform this operation. |
404 Not Found | The requested resource could not be found. |
429 Too Many Requests | Rate limit exceeded; wait some time before retrying. The Retry-After header might provide the amount of the time to wait. |
500 Internal Server Error | An unknown error occurred on the server. |
Response
Body Structure (200)
Expand all
page object | Paging information associated with a paging response. |
continuationToken string | A continuation token to retrieve the next page. |
tests array: object | A list of clash tests. |
id string: UUID | The GUID that uniquely identifies the clash test. |
completedOn datetime: ISO 8601 | The date and time that the clash test was completed. |
modelSetId string: UUID | The GUID that uniquely identifies the model set associated with the clash test. |
modelSetVersion int | The version number of the model set associated with the clash test. |
status enum: string | The status of the clash test. If the status is Success , the results of the clash test are available for use. Possible values: Pending , Processing , Success , Failed . |
Response
Body Structure (400)
Expand all
type string | The error code. |
title string | A short title for the error. |
detail string | A more detailed, human readable description of the error, assuming that this message is not localized and is therefore EN-US. UI consumers can use the error.type value to provide a localized version of this error for presentation. |
errors array: object | A set of specific validation errors that need to be fixed. |
field string | The field which failed validation. |
title string | A short title for the error. |
detail string | A more detailed, human readable description of the error, assuming that this message is not localized and is therefore EN-US. UI consumers can use the error.type value to provide a localized version of this error for presentation. |
type string | The error code. |
Example #1 (no query parameters)
Request
curl -v 'https://developer.api.autodesk.com/bim360/clash/v3/containers/f0f4f36a-ac64-687f-b132-8efe04b22454/modelsets/00fb28a5-e8a4-2755-562a-7c2f0fc87911/versions/42/tests' \
-H 'Authorization: Bearer <token>'
Example #2 (with all query parameters)
Request
curl -v 'https://developer.api.autodesk.com/bim360/clash/v3/containers/f0f4f36a-ac64-687f-b132-8efe04b22454/modelsets/00fb28a5-e8a4-2755-562a-7c2f0fc87911/versions/42/tests?status=Success&pageLimit=134&continuationToken=10' \
-H 'Authorization: Bearer <token>'
Response (200)
{
"page": {},
"tests": [
{
"id": "74b70bb8-8802-a1fd-f201-890375a60c8f",
"modelSetId": "00fb28a5-e8a4-2755-562a-7c2f0fc87911",
"modelSetVersion": 94,
"status": "Success"
}
]
}
Show More
Response (400)
{
"type": "BadInput",
"title": "One or more input values in the request were bad",
"detail": "The following parameters are invalid: containerId",
"errors": [
{
"field": "containerId",
"title": "Invalid parameter",
"detail": "The value 'testing' is not valid.",
"type": "BadInput"
}
]
}
Show More