containers/{containerId}/issues/{issueId}/attachments
Get all attachments (by default will not return deleted attachments).
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/issues/:issueId/attachments |
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. |
issueId string | The unique issue ID |
Request
Query String Parameters
filter[status] string | Filter attachments by status. Separate multiple values with commas |
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). |
Response
HTTP Status Code Summary
200 OK | Success |
400 Bad Request | Invalid ID supplied |
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 or Issue 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 | |
id string: UUID | |
issueId string: UUID | |
name string | |
urn string | Use this attribute if urnType=dm .
Note that response format can be either dm - |
createdBy string | The unique identifier of the user who created the attachment. |
updatedBy string | The unique identifier of the user who updated the attachment. |
deletedBy string | The unique identifier of the user who deleted the attachment. |
createdAt datetime: ISO 8601 | The date and time the attachment was created (attached), in ISO8601 format. |
updatedAt datetime: ISO 8601 | The date and time the attachment was updated, in ISO8601 format. |
deletedAt datetime: ISO 8601 | The date and time the attachment was deleted, in ISO8601 format. |
markupMetadata object | Not relevant |
attachmentType enum:string | The attachmentType attribute indicates the type of file that is being attached.
The value of attachmentType is determined by the file suffix of the attached file. If the file has a suffix that corresponds to a lowercase photo format (such as .jpg, .png etc.), then attachmentType is set to photo. Otherwise, it is set to document. Possible Values: |
status enum:string | The status of an attachment file to an issue.
Possible Values: |
clientCreatedAt string | Not relevant |
clientUpdatedAt datetime: ISO 8601 | Not relevant |
urnType enum:string | urnType attribute indicates the type of storage where the attachment will be stored.
If urnType is set to If urnType is set to Possible Values: |
wipUrn object | Not relevant |
permittedActions array: string | The list of actions permitted for the user for attachment.
Possible Values: |
permittedAttributes array: string | A list of attributes you are allowed to edit regard the attachment.
Possible Values: |
urnVersion int |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/issues/v2/containers/a5f49f04-59bb-477c-97e6-6833cb50bdac/issues/a5f49f04-59bb-477c-97e6-6833cb50bdac/attachments?filter[status]=file-uploaded,completed&limit=20&offset=20' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 10,
"offset": 100,
"totalResults": 25
},
"results": [
{
"id": "1110f111-6c54-4b01-90e6-d701748f1111",
"issueId": "1110f111-6c54-4b01-90e6-d701748f1111",
"name": "Darth Vader",
"urn": "urn:adsk.wipqa:fs.folder:co.LymIC3w5SEOE6jXChqmkqg",
"createdBy": "A3RGM375QTZ7",
"updatedBy": "A3RGM375QTZ7",
"deletedBy": "A3RGM375QTZ7",
"createdAt": "2018-07-22T15:05:58.033Z",
"updatedAt": "2018-07-22T15:05:58.033Z",
"deletedAt": "2018-07-22T15:05:58.033Z",
"markupMetadata": {},
"attachmentType": "photo",
"status": "completed",
"clientCreatedAt": "A3RGM375QTZ7",
"clientUpdatedAt": "2018-07-22T15:05:58.033Z",
"urnType": "dm",
"wipUrn": {},
"permittedActions": [
"remove_attachment"
],
"permittedAttributes": [
"name"
],
"urnVersion": 1
}
]
}