Retrieve Document Version Attachment Version Metadata

Retrieve a specific version of an attachment on a document version.

GET

/api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version}

Headers

Name	Description
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`{doc_id}`	The document `id` field value.
`{major_version}`	The document `major_version_number__v` field value.
`{minor_version}`	The document `minor_version_number__v` field value.
`{attachment_id}`	The `id` of the document attachment to retrieve.
`{attachment_version}`	Optional: The version of the attachment to retrieve. If omitted, the endpoint retrieves all versions of the specified attachment.

Request

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v26.1/objects/documents/17/versions/0/1/attachments/39/versions/1

Response

{
    "responseStatus": "SUCCESS",
    "data": [
        {
            "id": 39,
            "filename__v": "New",
            "format__v": "application/x-tika-ooxml",
            "size__v": 55762,
            "md5checksum__v": "c5e7eaafc39af8ba42081a213a68f781",
            "version__v": 1,
            "created_by__v": 61603,
            "created_date__v": "2017-10-30T17:03:29.878Z"
        }
    ]
}

Response Details

On SUCCESS, the response lists the following metadata for the requested attachment version on the specified document version:

Metadata Field	Description
`id`	ID of the attachment. This is set by the system.
`external_id__v`	The attachment’s external ID if provided in a Create Multiple Document Attachments request. The response excludes this attribute if the attachment has no external ID.
`filename__v`	File name of the attachment.
`format__v`	File format of the attachment.
`description__v`	Optional description added to the attachment. The response excludes this attribute if the attachment has no description.
`size__v`	File size of the attachment in bytes.
`md5checksum__v`	MD5 checksum value calculated for the attachment. To avoid creating identical versions, Vault assigns each version a checksum value.
`version__v`	Version of the attachment. Attachment versioning uses integer numbers beginning with 1 and incrementing sequentially (1, 2, 3,...). There is no concept of major or minor version numbers with attachments.
`created_by__v`	The ID of the User that created the attachment.
`created_date__v`	Date the attachment was created.