com.veeva.vault.vapil.api.request

Class DocumentRenditionRequest

java.lang.Object

com.veeva.vault.vapil.api.request.VaultRequest

com.veeva.vault.vapil.api.request.DocumentRenditionRequest

public class DocumentRenditionRequest
extends VaultRequest

Document Rendition requests

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#document-renditions

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_HEADER_VAULT_MIGRATION_MODE X-VaultAPI-MigrationMode When set to true, Vault applies Document Migration Mode limitations only to documents created with the request.
static String	ID_PARAM If you’re identifying documents in your input by a unique field, add idParam={fieldname} to the request endpoint.

Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest

HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_VAULT_CLIENT_ID, vaultClient

Method Summary

Modifier and Type	Method and Description
VaultResponse	addMultipleDocumentRenditions() Add Multiple Document Renditions Add document renditions in bulk.
VaultResponse	addSingleDocumentRendition(int docId, String renditionType) Add Single Document Rendition If you need to add more than one document rendition, it is best practice to use addMultipleDocumentRenditions()
VaultResponse	deleteDocumentVersionRendition(int docId, int majorVersion, int minorVersion, String renditionType) Delete Document Version Rendition
VaultResponse	deleteMultipleDocumentRenditions() Delete Multiple Document Renditions
VaultResponse	deleteSingleDocumentRendition(int docId, String renditionType) Delete Single Document Rendition
VaultResponse	downloadDocumentRenditionFile(int docId, String renditionType) Download Document Rendition File
VaultResponse	downloadDocumentRenditionFile(int docId, String renditionType, Boolean steadyState) Download Document Rendition File
VaultResponse	downloadDocumentVersionRenditionFile(int docId, int majorVersion, int minorVersion, String renditionType) Download Document Version Rendition File
VaultResponse	replaceDocumentRendition(int docId, String renditionType) Replace Document Rendition
VaultResponse	replaceDocumentVersionRendition(int docId, int majorVersion, int minorVersion, String renditionType) Replace Document Version Rendition
DocumentRenditionResponse	retrieveDocumentRenditions(int docId) Retrieve Document Renditions
DocumentRenditionResponse	retrieveDocumentVersionRenditions(int docId, int majorVersion, int minorVersion) Retrieve Document Version Rendition
DocumentRenditionRequest	setBinaryFile(String filename, byte[] binaryContent) Specify source data in an input file
DocumentRenditionRequest	setIdParam(String idParam) Specify a value for the idParam (if not using id)
DocumentRenditionRequest	setInputPath(String inputPath) Specify source data in an input file
DocumentRenditionRequest	setLargeSizeAsset(Boolean largeSizeAsset) Indicates that the renditions to add are of the Large Size Asset (large_size_asset__v) rendition type
DocumentRenditionRequest	setMigrationMode(Boolean migrationMode) Enable migration mode to add document renditions in bulk.
DocumentRenditionRequest	setOutputPath(String outputPath) Specify source data in an output file
DocumentRenditionRequest	setRequestString(String requestString) Specify source data in an input string, such as a CSV request
VaultResponse	uploadDocumentVersionRendition(int docId, int majorVersion, int minorVersion, String renditionType) Upload Document Version Rendition

Methods inherited from class com.veeva.vault.vapil.api.request.VaultRequest

getBaseObjectMapper, send, send, sendReturnBinary, sendReturnBinary, sendToFile, sendToFile, setVaultClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTP_HEADER_VAULT_MIGRATION_MODE

public static final String HTTP_HEADER_VAULT_MIGRATION_MODE

X-VaultAPI-MigrationMode When set to true, Vault applies Document Migration Mode limitations only to documents created with the request.

See Also:

Constant Field Values

ID_PARAM

public static final String ID_PARAM

If you’re identifying documents in your input by a unique field, add idParam={fieldname} to the request endpoint.

See Also:

Constant Field Values

Method Detail

retrieveDocumentRenditions

public DocumentRenditionResponse retrieveDocumentRenditions(int docId)

Retrieve Document Renditions

Parameters:

docId - The document id

Returns:

DocumentRenditionResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/renditions

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-document-renditions

Example Request:

 DocumentRenditionResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class).retrieveDocumentRenditions(docId);

Example Response:

 System.out.println(resp.getResponse());

 for (String s : resp.getRenditionTypes())
 System.out.println(s);

 System.out.println(" ");
 for (String s : resp.getRenditions().getProperties().keySet())
 System.out.println(s + " = " + resp.getRenditions().getProperties().get(s));

 System.out.println("\n------ Retrieve Document Renditions Major/Minor Version ------");
 resp = vaultClient.newRequest(DocumentRenditionRequest.class).retrieveDocumentVersionRenditions(docId, majorVersion, minorVersion);

 System.out.println(resp.getResponse());

 for (String s : resp.getRenditionTypes())
 System.out.println(s);

 System.out.println(" ");
 for (String s : resp.getRenditions().getProperties().keySet())
 System.out.println(s + " = " + resp.getRenditions().getProperties().get(s));
 

