com.veeva.vault.vapil.api.request

Class DocumentAnnotationRequest

java.lang.Object

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

com.veeva.vault.vapil.api.request.DocumentAnnotationRequest

public class DocumentAnnotationRequest
extends VaultRequest

Document Annotation Requests

Vault API Coverage:

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

Field Summary

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
DocumentAnnotationResponse	retrieveAnchorIds(int docId) Retrieve Anchor IDs
VaultResponse	retrieveDocumentAnnotations(int docId) Retrieve Document Annotations
VaultResponse	retrieveDocumentVersionAnnotations(int docId, int majorVersion, int minorVersion) Retrieve Document Version Annotations
VaultResponse	retrieveDocumentVersionNotesAsCSV(int docId, int majorVersion, int minorVersion) Retrieve Document Version Notes as CSV Retrieve notes in CSV format for any document that has a viewable rendition and at least one annotation.
VaultResponse	retrieveVideoAnnotations(int docId, int majorVersion, int minorVersion) Retrieve Video Annotations Retrieve annotations on a video document.
DocumentAnnotationRequest	setBinaryFile(String filename, byte[] binaryContent) Specify source data in an input file
DocumentAnnotationRequest	setInputPath(String inputPath) Specify source data in an input file
DocumentAnnotationRequest	setOutputPath(String outputPath) Specify source data in an output file
DocumentAnnotationResponse	uploadDocumentAnnotations(int docId) Upload Document Annotations
DocumentAnnotationResponse	uploadDocumentVersionAnnotations(int docId, int majorVersion, int minorVersion) Upload Document Version Annotations Uploads the file and its annotations for the specified document version.

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

Method Detail

retrieveDocumentAnnotations

public VaultResponse retrieveDocumentAnnotations(int docId)

Retrieve Document Annotations

Retrieves the document rendition and its associated annotations.

Parameters:

docId - The document id field value.

Returns:

VaultResponse

Vault API Endpoint:

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

Vault API Help Link:

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

Example Request:

 Example 1 - To File
 VaultResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                                .setOutputPath(outputPath.toString())
                                .retrieveDocumentAnnotations(docId);

,

 Example 2 -  Get the file and manually download (retrieve the file as bytes in the response)
 VaultResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                                .setOutputPath(outputPath.toString())
                                .retrieveDocumentAnnotations(docId);

Example Response:

 if (response.getResponseStatus().equals(VaultResponse.HTTP_RESPONSE_SUCCESS)) {
   try (OutputStream os = new FileOutputStream(outputPath.toString())) {
     os.write(response.getBinaryContent());
     }
   catch (IOException ignored) {}
 }

retrieveDocumentVersionAnnotations

public VaultResponse retrieveDocumentVersionAnnotations(int docId,
                                                        int majorVersion,
                                                        int minorVersion)

Retrieve Document Version Annotations

Retrieves the specified version document rendition and its associated annotations.

Parameters:

docId - The Document Id

majorVersion - The document major_version_number__v field value

minorVersion - The document minor_version_number__v field value

Returns:

VaultResponse

Vault API Endpoint:

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

Vault API Help Link:

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

Example Request:

 VaultResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                                .setOutputPath(outputPath.toString())
                                .retrieveDocumentVersionAnnotations(docId, majorVersion, minorVersion);

Example Response:

 if (response.getResponseStatus().equals(VaultResponse.HTTP_RESPONSE_SUCCESS)) {
   try (OutputStream os = new FileOutputStream(outputPath.toString())) {
     os.write(response.getBinaryContent());
     }
   catch (IOException ignored) {}
 }

 System.out.println("File was saved to: " + outputPath.toString());
 

retrieveAnchorIds

public DocumentAnnotationResponse retrieveAnchorIds(int docId)

Retrieve Anchor IDs

Retrieve all anchor IDs from a document.

Parameters:

docId - The document id field value.

Returns:

DocumentAnnotationResponse

Vault API Endpoint:

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

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-anchor-ids

Example Request:

 DocumentAnnotationResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                                .retrieveAnchorIds(docId);

