containers/{containerId}/issue-types
Retrieves a project’s issue types. To also include issue subtypes in the response, use the include=subtypes query string parameter.
This operation is available to every valid member of this project.
Note that by default this endpoint will not return deleted items.
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-types |
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. |
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=subtypes to add the subtypes for each type. |
limit int | Add limit=20 to limit the results count, maximum limit - limit=200 (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 types that were last updated at the specified date and time range, 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. |
filter[deletedAt] string | Retrieves types that were last deleted at the specified date and time range, 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:
To include non-deleted items in the response, add For more details, see JSON API Filtering. |
filter[isActive] boolean | Filter types by status, e.g. filter[isActive]=true will only return active types. Default value: undefined (meaning both active & inactive issue types will return). |
Response
HTTP Status Code Summary
200 OK | List of issue types |
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)
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 type categories. |
id string: UUID | The ID of the issue type. |
containerId string: UUID | |
title string | Max length: 250 |
isActive boolean | States whether the issue type is active. |
orderIndex int | |
permittedActions array: string | Not relevant |
permittedAttributes array: string | Not relevant |
subtypes array: object | A list of subtypes of the specific issue type. |
id string: UUID | The ID of the issue subtype. |
issueTypeId string: UUID | The ID of the parent issue type. |
title string | Max length: 250 |
isActive boolean | Stated whether the issue subtype is active. |
orderIndex int | Not relevant |
isReadOnly boolean | Not relevant |
permittedActions array: string | Not relevant |
permittedAttributes array: string | Not relevant |
createdBy string | The unique identifier of the user who created the issue type. |
createdAt datetime: ISO 8601 | The date and time the issue was created, in ISO8601 format. |
updatedBy string | The unique identifier of the user who updated the issue type. |
updatedAt datetime: ISO 8601 | The date and time the issue type was updated, in ISO8601 format. |
deletedBy string | The unique identifier of the user who deleted the issue type. |
deletedAt datetime: ISO 8601 | The date and time the issue type was deleted, in ISO8601 format. |
statusSet string | Not relevant |
createdBy string | The unique identifier of the user who created the issue type. |
createdAt datetime: ISO 8601 | The date and time the issue was created, in ISO8601 format. |
updatedBy string | The unique identifier of the user who updated the issue type. |
updatedAt datetime: ISO 8601 | The date and time the issue type was updated, in ISO8601 format. |
deletedBy string | The unique identifier of the user who deleted the issue type. |
deletedAt datetime: ISO 8601 | The date and time the issue type was deleted, in ISO8601 format. |
Example
List of issue types
Request
curl -v 'https://developer.api.autodesk.com/issues/v2/containers/a5f49f04-59bb-477c-97e6-6833cb50bdac/issue-types?include=subtypes&limit=20&offset=20&filter[isActive]=true' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 10,
"offset": 100,
"totalResults": 25
},
"results": [
{
"id": "1110f111-6c54-4b01-90e6-d701748f1111",
"containerId": "a5f49f04-59bb-477c-97e6-6833cb50bdac",
"title": "Coordination",
"isActive": true,
"orderIndex": 2,
"permittedActions": [
"edit"
],
"permittedAttributes": [
"title"
],
"subtypes": [
{
"id": "1110f111-6c54-4b01-90e6-d701748f1111",
"issueTypeId": "2220f222-6c54-4b01-90e6-d701748f0222",
"title": "Clash",
"isActive": true,
"orderIndex": 5,
"isReadOnly": false,
"permittedActions": [
"edit"
],
"permittedAttributes": [
"title"
],
"createdBy": "A3RGM375QTZ7",
"createdAt": "2018-07-22T15:05:58.033Z",
"updatedBy": "A3RGM375QTZ7",
"updatedAt": "2018-07-22T15:05:58.033Z",
"deletedBy": "A3RGM375QTZ7",
"deletedAt": "2018-07-22T15:05:58.033Z"
}
],
"statusSet": "bim360",
"createdBy": "A3RGM375QTZ7",
"createdAt": "2018-07-22T15:05:58.033Z",
"updatedBy": "A3RGM375QTZ7",
"updatedAt": "2018-07-22T15:05:58.033Z",
"deletedBy": "A3RGM375QTZ7",
"deletedAt": "2018-07-22T15:05:58.033Z"
}
]
}