Export Document Version Annotations to PDF

GET https://{{vaultDNS}}/api/{{version}}/objects/documents/:{doc_id}/versions/:{major_version}/:{minor_version}/annotations/file

https://developer.veevavault.com/api/24.2/#RetrieveDocumentVersion_Annotations

Export a specific version of any document, along with its annotations, as an annotated PDF. This is equivalent to the Export Annotations action in the Vault document viewer UI. You can then view annotations, reply to existing annotations, and create new annotations in a supported PDF editor. When finished, you can import your new notes and replies to Vault using the Import Document Version Annotations from PDF endpoint.

You must have View Content permission on the specified document version and a security profile that grants the Document: Download Rendition permission to export annotations.

On SUCCESS, Vault retrieves the specified version document rendition and its associated annotations in PDF format.

  • The HTTP Response Header Content-Type is set to application/pdf.
  • The HTTP Response Header Content-Disposition contains a filename component which is used as the default name for the local file.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Acceptstring