com.veeva.vault.vapil.api.request

Class DocumentEventRequest

java.lang.Object

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

com.veeva.vault.vapil.api.request.DocumentEventRequest

public class DocumentEventRequest
extends VaultRequest

Document Events

Vault API Coverage:

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

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
VaultResponse	createDocumentEvent(int docId, int majorVersion, int minorVersion, DocumentEvent.Property eventProperties) Create Document Event
DocumentEventResponse	retrieveDocumentEvents(int docId) Retrieve Document Events
DocumentEventSubtypeResponse	retrieveDocumentEventSubTypeMetadata(String type, String subtype) Retrieve Document Event SubType Metadata
DocumentEventTypeResponse	retrieveDocumentEventTypesandSubtypes() Retrieve Document Event Types and Subtypes

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

retrieveDocumentEventTypesandSubtypes

public DocumentEventTypeResponse retrieveDocumentEventTypesandSubtypes()

Retrieve Document Event Types and Subtypes

Returns:

DocumentEventTypeResponse

Vault API Endpoint:

 GET /api/{version}/metadata/objects/documents/events

Vault API Help Link:

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

Example Request:

 DocumentEventTypeResponse response = vaultClient.newRequest(DocumentEventRequest.class)
                                        .retrieveDocumentEventTypesandSubtypes();

Example Response:

 System.out.println(response.getResponseStatus());
 if (response.getEvents() != null) {
   for (DocumentEventTypeResponse.Event event : response.getEvents()) {
     System.out.println("Event Type Name: " + event.getName());
   }
 }

retrieveDocumentEventSubTypeMetadata

public DocumentEventSubtypeResponse retrieveDocumentEventSubTypeMetadata(String type,
                                                                         String subtype)

Retrieve Document Event SubType Metadata

Parameters:

type - event type

subtype - event sub type

Returns:

DocumentEvenSubtypeResponse

Vault API Endpoint:

 GET /api/{version}/metadata/objects/documents/events/{event_type}/types/{event_subtype}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-document-event-subtype-metadata

Example Request:

 DocumentEventSubtypeResponse response = vaultClient.newRequest(DocumentEventRequest.class)
                                        .retrieveDocumentEventSubTypeMetadata(type, subtype);

Example Response:

 System.out.println(response.getResponseStatus());
 if (response.getEventProperties() != null) {
   for (DocumentEventSubtypeResponse.DocumentEventSubtype event : response.getEventProperties()) {
     System.out.println("Event Subtype Name: " + event.getName());
     }
   }
 }

createDocumentEvent

public VaultResponse createDocumentEvent(int docId,
                                         int majorVersion,
                                         int minorVersion,
                                         DocumentEvent.Property eventProperties)

Create Document Event

Parameters:

docId - Document metadata to update

majorVersion - document major version number

minorVersion - document minor version number

eventProperties - properties for the event

Returns:

DocumentEvenSubtypeResponse

Vault API Endpoint:

 POST /api/{version}/objects/documents/{document_id}/versions/{major_version}/{minor_version}/events

Vault API Help Link:

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

Example Response:

 VaultResponse response = vaultClient.newRequest(DocumentEventRequest.class)
                                .createDocumentEvent(docId, majorVersion, minorVersion, event.getEventProperties());

,

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

retrieveDocumentEvents

public DocumentEventResponse retrieveDocumentEvents(int docId)

Retrieve Document Events

Parameters:

docId - Document metadata to update

Returns:

DocumentEventResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{document_id}/events

Vault API Help Link:

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

Example Request:

 DocumentEventResponse response = vaultClient.newRequest(DocumentEventRequest.class)
                                        .retrieveDocumentEvents(docId);

Example Response:

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

 if (response.getEvents() != null) {
   for (DocumentEvent event : response.getEvents()) {
     System.out.println("Event Name: " + event.getName());
   }
 }