Clash Test: Assigned Clash Groups
POST
containers/:containerId/clashes/assigned/viewcontext
Retrieves the view context around a set of assigned clash groups, such as the model set, and documents with which they are associated.
You can use the BIM360 Issues API to obtain individual issues. See GET issues/:issueId for more information.
The response contains context for the set of assigned clash groups.
Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects.
Resource Information
Method and URI | POST https://developer.api.autodesk.com/bim360/clash/v3/containers/:containerId/clashes/assigned/viewcontext |
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. |
Content-Type* string | Must be application/json |
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. |
Request
Body Structure
array: string: UUID* array: string: UUID | A set of issue IDs. Min items: 1 Max items: 5. |
* Required
Response
HTTP Status Code Summary
200 OK | The set of assigned clash group view context objects. |
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. |
415 Unsupported Media Type | The Content-Type header must be application/json . |
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
issueId string: UUID | The ID of the assigned clash group issue for retrieving the issue. |
modelSetId string: UUID | The ID of the model set this assigned clash group issue is associated with. |
clashGroup object | A Clash Group. |
id string: UUID | The unique identifier of the assigned clash group. |
clashTestId string: UUID | The unique identifier of the clash test associated with the assigned clash group. |
issueId string | The unique identifier of the issue associated with the assigned clash group. |
createdBy string | The unique identifier of the user who created the assigned clash group. |
createdOn datetime: ISO 8601 | The date and time that the assigned clash group was created. |
clashes array: int | The clashes included in the assigned clash group. Min items: 1 Max items: 1000. |
documents array: object | The list of documents visible when the issue was created. |
lineageUrn string | The lineage URN of the seed file or document lineage to track with this view. Min length: 1 Max length: 80. |
viewableName string | The name of the viewable in the Model Derivative manifest to track along the seed file lineage. This value is ignored if lineageUrn is the URN of a BIM360 Docs Plans folder document. Min length: 1 Max length: 430. |
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
Request
curl -v 'https://developer.api.autodesk.com/bim360/clash/v3/containers/f0f4f36a-ac64-687f-b132-8efe04b22454/clashes/assigned/viewcontext' \
-X POST \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '[
"d98c1dd4-008f-04b2-e980-0998ecf8427e"
]'
Response (200)
[
{
"issueId": "53e6a6c7-5bc9-7b2d-920b-b73efecd8fc1",
"modelSetId": "00fb28a5-e8a4-2755-562a-7c2f0fc87911",
"clashGroup": {
"id": "74b70bb8-8802-a1fd-f201-890375a60c8f",
"clashTestId": "21469f89-986a-c194-ae45-cefade1c7bde",
"issueId": "db74db66-1115-4270-beea-6c5bb1e60194",
"createdBy": "PD23PXGV8V3V",
"createdOn": "2015-10-21T16:32:22Z",
"clashes": [
2019963136
]
},
"documents": [
{
"lineageUrn": "urn:adsk.wipprod:dm.lineage:jvMF7mrHR7OwG_DToKsJUA",
"viewableName": "Level 1"
}
]
}
]
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