Import Document Version Annotations from PDF

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

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

Load annotations from a PDF to Vault. This is equivalent to the Import Annotations action in the Vault document viewer UI. The file must be a PDF created by exporting annotations for the specified version of the same document through either the Export Annotations action in the Vault UI or the Export Document Version Annotations as PDF endpoint. You must have a role on the document that includes the Annotate permission.

To upload the file, use the multi-part attachment with the file component "file={file_name}". The maximum allowed file size is 4GB. Vault truncates annotations that exceed the following character limits:

  • Note annotationsSubject (in Header) limited to 32,000 characters

  • Note, Line, and Reply annotationsComment limited to 32,000 characters

On SUCCESS, Vault uploads the file and its annotations.

Request Body

[{"name"=>"file", "value"=>nil, "datatype"=>"null"}]

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Acceptstring
Content-Typestring