Issue Root Cause Categories
GET
containers/{containerId}/issue-root-cause-categories
Retrieves a list of supported root cause categories and root causes that you can allocate to an issue. For example, Coordination, Design, Quality and Safety.
Note that by default, this endpoint only returns root cause categories. To include root causes you need to add the include query string parameter (include=rootcauses).
Note that this endpoint is ONLY compatible with BIM 360 projects. It is not compatible with Autodesk Construction Cloud (ACC) projects. For more information about compatibility between between BIM 360 and ACC, see the Compatibility section.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/issues/v2/containers/:containerId/issue-root-cause-categories |
| 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. |
* Required
Request
URI Parameters
| containerId string | The ID of the container.
Each project is assigned to a container that stores all the issues for the project. Use the Data Management API to retrieve the container ID. For more information, see the Retrieve Issues Container ID tutorial. |
Request
Query String Parameters
| include string | Add include=rootcauses to add the root causes for each category. |
| limit int | Add limit=20 to limit the results count (together with the offset to support pagination). |
| offset int | Add offset=20 to get partial results (together with the limit to support pagination). |
| filter[updatedAt] string | Retrieves root cause categories that were last updated at the specified date and time range, in in one of the following URL-encoded formats: YYYY-MM-DDThh:mm:ss.sz or YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options:
For more details, see JSON API Filtering. |
Response
HTTP Status Code Summary
| 200 OK | List of issue root cause categories |
| 400 Bad Request | Invalid input |
| 401 Unauthorized | The supplied Authorization header was not valid. Verify Authentication and try again |
| 403 Forbidden | The request was successfully validated but permission is not granted |
| 404 Not Found | Container not found |
Response
Body Structure (200)
Expand all
| pagination object | The pagination object. |
| limit int | The number of items per page. |
| offset int | The page number that the results begin from. |
| totalResults int | The number of items in the response. |
| results array: object | A list of issue root cause categories. |
| id string: UUID | The ID of the issue root cause category. |
| title string | The title of the issue root cause category.
Max length: 100 |
| isActive boolean | States whether the root cause category is active. |
| permittedActions array: string | Not relevant |
| permittedAttributes array: string | Not relevant |
| rootCauses array: object | A list of root causes of the specific root cause category. |
| id string: UUID | The ID of the issue root cause. |
| rootCauseCategoryId string: UUID | The ID of the parent issue root cause category. |
| title string | The title of the issue root cause.
Max length: 100 |
| isActive boolean | States whether the root cause is active. |
| permittedActions array: string | Not relevant |
| permittedAttributes array: string | Not relevant |
| createdAt datetime: ISO 8601 | The date and time the issue root cause was created, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| createdBy string | The Autodesk ID of the user who created the issue root cause. |
| updatedAt datetime: ISO 8601 | The last date and time the issue root cause was updated, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| updatedBy string | The Autodesk ID of the user who last updated the issue root cause. |
| deletedAt datetime: ISO 8601 | The date and time the issue root cause was deleted, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| deletedBy string | The Autodesk ID of the user who deleted the issue root cause. |
| createdAt datetime: ISO 8601 | The date and time the issue root cause category was created, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| createdBy string | The Autodesk ID of the user who created the issue root cause category. |
| updatedAt datetime: ISO 8601 | The last date and time the issue root cause category was updated, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| updatedBy string | The Autodesk ID of the user who last updated the issue root cause category. |
| deletedAt datetime: ISO 8601 | The date and time the issue root cause category was deleted, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| deletedBy string | The Autodesk ID of the user who deleted the issue root cause category. |
Example
List of issue root cause categories
Request
curl -v 'https://developer.api.autodesk.com/issues/v2/containers/a5f49f04-59bb-477c-97e6-6833cb50bdac/issue-root-cause-categories?include=rootcauses&limit=20&offset=20' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 10,
"offset": 100,
"totalResults": 25
},
"results": [
{
"id": "1110f111-6c54-4b01-90e6-d701748f1111",
"title": "Coordination",
"isActive": false,
"permittedActions": [
"edit"
],
"permittedAttributes": [
"title"
],
"rootCauses": [
{
"id": "2220f222-6c54-4b01-90e6-d701748f0222",
"rootCauseCategoryId": "1110f111-6c54-4b01-90e6-d701748f1111",
"title": "Constructability",
"isActive": false,
"permittedActions": [
"edit"
],
"permittedAttributes": [
"title"
],
"createdAt": "2018-07-22T15:05:58.033Z",
"createdBy": "A3RGM375QTZ7",
"updatedAt": "2018-07-22T15:05:58.033Z",
"updatedBy": "A3RGM375QTZ7",
"deletedAt": "2018-07-22T15:05:58.033Z",
"deletedBy": "A3RGM375QTZ7"
}
],
"createdAt": "2018-07-22T15:05:58.033Z",
"createdBy": "A3RGM375QTZ7",
"updatedAt": "2018-07-22T15:05:58.033Z",
"updatedBy": "A3RGM375QTZ7",
"deletedAt": "2018-07-22T15:05:58.033Z",
"deletedBy": "A3RGM375QTZ7"
}
]
}
Show More