com.veeva.vault.vapil.api.request

Class DocumentLifecycleWorkflowRequest

java.lang.Object

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

com.veeva.vault.vapil.api.request.DocumentLifecycleWorkflowRequest

public class DocumentLifecycleWorkflowRequest
extends VaultRequest

Document Lifecycle and Workflow requests

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#document-lifecycle-amp-workflows

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	bulkDocumentStateChange(DocumentRequestType requestType, String userActionName, String docIds) Bulk Document State Change.
DocumentLifecycleRoleAssignmentRulesResponse	createOverrideRules() Create Override Rules
DocumentLifecycleDeleteOverrideRulesResponse	deleteOverrideRules() Delete Override Rules
DocumentLifecycleDeleteOverrideRulesResponse	deleteOverrideRules(String lifecycleName, String role) Delete Override Rules
VaultResponse	downloadControlledCopyJobResult(String lifecycleStateAction, int jobId) Download Controlled Copy Job Results.
DocumentActionInitiateResponse	initiateUserAction(DocumentRequestType requestType, int id, int majorVersionNumber, int minorVersionNumber, String userActionName) Initiate User Action
DocumentWorkflowMetadataResponse	retrieveDocumentWorkflowMetadata() Retrieve Document Workflow Metadata.
DocumentActionEntryCriteriaResponse	retrieveEntryCriteria(DocumentRequestType requestType, int id, int majorVersion, int minorVersion, String lifecycleName) Retrieve the entry criteria for a workflow.
DocumentLifecycleRoleAssignmentResponse	retrieveLifecycleRoleAssignmentRules() Retrieve Lifecycle Role Assignment Rules (Default & Override)
DocumentActionResponse	retrieveUserActions(DocumentRequestType requestType, int id, int majorVersionNumber, int minorVersionNumber) Retrieve User Actions
DocumentActionResponse	retrieveUserActionsOnMultiDocumentsBinders(DocumentRequestType requestType, String docIds, String majorVersion, String minorVersion) Retrieve user action multiple documents or binders
DocumentLifecycleWorkflowRequest	setBinaryFile(String filename, byte[] binaryContent) Specify source data in an input file
DocumentLifecycleWorkflowRequest	setBodyParams(Map<String,Object> bodyParams) Single record form ObjectRecordRequest with name/value body parameters
DocumentLifecycleWorkflowRequest	setContentTypeCsv() Set the Header Content Type to CSV
DocumentLifecycleWorkflowRequest	setContentTypeJson() Set the Header Content Type to JSON
DocumentLifecycleWorkflowRequest	setCountryID(String countryID) Set country id to the request
DocumentLifecycleWorkflowRequest	setCountryName(String countryName) Set country name to the request
DocumentLifecycleWorkflowRequest	setDocumentState(String documentState) Set document state name to the request
DocumentLifecycleWorkflowRequest	setInputPath(String inputPath) Specify source data in an input file
DocumentLifecycleWorkflowRequest	setLifecycleName(String lifecycleName) Set lifecycle name to the request
DocumentLifecycleWorkflowRequest	setProductName(String productName) Set product name to the request
DocumentLifecycleWorkflowRequest	setQueryParams(Map<String,Object> queryParams) Single record form ObjectRecordRequest with name/value body parameters
DocumentLifecycleWorkflowRequest	setRequestString(String requestString) Specify source data in an input string, such as a JSON request
DocumentLifecycleWorkflowRequest	setRoleName(String roleName) Set role name (role__v) to the request
DocumentLifecycleRoleAssignmentRulesResponse	updateOverrideRules() Update Override Rules

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

retrieveUserActions

public DocumentActionResponse retrieveUserActions(DocumentRequestType requestType,
                                                  int id,
                                                  int majorVersionNumber,
                                                  int minorVersionNumber)

Retrieve User Actions

Parameters:

requestType - documents or binders

id - document or binder id

majorVersionNumber - major version number

minorVersionNumber - major version number

Returns:

DocumentActionResponse

Vault API Endpoint:

 GET /api/{version}/objects/{documents_or_binders}/{id}/versions/{major_version}/{minor_version}/lifecycle_actions

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-user-actions

Example Request:

 DocumentActionResponse resp = vaultClient.newRequest(DocumentLifecycleWorkflowRequest.class).retrieveUserActions(
                                DocumentRequestType.DOCUMENTS, docId, majorVersion, minorVersion);

Example Response:

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

 if (resp.isSuccessful()) {
   for (DocumentActionResponse.LifecycleAction action : resp.getLifecycleActions()) {
     System.out.println("Label = " + action.getLabel());
     System.out.println("Name = " + action.getName());
     }
   }
 

initiateUserAction