retrieveDocumentVersionRenditions

public DocumentRenditionResponse retrieveDocumentVersionRenditions(int docId,
                                                                   int majorVersion,
                                                                   int minorVersion)

Retrieve Document Version Rendition

Parameters:

docId - The document id

majorVersion - The major version

minorVersion - The minor version

Returns:

DocumentRenditionResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-document-version-renditions

Example Request:

 DocumentRenditionResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class).retrieveDocumentVersionRenditions(docId, majorVersion, minorVersion);

Example Response:

 System.out.println(resp.getResponse());

 for (String s : resp.getRenditionTypes())
   System.out.println(s);

 for (String s : resp.getRenditions().getProperties().keySet())
   System.out.println(s + " = " + resp.getRenditions().getProperties().get(s));

downloadDocumentRenditionFile

public VaultResponse downloadDocumentRenditionFile(int docId,
                                                   String renditionType)

Download Document Rendition File

Download a rendition (file) from the latest version of a document. This method will retrieve non-steady state versions. Use the downloadDocumentRenditionFile(int, String, Boolean) method to retrieve steady state (pass in steadyState = true).

Parameters:

docId - The document id

renditionType - The rendition type

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#download-document-rendition-file

Example Request:

 VaultResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class)
                                .setOutputPath(inputPath.replace(".pdf", "1.pdf"))
                                .downloadDocumentRenditionFile(docId, renditionType);

Example Response:

System.out.println("Latest version status = " + resp.isSuccessful());

 resp = vaultClient.newRequest(DocumentRenditionRequest.class)
 .setOutputPath(inputPath.replace(".pdf", "2.pdf"))
 .downloadDocumentRenditionFile(docId, renditionType, true);
 System.out.println("Steady state status = " + resp.isSuccessful());

 resp = vaultClient.newRequest(DocumentRenditionRequest.class)
 .setOutputPath(inputPath.replace(".pdf", "3.pdf"))
 .downloadDocumentVersionRenditionFile(docId, majorVersion, minorVersion,renditionType);
 System.out.println("Specific version status = " + resp.isSuccessful());
 

downloadDocumentRenditionFile

public VaultResponse downloadDocumentRenditionFile(int docId,
                                                   String renditionType,
                                                   Boolean steadyState)

Download Document Rendition File

Download a rendition (file) from either the steady state or latest version of the document, as specified by the input steadyState param.

Parameters:

docId - The document id

renditionType - The rendition type

steadyState - True to retrieve the steady state; false for the latest version

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#download-document-rendition-file

downloadDocumentVersionRenditionFile

public VaultResponse downloadDocumentVersionRenditionFile(int docId,
                                                          int majorVersion,
                                                          int minorVersion,
                                                          String renditionType)

Download Document Version Rendition File

Download a specific document version rendition (file).

Parameters:

docId - The document id

majorVersion - The major version

minorVersion - The minor version

renditionType - The rendition type

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#download-document-version-rendition-file

addMultipleDocumentRenditions

public VaultResponse addMultipleDocumentRenditions()

Add Multiple Document Renditions
Add document renditions in bulk. Note that the Vault must be in migration mode for this integration call.

Returns:

VaultResponse

Vault API Endpoint:

 POST /api/{version}/objects/documents/renditions/batch

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#add-multiple-document-renditions

Example Request:

 VaultResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class)
                                .setInputPath(inputPath)
                                .addMultipleDocumentRenditions();

Example Response:

System.out.println(new String(resp.getBinaryContent()));
 

addSingleDocumentRendition

public VaultResponse addSingleDocumentRendition(int docId,
                                                String renditionType)

Add Single Document Rendition
If you need to add more than one document rendition, it is best practice to use addMultipleDocumentRenditions()

Parameters:

docId - The document id

renditionType - The rendition type

Returns:

VaultResponse

Vault API Endpoint:

 POST /api/{version}/objects/documents/{doc_id}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#add-single-document-rendition

Example Request:

 VaultResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class)
                                .setInputPath(inputPath)
                                .addSingleDocumentRendition(docId, renditionType);

Example Response:

System.out.println("Add single status = " + resp.isSuccessful());
 

uploadDocumentVersionRendition

public VaultResponse uploadDocumentVersionRendition(int docId,
                                                    int majorVersion,
                                                    int minorVersion,
                                                    String renditionType)

Upload Document Version Rendition

Parameters:

docId - The document id

majorVersion - The major version

minorVersion - The minor version

renditionType - The rendition type

Returns:

VaultResponse

Vault API Endpoint:

 POST /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#upload-document-version-rendition

Example Request:

 VaultResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class)
                                .setInputPath(inputPath)
                                .uploadDocumentVersionRendition(docId, majorVersion, minorVersion, renditionType);

