Add Multiple Document Renditions

POST https://{{vaultDNS}}/api/{{version}}/objects/documents/renditions/batch

https://developer.veevavault.com/api/23.3/#Add_Document_Renditions_Bulk

Add document renditions in bulk.

  • If the largeSizeAsset query parameter is not set to true, you must include the X-VaultAPI-MigrationMode header.
  • The maximum CSV input file size is 1GB.
  • The values in the input must be UTF-8 encoded.
  • CSVs must follow the standard format.
  • The maximum batch size is 500.

Request Params

KeyDatatypeRequiredDescription
idParamnullIf you’re identifying documents in your input by their external ID
largeSizeAssetnullIf set to true, indicates that the renditions to add are of the Large Size Asset (large_size_asset__v) rendition type. Vault applies Document Migration Mode limitations to renditions created with the request, but Document Migration permission is not required and your vault need not be in Migration Mode to use the parameter. Note that the request results in an error if the CSV contains any rendition type other than large_size_asset__v.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Acceptstring
Content-Typestring
X-VaultAPI-MigrationModebooleanWhen set to true, Vault applies Document Migration Mode limitations only to renditions created with the request. This differs from placing your entire vault in Migration Mode, which applies to all documents for the duration of its enablement. You must have the Document Migration permission to use this header.