Package com.veeva.vault.vapil.api.request

Class DocumentSignatureRequest

java.lang.Object

com.veeva.vault.vapil.api.request.VaultRequest<DocumentSignatureRequest>

com.veeva.vault.vapil.api.request.DocumentSignatureRequest

public class DocumentSignatureRequest
extends VaultRequest<DocumentSignatureRequest>

Document Events

Vault API Coverage:

https://developer.veevavault.com/api/25.1/#document-signatures

Field Summary

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

HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_REFERENCE_ID, HTTP_HEADER_VAULT_CLIENT_ID, referenceId, requestClientId, vaultClient

Method Summary

Modifier and Type	Method	Description
DocumentSignatureMetadataResponse	retrieveArchivedDocumentSignatureMetadata()	Retrieve Archived Document Signature Metadata
DocumentSignatureMetadataResponse	retrieveDocumentSignatureMetadata()	Retrieve Document Signature Metadata

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

getBaseObjectMapper, send, send, sendReturnBinary, sendReturnBinary, sendToFile, sendToFile, setHeaderClientId, setHeaderReferenceId, setVaultClient

Methods inherited from class java.lang.Object

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

Method Details

retrieveDocumentSignatureMetadata

public DocumentSignatureMetadataResponse retrieveDocumentSignatureMetadata()

Retrieve Document Signature Metadata

Retrieve all metadata for signatures on documents.

Returns:

DocumentSignatureMetadataResponse

Vault API Endpoint:

 GET /api/{version}/metadata/query/documents/relationships/document_signature__sysr

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#retrieve-document-event-types-and-subtypes

Example Request:

 DocumentSignatureMetadataResponse response = vaultClient.newRequest(DocumentSignatureRequest.class)
      .retrieveDocumentSignatureMetadata();
 

Example Response:

 for (Field field : response.getProperties().getFields()) {
      System.out.println("--------Field---------");
      System.out.println("Name: " + field.getName());
      System.out.println("Type: " + field.getType());
 }
 

retrieveArchivedDocumentSignatureMetadata

public DocumentSignatureMetadataResponse retrieveArchivedDocumentSignatureMetadata()

Retrieve Archived Document Signature Metadata

Retrieve all metadata for signatures on archived documents.

Returns:

DocumentSignatureMetadataResponse

Vault API Endpoint:

 GET /api/{version}/metadata/query/archived_documents/relationships/document_signature__sysr

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#retrieve-archived-document-signature-metadata

Example Request:

 DocumentSignatureMetadataResponse response = vaultClient.newRequest(DocumentSignatureRequest.class)
      .retrieveArchivedDocumentSignatureMetadata();
 

Example Response:

 for (Field field : response.getProperties().getFields()) {
      System.out.println("--------Field---------");
      System.out.println("Name: " + field.getName());
      System.out.println("Type: " + field.getType());
 }