Question:
The Veeva Vault API provides programmatic access to Vault information and functionality using a simple, powerful, and secure application programming interface. How can Vault's Rendition Documents be retrieved by using Vault API from Third Party Applications?
Answer:
Download a rendition (file) from the latest version of a document.
- Request
Send GET to /api/{version}/objects/documents/{document_id}/renditions/{rendition_type}
- Headers
Response Accept - JSON application/json (default) or XML application/xml
- Parameters
{document_id} - The document id field value.
{rendition_type} - The document rendition type.
- Options
/api/{version}/objects/documents/{document_id}/renditions/{rendition_type}?steadyState=true
Download a rendition (file) from the latest steady state version (1.0, 2.0, etc.) of a document.
- Example
$ curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v15.0/objects/documents/534/renditions/viewable_rendition__v > file
- Response
{
"responseStatus": "SUCCESS"
}
On SUCCESS, Vault retrieves the file associated with the given renditions type for the document.
The HTTP Response Header Content-Type is set to Application/octet-stream.
Related Documentation:
Vault Help Documentation:
Send us your feedback: We're always looking for advice to help improve our Knowledge Base! Please let us know if this article was helpful or provide feedback on how we can improve your experience here.
Thank you