LogRequest (Vault-API-Library 21.1.3 API)

java.lang.Object
- com.veeva.vault.vapil.api.request.VaultRequest
- - com.veeva.vault.vapil.api.request.LogRequest

```
public class LogRequest
extends VaultRequest
```
The Audit APIs retrieve information about audits and audit types

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#logs

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LogRequest.AuditTrailType` Enum for the various audit trail formats
`static class`	`LogRequest.FormatResultType` JSON or CSV Result Types
`static class`	`LogRequest.LogFormatType` log_format for the api_usage request

Field Summary
- Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest
  HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_VAULT_CLIENT_ID, vaultClient

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`retrieveAuditDetails(LogRequest.AuditTrailType auditTrailType)` Retrieve Audit Details
`<T> T`	`retrieveAuditDetailsAllPages(LogRequest.AuditTrailType auditTrailType)` Retrieve Audit Details
`<T> T`	`retrieveAuditDetailsOffset(LogRequest.AuditTrailType auditTrailType, String offsetURL)` Retrieve Audit Details
`AuditMetadataResponse`	`retrieveAuditMetadata(LogRequest.AuditTrailType auditTrailType)` Retrieve Audit Metadata
`AuditTypesResponse`	`retrieveAuditTypes()` Retrieve Audit Types
`VaultResponse`	`retrieveDailyAPIUsage()` Retrieve Daily API Usage
`DocumentAuditResponse`	`retrieveDocumentAuditTrail(int docId)` Retrieve Complete Audit History for a Single Document
`ObjectAuditResponse`	`retrieveObjectAuditTrail(String objectName, String recordId)` Retrieve Complete Audit History for a Single Object Record
`LogRequest`	`setAllDates(Boolean allDates)` Used to request audit information for all dates
`LogRequest`	`setEndDate(ZonedDateTime endDate)` Specify an end date to retrieve audit information.
`LogRequest`	`setFormatResult(LogRequest.FormatResultType formatResult)` The format of the returned results (JSON or CSV)
`LogRequest`	`setLimit(Integer limit)` The maximum number of results to return
`LogRequest`	`setLogDate(ZonedDateTime logDate)` The day to retrieve the API Usage log
`LogRequest`	`setLogFormat(LogRequest.LogFormatType logFormat)` Specify the format to download
`LogRequest`	`setOutputPath(String outputPath)` Specify source data in an output file
`LogRequest`	`setStartDate(ZonedDateTime startDate)` Specify a start date to retrieve audit information.

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

retrieveAuditTypes

public AuditTypesResponse retrieveAuditTypes()

Retrieve Audit Types

Retrieves all available audit types you have permission to access.

Returns:

AuditTypesResponse

Vault API Endpoint:

 GET /api/{version}/metadata/audittrail

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-audit-types

Example Request:

 AuditTypesResponse resp = vaultClient.newRequest(LogRequest.class)
                                .retrieveAuditTypes();

Example Response:

 for (AuditType a : resp.getAuditTypes()) {
   System.out.println("Name = " + a.getName());
   System.out.println("Label = " + a.getLabel());
   System.out.println("Url = " + a.getUrl());
 }

retrieveAuditMetadata

public AuditMetadataResponse retrieveAuditMetadata(LogRequest.AuditTrailType auditTrailType)

Retrieve Audit Metadata

Retrieve all fields and their metadata for a specified audit trail or log type.

Parameters:

auditTrailType - The name of the specified audit type (The AuditTrailType enum values translate to document_audit_trail, object_audit_trail, etc.).

Returns:

AuditMetadataResponse

Vault API Endpoint:

 GET /api/{version}/metadata/audittrail/{audit_trail_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-audit-metadata

Example Request:

 AuditMetadataResponse resp = vaultClient.newRequest(LogRequest.class)
                                .retrieveAuditMetadata(LogRequest.AuditTrailType.DOCUMENT);

Example Response:

 AuditMetadata metadata = resp.getData();
 System.out.println("Name = " + metadata.getName());
 System.out.println("Label = " + metadata.getLabel());

 System.out.println("Fields ****");
 for (AuditMetadata.Field f : metadata.getFields()) {
   System.out.println("**** Field **** ");
   System.out.println("Name = " + f.getName());
   System.out.println("Label = " + f.getLabel());
   System.out.println("Type = " + f.getType());
 }

retrieveAuditDetails

public <T> T retrieveAuditDetails(LogRequest.AuditTrailType auditTrailType)

Retrieve Audit Details

Retrieve audit details for a specific audit type. This request supports parameters to narrow the results to a specified date and time within the past 30 days.

NOTE: Only returns the first page; use retrieveAuditDetailsAllPages to include all pages

Type Parameters:

T - Response Type class

Parameters:

auditTrailType - The name of the specified audit type (The AuditTrailType enum values translate to document_audit_trail, object_audit_trail, etc.).

Returns:

Returns one of the following:
SystemAuditResponse when auditTrailType is system_audit_trail
LoginAuditResponse when auditTrailType is login_audit_trail
ObjectAuditResponse when auditTrailType is object_audit_trail
DomainAuditResponse when auditTrailType is domain_audit_trail
DocumentAuditResponse when auditTrailType is document_audit_response JobCreateResponse when format result is CSV

Vault API Endpoint:

 GET /api/{version}/audittrail/{audit_trail_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-audit-details

Example Request:

 Example 1 - DocumentAuditResponse
 DocumentAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setStartDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(29))
                                .setEndDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(1))
                                .setLimit(4)
                                .retrieveAuditDetails(LogRequest.AuditTrailType.DOCUMENT);

 Example 3 - DomainAuditResponse
 DomainAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setStartDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(10))
                                .retrieveAuditDetails(LogRequest.AuditTrailType.DOMAIN);

 Example 3 - LoginAuditResponse
 LoginAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setStartDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(10))
                                .retrieveAuditDetails(LogRequest.AuditTrailType.LOGIN);

 Example 4 - ObjectAuditResponse
 ObjectAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setStartDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(10))
                                .retrieveAuditDetails(LogRequest.AuditTrailType.OBJECT);

 Example 5 - JobCreateResponse
 JobCreateResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setAllDates(true)
                                .setFormatResult(LogRequest.FormatResultType.CSV)
                                .retrieveAuditDetails(LogRequest.AuditTrailType.DOMAIN);

Example Response:

 Example 1 - DocumentAuditResponse
 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (DocumentAuditData data : resp.getData()) {
   System.out.println("\n**** Data Item **** ");
   System.out.println("id = " + data.getId());
   System.out.println("timestamp = " + data.getTimestamp());
   System.out.println("UserName = " + data.getUserName());
   System.out.println("Full Name = " + data.getFullName());
   System.out.println("Action = " + data.getAction());
   System.out.println("Item = " + data.getItem());
   System.out.println("Field Name = " + data.getFieldName());
   System.out.println("Workflow Name = " + data.getWorkflowName());
   System.out.println("Task Name = " + data.getTaskName());
   System.out.println("Signature Meaning = " + data.getSignatureMeaning());
   System.out.println("View License = " + data.getViewLicense());
   System.out.println("Job Instance ID = " + data.getJobInstanceId());
   System.out.println("Doc ID = " + data.getDocId());
   System.out.println("Version = " + data.getVersion());
   System.out.println("Document Url = " + data.getDocumentUrl());
   System.out.println("Event Description = " + data.getEventDescription());
 }

 Example 2 - DomainAuditResponse
 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (DomainAuditData data : resp.getData()) {
   System.out.println("\n**** Data Item **** ");
   System.out.println("id = " + data.getId());
   System.out.println("timestamp = " + data.getTimestamp());
   System.out.println("UserId = " + data.getUserId());
   System.out.println("UserName = " + data.getUserName());
   System.out.println("Full Name = " + data.getFullName());
   System.out.println("Action = " + data.getAction());
   System.out.println("Type = " + data.getType());
   System.out.println("Item = " + data.getItem());
   System.out.println("FieldName = " + data.getFieldName());
   System.out.println("NewValue = " + data.getNewValue());
   System.out.println("EventDescription = " + data.getEventDescription());
 }

 Example 3 - LoginAuditResponse
 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (LoginAuditData data : resp.getDataw()) {
   System.out.println("\n**** Data Item **** ");
   System.out.println("id = " + data.getId());
   System.out.println("timestamp = " + data.getTimestamp());
   System.out.println("UserName = " + data.getUserName());
   System.out.println("Source IP = " + data.getSourceIp());
   System.out.println("Type = " + data.getType());
   System.out.println("Status = " + data.getStatus());
   System.out.println("Browser = " + data.getBrowser());
   System.out.println("Platform = " + data.getPlatform());
   System.out.println("Vault ID = " + data.getVaultId());
 }

 Example 4 - ObjectAuditResponse
 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (ObjectAuditData data : resp.getData()) {
   System.out.println("\n**** Data Item **** ");
   System.out.println("id = " + data.getId());
   System.out.println("timestamp = " + data.getTimestamp());
   System.out.println("UserName = " + data.getUserName());
   System.out.println("Full Name = " + data.getFullName());
   System.out.println("Action = " + data.getAction());
   System.out.println("Item = " + data.getItem());
   System.out.println("Record ID = " + data.getRecordId());
   System.out.println("Object Label = " + data.getObjectLabel());
   System.out.println("Workflow Name = " + data.getWorkflowName());
   System.out.println("Task Name = " + data.getTaskName());
   System.out.println("Verdict = " + data.getVerdict());
   System.out.println("Reason = " + data.getReason());
   System.out.println("Capacity = " + data.getCapacity());
   System.out.println("Event Description = " + data.getEventDescription());
 }

 Example 5 - JobCreateResponse
 System.out.println("Response Status = " + resp.getResponseStatus());
 System.out.println("Job ID = " + resp.getJobId());
 System.out.println("Url = " + resp.getUrl());

retrieveAuditDetailsAllPages

public <T> T retrieveAuditDetailsAllPages(LogRequest.AuditTrailType auditTrailType)

Retrieve Audit Details

Retrieve all pages of audit details for a specific audit type. This request supports parameters to narrow the results to a specified date and time within the past 30 days.

Type Parameters:

T - Response Type class

Parameters:

auditTrailType - The name of the specified audit type (The AuditTrailType enum values translate to document_audit_trail, object_audit_trail, etc.).

Returns:

Vault API Endpoint:

 GET /api/{version}/audittrail/{audit_trail_type}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-audit-details

Example Request:

 Example 1 - DocumentAuditResponse
 DocumentAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setStartDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(29))
                                .setEndDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(1))
                                .setLimit(4)
                                .retrieveAuditDetailsAllPages(LogRequest.AuditTrailType.DOCUMENT);

 Example 3 - DomainAuditResponse
 DomainAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setStartDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(10))
                                .retrieveAuditDetailsAllPages(LogRequest.AuditTrailType.DOMAIN);

 Example 3 - LoginAuditResponse
 LoginAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setStartDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(10))
                                .retrieveAuditDetailsAllPages(LogRequest.AuditTrailType.LOGIN);

 Example 4 - ObjectAuditResponse
 ObjectAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setStartDate(ZonedDateTime.now(ZoneId.of("UTC")).minusDays(10))
                                .retrieveAuditDetailsAllPages(LogRequest.AuditTrailType.OBJECT);

Example Response:

 Example 1 - DocumentAuditResponse
 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (DocumentAuditData data : resp.getData()) {
   System.out.println("\n**** Data Item **** ");
   System.out.println("id = " + data.getId());
   System.out.println("timestamp = " + data.getTimestamp());
   System.out.println("UserName = " + data.getUserName());
   System.out.println("Full Name = " + data.getFullName());
   System.out.println("Action = " + data.getAction());
   System.out.println("Item = " + data.getItem());
   System.out.println("Field Name = " + data.getFieldName());
   System.out.println("Workflow Name = " + data.getWorkflowName());
   System.out.println("Task Name = " + data.getTaskName());
   System.out.println("Signature Meaning = " + data.getSignatureMeaning());
   System.out.println("View License = " + data.getViewLicense());
   System.out.println("Job Instance ID = " + data.getJobInstanceId());
   System.out.println("Doc ID = " + data.getDocId());
   System.out.println("Version = " + data.getVersion());
   System.out.println("Document Url = " + data.getDocumentUrl());
   System.out.println("Event Description = " + data.getEventDescription());
 }

 Example 2 - DomainAuditResponse
 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (DomainAuditData data : resp.getData()) {
   System.out.println("\n**** Data Item **** ");
   System.out.println("id = " + data.getId());
   System.out.println("timestamp = " + data.getTimestamp());
   System.out.println("UserId = " + data.getUserId());
   System.out.println("UserName = " + data.getUserName());
   System.out.println("Full Name = " + data.getFullName());
   System.out.println("Action = " + data.getAction());
   System.out.println("Type = " + data.getType());
   System.out.println("Item = " + data.getItem());
   System.out.println("FieldName = " + data.getFieldName());
   System.out.println("NewValue = " + data.getNewValue());
   System.out.println("EventDescription = " + data.getEventDescription());
 }

 Example 3 - LoginAuditResponse
 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (LoginAuditData data : resp.getData()) {
   System.out.println("\n**** Data Item **** ");
   System.out.println("id = " + data.getId());
   System.out.println("timestamp = " + data.getTimestamp());
   System.out.println("UserName = " + data.getUserName());
   System.out.println("Source IP = " + data.getSourceIp());
   System.out.println("Type = " + data.getType());
   System.out.println("Status = " + data.getStatus());
   System.out.println("Browser = " + data.getBrowser());
   System.out.println("Platform = " + data.getPlatform());
   System.out.println("Vault ID = " + data.getVaultId());
 }

 Example 4 - ObjectAuditResponse
 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (ObjectAuditData data : resp.getData()) {
   System.out.println("\n**** Data Item **** ");
   System.out.println("id = " + data.getId());
   System.out.println("timestamp = " + data.getTimestamp());
   System.out.println("UserName = " + data.getUserName());
   System.out.println("Full Name = " + data.getFullName());
   System.out.println("Action = " + data.getAction());
   System.out.println("Item = " + data.getItem());
   System.out.println("Record ID = " + data.getRecordId());
   System.out.println("Object Label = " + data.getObjectLabel());
   System.out.println("Workflow Name = " + data.getWorkflowName());
   System.out.println("Task Name = " + data.getTaskName());
   System.out.println("Verdict = " + data.getVerdict());
   System.out.println("Reason = " + data.getReason());
   System.out.println("Capacity = " + data.getCapacity());
   System.out.println("Event Description = " + data.getEventDescription());
 }

retrieveAuditDetailsOffset
```
public <T> T retrieveAuditDetailsOffset(LogRequest.AuditTrailType auditTrailType,
                                        String offsetURL)