public DocumentActionInitiateResponse initiateUserAction(DocumentRequestType requestType,
                                                         int id,
                                                         int majorVersionNumber,
                                                         int minorVersionNumber,
                                                         String userActionName)

Initiate User Action

Parameters:

requestType - documents or binders

id - document or binder id

majorVersionNumber - major version number

minorVersionNumber - major version number

userActionName - api name of the useraction

Returns:

DocumentActionInitiateResponse

Vault API Endpoint:

 PUT /api/{version}/objects/{documents_or_binders}/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#initiate-user-action

Example Request:

 DocumentActionInitiateResponse resp = vaultClient.newRequest(DocumentLifecycleWorkflowRequest.class).initiateUserAction(
                                DocumentRequestType.DOCUMENTS, docId, majorVersion, minorVersion, useraction);

Example Response:

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

 if (resp.isSuccessful()) {
   System.out.println("id = " + resp.getId());
   }
 

retrieveUserActionsOnMultiDocumentsBinders

public DocumentActionResponse retrieveUserActionsOnMultiDocumentsBinders(DocumentRequestType requestType,
                                                                         String docIds,
                                                                         String majorVersion,
                                                                         String minorVersion)

Retrieve user action multiple documents or binders

Parameters:

requestType - documents or binders

docIds - Include a comma-separated list of document or binder IDs, major and minor version numbers. The document or binder docIds field values from which to retrieve the available user actions. e.g. "docIds=22:0:1,21:1:0,20:1:0

majorVersion - The major version number of the document or binder.

minorVersion - The minor version number of the document or binder.

Returns:

DocumentActionResponse

Vault API Endpoint:

 POST /api/{version}/objects/{documents_or_binders}/lifecycle_actions

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-user-actions-on-multiple-documents-or-binders

Example Request:

 DocumentActionResponse resp = vaultClient.newRequest(DocumentLifecycleWorkflowRequest.class)
                                .retrieveUserActionsOnMultiDocumentsBinders(DocumentRequestType.DOCUMENTS,
                                                docIds, majorVersion, minorVersion);

Example Response:

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

 if (resp.isSuccessful()) {
   System.out.println("Successful ");
   List<LifecycleAction> list = resp.getLifecycleActions();

   for (LifecycleAction lcAction : list) {
     System.out.println("Get Name:" + lcAction.getName());
     System.out.println("Get Label:" + lcAction.getLabel());
     System.out.println("Get Lifecycle:" + lcAction.getLifecycle());
     System.out.println("Get Lifecycle:" + lcAction.getLifecycleActionType());
     System.out.println("Get Lifecycle:" + lcAction.getState());
     System.out.println("Get Lifecycle:" + lcAction.getEntryRequirements());
     }
   }
 }
 

retrieveEntryCriteria

public DocumentActionEntryCriteriaResponse retrieveEntryCriteria(DocumentRequestType requestType,
                                                                 int id,
                                                                 int majorVersion,
                                                                 int minorVersion,
                                                                 String lifecycleName)

Retrieve the entry criteria for a workflow.

Parameters:

requestType - Choose to retrieve values for documents or binders.

id - The document or binder id field value from which to retrieve available user actions.

majorVersion - The major version number of the document or binder.

minorVersion - The minor version number of the document or binder.

lifecycleName - The lifecycle name__v field value from which to retrieve entry criteria. This is retrieved from the Retrieve User Actions request above.

Returns:

DocumentActionEntryCriteriaResponse

Vault API Endpoint:

 GET /api/{version}/objects/{documents_or_binders}/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}/entry_requirements

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-entry-criteria

Example Request:

 DocumentActionEntryCriteriaResponse resp = vaultClient.newRequest(DocumentLifecycleWorkflowRequest.class)
                                .retrieveEntryCriteria(DocumentRequestType.DOCUMENTS, id, majorVersion,
                                                minorVersion, lifecycleName);

Example Response:

System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("Successful ");
   List<Property> properties = resp.getProperties();

   for (Property property : properties) {
     System.out.println("Get Name:" + property.getName());
     System.out.println("Get Label:" + property.getDescription());
     System.out.println("Get Lifecycle:" + property.getScope());
     }
   }
 }
 

downloadControlledCopyJobResult

public VaultResponse downloadControlledCopyJobResult(String lifecycleStateAction,
                                                     int jobId)

Download Controlled Copy Job Results.

Parameters:

lifecycleStateAction - The name__v values for the lifecycle, state, and action. We recommend you Retrieve the Job Status and use the href under "rel": "artifacts" to obtain this value.

jobId - The ID of the job, returned from the original job request. For controlled copy, you can find this ID in the Initiate User Action response.

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/actions/{lifecycle.state.action}/{job_id}/results

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#download-controlled-copy-job-results