Example Response:

System.out.println("Upload status = " + resp.isSuccessful());
 

replaceDocumentRendition

public VaultResponse replaceDocumentRendition(int docId,
                                              String renditionType)

Replace Document Rendition

Parameters:

docId - The document id

renditionType - The rendition type

Returns:

VaultResponse

Vault API Endpoint:

 PUT /api/{version}/objects/documents/{doc_id}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#replace-document-rendition

Example Request:

 VaultResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class)
                                .setInputPath(inputPath)
                                .replaceDocumentRendition(docId, renditionType);

Example Response:

System.out.println("Upload status = " + resp.isSuccessful());

 resp = vaultClient.newRequest(DocumentRenditionRequest.class)
 .setInputPath(inputPath)
 .replaceDocumentVersionRendition(docId, majorVersion, minorVersion, renditionType);
 System.out.println("Upload specific version status = " + resp.isSuccessful());
 

replaceDocumentVersionRendition

public VaultResponse replaceDocumentVersionRendition(int docId,
                                                     int majorVersion,
                                                     int minorVersion,
                                                     String renditionType)

Replace Document Version Rendition

Parameters:

docId - The document id

majorVersion - The major version

minorVersion - The minor version

renditionType - The rendition type

Returns:

VaultResponse

Vault API Endpoint:

 PUT /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#replace-document-version-rendition

deleteMultipleDocumentRenditions

public VaultResponse deleteMultipleDocumentRenditions()

Delete Multiple Document Renditions

Delete document renditions in bulk.

Returns:

VaultResponse

Vault API Endpoint:

 DELETE /api/{version}/objects/documents/renditions/batch

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#delete-multiple-document-renditions

Example Request:

 VaultResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class)
                                .setInputPath(inputPath)
                                .deleteMultipleDocumentRenditions();

Example Response:

System.out.println(new String(resp.getBinaryContent()));
 

deleteSingleDocumentRendition

public VaultResponse deleteSingleDocumentRendition(int docId,
                                                   String renditionType)

Delete Single Document Rendition

If you need to delete more than one document rendition, it is best practice to use bulk deleteMultipleDocumentRenditions()

Parameters:

docId - The document id

renditionType - The rendition type

Returns:

VaultResponse

Vault API Endpoint:

 DELETE /api/{version}/objects/documents/{document_id}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#delete-single-document-rendition

Example Request:

 VaultResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class).deleteSingleDocumentRendition(docId, renditionType);

Example Response:

System.out.println("Status = " + resp.isSuccessful());
 

deleteDocumentVersionRendition

public VaultResponse deleteDocumentVersionRendition(int docId,
                                                    int majorVersion,
                                                    int minorVersion,
                                                    String renditionType)

Delete Document Version Rendition

Parameters:

docId - The document id

majorVersion - The major version

minorVersion - The minor version

renditionType - The rendition type

Returns:

VaultResponse

Vault API Endpoint:

 DELETE /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#delete-document-version-rendition

Example Request:

 VaultResponse resp = vaultClient.newRequest(DocumentRenditionRequest.class).deleteDocumentVersionRendition(docId, majorVersion, minorVersion, renditionType);

Example Response:

System.out.println("Status = " + resp.isSuccessful());
 

setBinaryFile

public DocumentRenditionRequest setBinaryFile(String filename,
                                              byte[] binaryContent)

Specify source data in an input file

Parameters:

filename - file name (no path)

binaryContent - byte array of the file content

Returns:

The Request

setLargeSizeAsset

public DocumentRenditionRequest setLargeSizeAsset(Boolean largeSizeAsset)

Indicates that the renditions to add are of the Large Size Asset (large_size_asset__v) rendition type

Parameters:

largeSizeAsset - The source request as a string

Returns:

The Request

setIdParam

public DocumentRenditionRequest setIdParam(String idParam)

Specify a value for the idParam (if not using id)

Parameters:

idParam - External Id field API name for the UPSERT

Returns:

The Request

setInputPath

public DocumentRenditionRequest setInputPath(String inputPath)

Specify source data in an input file

Parameters:

inputPath - Absolute path to the file for the request

Returns:

The Request

setOutputPath

public DocumentRenditionRequest setOutputPath(String outputPath)

Specify source data in an output file

Parameters:

outputPath - Absolute path to the file for the response

Returns:

The Request

setRequestString

public DocumentRenditionRequest setRequestString(String requestString)

Specify source data in an input string, such as a CSV request

Parameters:

requestString - The source request as a string

Returns:

The Request

setMigrationMode

public DocumentRenditionRequest setMigrationMode(Boolean migrationMode)

Enable migration mode to add document renditions in bulk. If not specified, the Add Multiple Document Renditions will fail. API user must have the Document Migration permission to use this header.

Parameters:

migrationMode - The source request as a string

Returns:

The Request