```
Retrieve Audit Details
Retrieve next or previous page of an existing audit details request
Type Parameters:

T - Response Type class

Parameters:

auditTrailType - type of audit trail

offsetURL - The offset URL from the previous_page or next_page parameter

Returns:

Returns one of the following:
SystemAuditResponse when auditTrailType is system_audit_trail
LoginAuditResponse when auditTrailType is login_audit_trail
ObjectAuditResponse when auditTrailType is object_audit_trail
DomainAuditResponse when auditTrailType is domain_audit_trail
DocumentAuditResponse when auditTrailType is document_audit_response

Vault API Endpoint:
```
 GET /api/{version}/metadata/audittrail/{audit_trail_type}?offset={val}&limit={val}&uuid={val}
```

retrieveDocumentAuditTrail

public DocumentAuditResponse retrieveDocumentAuditTrail(int docId)

Retrieve Complete Audit History for a Single Document

Retrieve complete audit history for a single document.

Parameters:

docId - The Document Id

Returns:

DocumentAuditResponse

Vault API Endpoint:

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

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-complete-audit-history-for-a-single-document

Example Request:

 DocumentAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                        .setLimit(4) // Just pull 4 records so the results can be viewed more easily
                        .setFormatResult(LogRequest.FormatResultType.JSON)
                        .retrieveDocumentAuditTrail(id);

Example Response:

 AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
 System.out.println("Offset = " + details.getOffset());
 System.out.println("Limit = " + details.getLimit());
 System.out.println("Size = " + details.getSize());
 System.out.println("Total = " + details.getTotal());
 System.out.println("Object/Name = " + details.getDetailsObject().getName());
 System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
 System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

 System.out.println("Items ****");
 for (DocumentAuditData data : resp.getData()) {
         System.out.println("\n**** Data Item **** ");
         System.out.println("id = " + data.getId());
         System.out.println("timestamp = " + data.getTimestamp());
         System.out.println("UserName = " + data.getUserName());
         System.out.println("Full Name = " + data.getFullName());
         System.out.println("Action = " + data.getAction());
         System.out.println("Item = " + data.getItem());
         System.out.println("Field Name = " + data.getFieldName());
         System.out.println("New Value = " + data.getNewValue());
         System.out.println("Workflow Name = " + data.getWorkflowName());
         System.out.println("Task Name = " + data.getTaskName());
         System.out.println("Signature Meaning = " + data.getSignatureMeaning());
         System.out.println("View License = " + data.getViewLicense());
         System.out.println("Job Instance ID = " + data.getJobInstanceId());
         System.out.println("Doc ID = " + data.getDocId());
         System.out.println("Version = " + data.getVersion());
         System.out.println("Document Url = " + data.getDocumentUrl());
         System.out.println("Event Description = " + data.getEventDescription());
 }

retrieveObjectAuditTrail

public ObjectAuditResponse retrieveObjectAuditTrail(String objectName,
                                                    String recordId)

Retrieve Complete Audit History for a Single Object Record

Retrieve Complete Audit History for a Single Object Record.

Parameters:

objectName - Object name

recordId - Object record id

Returns:

ObjectAuditResponse

Vault API Endpoint:

 GET /api/{version}/vobjects/{object_name}/{object_record_id}/audittrail

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-complete-audit-history-for-a-single-object-record

Example Request:

 ObjectAuditResponse resp = vaultClient.newRequest(LogRequest.class)
                                .setFormatResult(LogRequest.FormatResultType.JSON)
                                .retrieveObjectAuditTrail("product__v", "00P000000000601");

Example Response:

 if (resp.isSuccessful()) {
   AuditDetailsResponse.ResponseDetails details = resp.getResponseDetails();
   System.out.println("Offset = " + details.getOffset());
   System.out.println("Limit = " + details.getLimit());
   System.out.println("Size = " + details.getSize());
   System.out.println("Total = " + details.getTotal());
   System.out.println("Object/Name = " + details.getDetailsObject().getName());
   System.out.println("Object/Label = " + details.getDetailsObject().getLabel());
   System.out.println("Object/Url = " + details.getDetailsObject().getUrl());

   System.out.println("Items ****");
   for (ObjectAuditData data : resp.getData()) {
     System.out.println("\n**** Data Item **** ");
     System.out.println("id = " + data.getId());
     System.out.println("timestamp = " + data.getTimestamp());
     System.out.println("UserName = " + data.getUserName());
     System.out.println("Full Name = " + data.getFullName());
     System.out.println("Action = " + data.getAction());
     System.out.println("Item = " + data.getItem());
     System.out.println("Record ID = " + data.getRecordId());
     System.out.println("Object Label = " + data.getObjectLabel());
     System.out.println("Workflow Name = " + data.getWorkflowName());
     System.out.println("Task Name = " + data.getTaskName());
     System.out.println("Verdict = " + data.getVerdict());
     System.out.println("Reason = " + data.getReason());
     System.out.println("Capacity = " + data.getCapacity());
     System.out.println("Event Description = " + data.getEventDescription());
   }
 }

retrieveDailyAPIUsage

public VaultResponse retrieveDailyAPIUsage()

Retrieve Daily API Usage

Retrieve the API Usage Log for a single day, up to 30 days in the past. The log contains information such as user name, user ID, remaining burst and daily limits, and the endpoint called. Users with the Admin > Logs > API Usage Logs permission can access these logs.

Note that if outputFilePath is set, this method will save the output to the path specified. If outputFilePath is null or empty, the output will be stored as a byte array in the VaultResponse object. If outputFilePath is set, it must include the full file path and a file name with a .zip extension

Returns:

VaultResponse On SUCCESS, Vault retrieves the log from the specified date as a .ZIP file.

Vault API Endpoint:

 GET /api/{version}/logs/api_usage?date=YYYY-MM-DD

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-daily-api-usage

Example Request:

 Example 1 - To file
 VaultResponse response = vaultClient.newRequest(LogRequest.class)
                                .setLogDate(date)
                                .setOutputPath(outputFilePath.toString())
                                .retrieveDailyAPIUsage();

 Example 2 - To buffer
 VaultResponse response = vaultClient.newRequest(LogRequest.class)
                                .setLogDate(date)
                                .setLogFormat(LogRequest.LogFormatType.LOGFILE)
                                .setOutputPath(null)
                                .retrieveDailyAPIUsage();

Example Response:

 Example 2 - To buffer
 if (response.getResponseStatus().equals(VaultResponse.HTTP_RESPONSE_SUCCESS)) {
   try (OutputStream os = new FileOutputStream(outputFilePath.toString())) {
     os.write(response.getBinaryContent());
     System.out.println("File was saved to: " + outputFilePath.toString());
     }
   catch (IOException ignored){}
 }

setStartDate
```
public LogRequest setStartDate(ZonedDateTime startDate)
```
Specify a start date to retrieve audit information.

Parameters:

startDate - This date cannot be more than 30 days ago. If omitted, defaults to the last 30 days.

Returns:

The Request

setEndDate
```
public LogRequest setEndDate(ZonedDateTime endDate)
```
Specify an end date to retrieve audit information.

Parameters:

endDate - This date cannot be more than 30 days ago. If omitted, defaults to the last 30 days.

Returns:

The Request

setAllDates
```
public LogRequest setAllDates(Boolean allDates)
```
Used to request audit information for all dates

Parameters:

allDates - Defaults to false. Set to true to request audit information for all dates. You must leave startDate and endDate blank when requesting an export of a full audit trail.

Returns:

The Request

setFormatResult
```
public LogRequest setFormatResult(LogRequest.FormatResultType formatResult)
```
The format of the returned results (JSON or CSV)

Parameters:

formatResult - To request a downloadable CSV file of your audit details, use FormatResultType.CSV. The response contains a jobId to retrieve the job status, which contains a link to download the CSV file. If omitted, the API returns a JSON response and does not start a job. If allDates is true, this parameter is required.

Returns:

The Request

setLimit
```
public LogRequest setLimit(Integer limit)
```
The maximum number of results to return

Parameters:

limit - Limits the number of results (default is 200). For larger sets, consider using CSV.

Returns:

The Request

setLogDate
```
public LogRequest setLogDate(ZonedDateTime logDate)
```
The day to retrieve the API Usage log

Parameters:

logDate - Date is in UTC and follows the format YYYY-MM-DD. Date cannot be more than 30 days in the past.

Returns:

The Request

setLogFormat
```
public LogRequest setLogFormat(LogRequest.LogFormatType logFormat)
```
Specify the format to download

Parameters:

logFormat - Possible values are csv or logfile. If omitted, defaults to csv. Note that this call always downloads a ZIP file. This parameter only changes the format of the file contained within the ZIP.

Returns:

The Request

setOutputPath
```
public LogRequest setOutputPath(String outputPath)
```
Specify source data in an output file

Parameters:

outputPath - Absolute path to the file for the response

Returns:

The Request

Class LogRequest

Nested Class Summary

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

retrieveAuditTypes

retrieveAuditMetadata

retrieveAuditDetails

retrieveAuditDetailsAllPages

retrieveAuditDetailsOffset

retrieveDocumentAuditTrail

retrieveObjectAuditTrail

retrieveDailyAPIUsage

setStartDate

setEndDate

setAllDates

setFormatResult

setLimit

setLogDate

setLogFormat

setOutputPath