bulkDocumentStateChange

public VaultResponse bulkDocumentStateChange(DocumentRequestType requestType,
                                             String userActionName,
                                             String docIds)

Bulk Document State Change.

Parameters:

requestType - documents or binders

docIds - Include a comma-separated list of document or binder IDs, major and minor version numbers. The document or binder docIds field values from which to retrieve the available user actions. e.g. "docIds=22:0:1,21:1:0,20:1:0

userActionName - The user action name__v field value. Find this value with the Retrieve User Actions on Multiple Documents or Binders endpoint.

Returns:

VaultResponse

Vault API Endpoint:

 PUT /api/{version}/objects/{documents_or_binders}/lifecycle_actions/{user_action_name}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#bulk-document-state-change

retrieveDocumentWorkflowMetadata

public DocumentWorkflowMetadataResponse retrieveDocumentWorkflowMetadata()

Retrieve Document Workflow Metadata.

Returns:

DocumentWorkflowMetadataResponse

Vault API Endpoint:

 GET /api/{version}/metadata/objects/workflows

Vault API Help Link:

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

retrieveLifecycleRoleAssignmentRules

public DocumentLifecycleRoleAssignmentResponse retrieveLifecycleRoleAssignmentRules()

Retrieve Lifecycle Role Assignment Rules (Default & Override)

Returns:

DocumentLifecycleRoleAssignmentResponse

Vault API Endpoint:

 GET /api/{version}/configuration/role_assignment_rule

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-lifecycle-role-assignment-rules-default-amp-override

Example Request:

 DocumentLifecycleRoleAssignmentResponse resp = vaultClient.newRequest(DocumentLifecycleWorkflowRequest.class)
                                .setLifecycleName("general_lifecycle1__c").setRoleName("all_users__v")
                                .retrieveLifecycleRoleAssignmentRules();

,

 DocumentLifecycleRoleAssignmentResponse resp = vaultClient.newRequest(DocumentLifecycleWorkflowRequest.class)
                                .setQueryParams(hm)
                                .retrieveLifecycleRoleAssignmentRules(withOverride);

Example Response:

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

 if (resp.isSuccessful()) {
   System.out.println("Successful ");
   List<RoleAssignmentResponse> roleAssigmentRes = resp.getRoleAssignmentResponse();

   for (RoleAssignmentResponse roleAssigment : roleAssigmentRes) {
     System.out.println("Get Lifecycle Name:" + roleAssigment.getLifecycle());
     System.out.println("Get Role Name:" + roleAssigment.getRole());
     List<String> allowedGroups = roleAssigment.getAllowedGroups();
     for (String groups : allowedGroups) {
       System.out.println("Get allowed Groups:" + groups);
     }
   }
 }

,

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

 if (resp.isSuccessful()) {
   System.out.println("Successful ");
   List<RoleAssignmentResponse> roleAssigmentRes = resp.getRoleAssignmentResponse();

   for (RoleAssignmentResponse roleAssigment : roleAssigmentRes) {
     System.out.println("Get Lifecycle Name:" + roleAssigment.getLifecycle());
     System.out.println("Get Role Name:" + roleAssigment.getRole());
     List<String> allowedGroups = roleAssigment.getAllowedGroups();
     for (String groups : allowedGroups) {
       System.out.println("Get allowed Groups:" + groups);
       }
   }
 }

createOverrideRules

public DocumentLifecycleRoleAssignmentRulesResponse createOverrideRules()

Create Override Rules

Returns:

LifecycleRoleAssignmentRulesResponse

Vault API Endpoint:

 POST /api/{version}/configuration/role_assignment_rule

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#create-override-rules

Example Request:

 .newRequest(DocumentLifecycleWorkflowRequest.class).setInputPath(csvFilePath).createOverrideRules();

Example Response:

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

 if (bulkPathResponse.isSuccessful()) {
   System.out.println("Successful ");
   }

 DocumentLifecycleRoleAssignmentRulesResponse bulkByteResponse = vaultClient
 .newRequest(DocumentLifecycleWorkflowRequest.class)
 .setBinaryFile(csv.getName(), Files.readAllBytes(csv.toPath())).createOverrideRules();
 System.out.println(bulkByteResponse.getResponse());

 if (bulkByteResponse.isSuccessful()) {
   System.out.println("Successful ");
   }

 } catch (Exception e) {
 e.printStackTrace();
 }

updateOverrideRules

public DocumentLifecycleRoleAssignmentRulesResponse updateOverrideRules()

Update Override Rules

Returns:

LifecycleRoleAssignmentRulesResponse

Vault API Endpoint:

 PUT /api/{version}/configuration/role_assignment_rule

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#update-override-rules

