Upload Document Annotations

POST/api/{version}/objects/documents/{doc_id}/annotations

Headers

Section link for Headers

Name	Description
Content-Type	multipart/form-data
Accept	application/json (default) or application/xml

File Upload

Section link for File Upload

To upload the file, use the multi-part attachment with the file component "file={file_name}". The maximum allowed file size is 4GB.

URI Path Parameters

Section link for URI Path Parameters

Name	Description
{doc_id}	The document id field value.

Request

Section link for Request

Copy to clipboard

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: multipart/form-data" \
-F "file=document2016.pdf" \
https://myvault.veevavault.com/api/v18.1/objects/documents/548/annotations

Response

Section link for Response

Copy to clipboard

{
    "responseStatus": "SUCCESS",
    "responseMessage": "OK",
    "replies": 0,
    "failures": 0,
    "new": 0
}

Response Details

Section link for Response Details

On SUCCESS, Vault uploads the file and its annotations.