Skip to content
Vault Logo
Vault Developer Portal Developer
Advanced Search

    Release Notes

    Download All Document Attachments

    Downloads the latest version of all attachments from the document.

    GET/api/{version}/objects/documents/{doc_id}/attachments/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.

    Request

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

    Response

    Section link for Response
    Content-Type: application/octet-stream;charset=UTF-8 Content-Disposition: attachment;filename="Document VV-02839 (v0.1) - attachments.zip"

    Response Details

    Section link for Response Details

    On SUCCESS, Vault retrieves the latest version of all attachments from the document. The attachments are packaged in a ZIP file with the file name: Document {document number} (v. {major version}.{minor version}) - attachments.zip.

    The HTTP Response Header Content-Type is set to application/zip. The HTTP Response Header Content-Disposition contains a filename attribute which can be used when naming the local file. When downloading 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.