Example Request:

 .newRequest(DocumentLifecycleWorkflowRequest.class).setInputPath(csvFilePath).updateOverrideRules();

Example Response:

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

 if (updateOverrideRulesResponse.isSuccessful()) {
   System.out.println("Successful ");
   }
 } catch (Exception e) {
 e.printStackTrace();
 }

deleteOverrideRules

public DocumentLifecycleDeleteOverrideRulesResponse deleteOverrideRules(String lifecycleName,
                                                                        String role)

Delete Override Rules

Parameters:

lifecycleName - Include the name of the lifecycle from which to delete override rules. For example: lifecycle__v=general_lifecycle__c

role - Include the name of the role from which to delete override rules. For example: role__v=editor__c

Returns:

DocumentLifecycleDeleteOverrideRulesResponse

Vault API Endpoint:

 DELETE /api/{version}/configuration/role_assignment_rule

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#update-override-rules

Example Request:

 .newRequest(DocumentLifecycleWorkflowRequest.class)
                                        .deleteOverrideRules(lifecycle, role);

,

 .newRequest(DocumentLifecycleWorkflowRequest.class)
                                        .setQueryParams(hm).deleteOverrideRules();

Example Response:

System.out.println(deleteOverrideRulesResponse.getResponse());
 if (deleteOverrideRulesResponse != null) {
   if (deleteOverrideRulesResponse.getData() != null) {
     System.out.println("Rules Deleted:" + deleteOverrideRulesResponse.getData().getRulesDeleted());
     }else {
     System.out.println("INVALID_DATA");
     }
   }
 } catch (Exception e) {
 e.printStackTrace();
 }
 

,

System.out.println(deleteOverrideRulesResponse.getResponse());
 if (deleteOverrideRulesResponse != null) {
   if (deleteOverrideRulesResponse.getData() != null) {
     System.out.println("Rules Deleted:" + deleteOverrideRulesResponse.getData().getRulesDeleted());
     }else {
     System.out.println("INVALID_DATA");
     }
   }
 } catch (Exception e) {
 e.printStackTrace();
 }

deleteOverrideRules

public DocumentLifecycleDeleteOverrideRulesResponse deleteOverrideRules()

Delete Override Rules

Returns:

DocumentLifecycleDeleteOverrideRulesResponse

Vault API Endpoint:

 DELETE /api/{version}/configuration/role_assignment_rule

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#delete-override-rules

setBodyParams

public DocumentLifecycleWorkflowRequest setBodyParams(Map<String,Object> bodyParams)

Single record form ObjectRecordRequest with name/value body parameters

Parameters:

bodyParams - map of body params

Returns:

The Request

setQueryParams

public DocumentLifecycleWorkflowRequest setQueryParams(Map<String,Object> queryParams)

Single record form ObjectRecordRequest with name/value body parameters

Parameters:

queryParams - map of query params

Returns:

The Request

setBinaryFile

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

setContentTypeCsv

public DocumentLifecycleWorkflowRequest setContentTypeCsv()

Set the Header Content Type to CSV

Returns:

The Request

setRequestString

public DocumentLifecycleWorkflowRequest setRequestString(String requestString)

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

Parameters:

requestString - The source request as a string

Returns:

The Request

setContentTypeJson

public DocumentLifecycleWorkflowRequest setContentTypeJson()

Set the Header Content Type to JSON

Returns:

The Request

setDocumentState

public DocumentLifecycleWorkflowRequest setDocumentState(String documentState)

Set document state name to the request

Parameters:

documentState - name of document state

Returns:

The Request

setLifecycleName

public DocumentLifecycleWorkflowRequest setLifecycleName(String lifecycleName)

Set lifecycle name to the request

Parameters:

lifecycleName - name of lifecycle

Returns:

The Request

setRoleName

public DocumentLifecycleWorkflowRequest setRoleName(String roleName)

Set role name (role__v) to the request

Parameters:

roleName - name of role

Returns:

The Request

setProductName

public DocumentLifecycleWorkflowRequest setProductName(String productName)

Set product name to the request

Parameters:

productName - name of product

Returns:

The Request

setCountryName

public DocumentLifecycleWorkflowRequest setCountryName(String countryName)

Set country name to the request

Parameters:

countryName - name of country

Returns:

The Request

setCountryID

public DocumentLifecycleWorkflowRequest setCountryID(String countryID)

Set country id to the request

Parameters:

countryID - id of country

Returns:

The Request

setInputPath

public DocumentLifecycleWorkflowRequest setInputPath(String inputPath)

Specify source data in an input file

Parameters:

inputPath - Absolute path to the file for the request

Returns:

The Request