Skip to content
Vault Logo
Vault Developer Portal Developer RIM
Advanced Search

    Release Notes

    Download Document Attachment

    Downloads the latest version of the specified attachment from the document.

    GET/api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}/file

    Headers

    Section link for Headers
    NameDescription
    Acceptapplication/json (default) or application/xml

    URI Path Parameters

    Section link for URI Path Parameters
    NameDescription
    {doc_id}The document id field value.
    {attachment_id}The attachment id field value.

    Request

    Section link for Request
    curl -X GET -H "Authorization: {SESSION_ID}" \ https://myvault.veevavault.com/api/v23.1/objects/documents/565/attachments/567/file

    Response

    Section link for Response
    Content-Type: application/octet-stream;charset=UTF-8 Content-Disposition: attachment;filename="file.pdf"

    Response Details

    Section link for Response Details

    On SUCCESS, Vault retrieves the latest version of the attachment from the document. The file name is the same as the attachment file name.

    The HTTP Response Header Content-Type is set to the MIME type of the file. For example, if the attachment is a PNG image, the Content-Typeis image/png. If we cannot detect the MIME file type, Content-Type is set to application/octet-stream. The HTTP Response Header Content-Disposition contains a filename attribute which can be used when naming the local file. When retrieving attachments with very small file size, the HTTP Response Header Content-Length is set to the size of the attachment. Note that for most attachment downloads (larger file sizes), the Transfer-Encoding method is set to chunked and the Content-Length is not displayed.