attachments
Adds an attachment to a BIM 360 Project Management RFI. You can attach any file that you uploaded to BIM 360 Document Management. Note that we do not currently support attaching local files to an RFI.
For more details about adding attachments, see the Upload Attachment tutorial.
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 | POST https://developer.api.autodesk.com/bim360/rfis/v2/containers/:containerId/rfis/:rfiId/attachments |
Authentication Context | user context required |
Required OAuth Scopes | data:write data:create |
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 |
Request
URI Parameters
containerId string | The ID of the container. Each project is assigned a container that stores all the RFIs for the project. To find the ID, see the Retrieve a Container ID tutorial. |
rfiId string | The ID of the RFI. |
Request
Body Structure
name* string | The name of the attachment.
Max length: 400 |
urn string | The ID (item ID) of the document associated with the RFI. For more details, see the Upload Attachment tutorial.
Max length: 400 |
urnType enum:string | The type of attachment. We currently only support adding attachments from BIM 360 Document Management. Possible value: dm . |
Response
HTTP Status Code Summary
201 Created | Created |
400 Bad Request | The parameters 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 |
500 Internal Server Error | An unknown error occurred on the server |
Response
Body Structure (201)
id string: UUID | The ID of the attachment. |
rfiId string | The ID of the RFI associated with the attachment. |
createdAt datetime: ISO 8601 | The timestamp of the date and time the attachment was created, in the following format: YYYY-MM-DDThh:mm:ss.sz . |
updatedAt datetime: ISO 8601 | The last date and time the attachment attributes were updated, in the following format: YYYY-MM-DDThh:mm:ss.sz . |
createdBy string | The Autodesk ID of the user who added the attachment. To check the name of the user, call GET projects/users. |
deletedAt datetime: ISO 8601 | The timestamp of the date and time the attachment was deleted, in the following format: YYYY-MM-DDThh:mm:ss.sz . This is only relevant for deleted attachments. |
deletedBy string | The Autodesk ID of the user who deleted the attachment. To check the name of the user, call GET projects/users. This is only relevant for deleted attachments. |
name string | The name of the attachment. |
url string | The URL of the storage location for the attachment. |
urn string | The ID (item ID) of the document associated with the RFI. For more details, see the Upload Attachment tutorial.
Max length: 400 |
urnType enum:string | The type of attachment URN. Possible values:
|
attachmentType enum:string | The type of attachment.
Possible values: photo , document |
permittedActions object | A list of actions that are permitted for the current user. |
removeAttachment boolean | true if the current user can delete the attachment
|
Example
Created
Request
curl -v 'https://developer.api.autodesk.com/bim360/rfis/v2/containers/:containerId/rfis/:rfiId/attachments' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"name": "Photo.png",
"urn": "urn:adsk.wipprod:dm.lineage:1t7QY9-JSxCB0TLh1qMvFQ",
"urnType": "dm"
}'
Response
{
"id": "c911852d-5957-4145-9c8d-e7cfe9d564df",
"rfiId": "0d302fc6-00a5-45ca-a9df-4427b9247c81",
"createdAt": "2018-08-01T08:56:48.699Z",
"updatedAt": "",
"createdBy": "PER8KQPK2JRT",
"deletedAt": "2018-08-01T08:56:48.699Z",
"deletedBy": "PER8KQPK2JRT",
"name": "Photo.png",
"url": "null",
"urn": "urn:adsk.wipprod:dm.lineage:1t7QY9-JSxCB0TLh1qMvFQ",
"urnType": "dm",
"attachmentType": "photo",
"permittedActions": {
"removeAttachment": ""
}
}