Example Response:

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

 if (response.isSuccessful()) {
   for (DocumentAnnotationResponse.AnchorData data : response.wgetAnchorDataList()) {
     System.out.println("\n**** Data Item **** ");
     System.out.println("anchorId = " + data.getAnchorId());
     System.out.println("noteId = " + data.getNoteId());
     System.out.println("anchorName = " + data.getAnchorName());
     System.out.println("noteAuthor = " + data.getNoteAuthor());
     System.out.println("noteTimestamp = " + data.getNoteTimestamp());
     System.out.println("pageNumber = " + data.getPageNumber());
   }
 }

retrieveDocumentVersionNotesAsCSV

public VaultResponse retrieveDocumentVersionNotesAsCSV(int docId,
                                                       int majorVersion,
                                                       int minorVersion)

Retrieve Document Version Notes as CSV
Retrieve notes in CSV format for any document that has a viewable rendition and at least one annotation. You must have a Full User license type.

Parameters:

docId - The Document Id

majorVersion - The document major_version_number__v field value

minorVersion - The document minor_version_number__v field value

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/doc-export-annotations-to-csv

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-document-version-notes-as-csv

Example Request:

 Example 1 - To File
 VaultResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                                .setOutputPath(outputPath.toString())
                                .retrieveDocumentVersionNotesAsCSV(docId, majorVersion, minorVersion);

,

 Example 2 - Get the file and manually download (retrieve the file as bytes in the response)
 VaultResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                        .setOutputPath(null)
                        .retrieveDocumentVersionNotesAsCSV(docId, majorVersion, minorVersion);

Example Response:

 if (response.getResponseStatus().equals(VaultResponse.HTTP_RESPONSE_SUCCESS)) {
   try (OutputStream os = new FileOutputStream(outputPath.toString())) {
     os.write(response.getBinaryContent());
   }
   catch (IOException ignored) {}
 }

 System.out.println("File was saved to: " + response.getOutputFilePath());

retrieveVideoAnnotations

public VaultResponse retrieveVideoAnnotations(int docId,
                                              int majorVersion,
                                              int minorVersion)

Retrieve Video Annotations
Retrieve annotations on a video document.

Parameters:

docId - The Document Id

majorVersion - The document major_version_number__v field value

minorVersion - The document minor_version_number__v field value

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/export-video-annotations

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-video-annotations

Example Request:

 VaultResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                                .setOutputPath(outputPath.toString())
                                .retrieveVideoAnnotations(docId, majorVersion, minorVersion);

uploadDocumentAnnotations

public DocumentAnnotationResponse uploadDocumentAnnotations(int docId)

Upload Document Annotations

Uploads the file and its annotations.

Parameters:

docId - The document id field value.

Returns:

DocumentAnnotationResponse

Vault API Endpoint:

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

Vault API Help Link:

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

Example Request:

 DocumentAnnotationResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                                .setInputPath(inputPath.toString())
                                .uploadDocumentAnnotations(docId);

uploadDocumentVersionAnnotations

public DocumentAnnotationResponse uploadDocumentVersionAnnotations(int docId,
                                                                   int majorVersion,
                                                                   int minorVersion)

Upload Document Version Annotations
Uploads the file and its annotations for the specified document version.

Parameters:

docId - The Document Id

majorVersion - The document major_version_number__v field value

minorVersion - The document minor_version_number__v field value

Returns:

DocumentAnnotationResponse

Vault API Endpoint:

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

Vault API Help Link:

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

Example Request:

 DocumentAnnotationResponse response = vaultClient.newRequest(DocumentAnnotationRequest.class)
                                .setInputPath(inputPath.toString())
                                .uploadDocumentVersionAnnotations(docId, majorVersion, minorVersion);

setBinaryFile

public DocumentAnnotationRequest 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

setInputPath

public DocumentAnnotationRequest 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 DocumentAnnotationRequest setOutputPath(String outputPath)

Specify source data in an output file

Parameters:

outputPath - Absolute path to the file for the response

Returns:

The Request