com.veeva.vault.vapil.api.request

Class MultiDocumentWorkflowsRequest

java.lang.Object

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

com.veeva.vault.vapil.api.request.MultiDocumentWorkflowsRequest

public class MultiDocumentWorkflowsRequest
extends VaultRequest

The API allows you to retrieve, manage, and initiate multi-document workflows.

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#retrieve-all-multi-document-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
InitiateMultiDocumentWorkflowResponse	initiateMultiDocumentWorkflow(String workflowName, List<String> documents, Map<String,String> participantName, String description) Initiate Multi-Document Workflow Initiate a multi-document workflow on a set of documents.
MultiDocumentWorkflowsResponse	retrieveAllMultiDocumentWorkflows() Retrieve All Multi-Document Workflows Retrieve all available multi-document workflows that can be initiated on a set of documents
MultiDocumentWorkflowDetailsResponse	retrieveMultiDocumentWorkflowDetails(String workflowName) Retrieve Multi-Document Workflow Details Retrieves the details for a specific multi-document workflow.
MultiDocumentWorkflowsRequest	setAcceptJSON() Set the Header Accept to return JSON
MultiDocumentWorkflowsRequest	setLoc(Boolean loc) When localized (translated) strings are available, retrieve them by setting loc to true

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

retrieveAllMultiDocumentWorkflows

public MultiDocumentWorkflowsResponse retrieveAllMultiDocumentWorkflows()

Retrieve All Multi-Document Workflows
Retrieve all available multi-document workflows that can be initiated on a set of documents

Returns:

MultiDocumentWorkflowsResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/actions

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-all-multi-document-workflows

Example Request:

 MultiDocumentWorkflowsResponse resp = vaultClient.newRequest(MultiDocumentWorkflowsRequest.class)
                                .retrieveAllMultiDocumentWorkflows();

Example Response:

 if (resp.getData() != null) {
   for (MultiDocWorkflow workflow : resp.getData()) {
     System.out.println("------------------------------");
     System.out.println("Name " + workflow.getName());
     System.out.println("Label " + workflow.getLabel());
     System.out.println("Type " + workflow.getType());
     }
 }

retrieveMultiDocumentWorkflowDetails

public MultiDocumentWorkflowDetailsResponse retrieveMultiDocumentWorkflowDetails(String workflowName)

Retrieve Multi-Document Workflow Details
Retrieves the details for a specific multi-document workflow.

Parameters:

workflowName - The multi-document workflow name value. Obtained from the Retrieve All MultiDocument Workflows request retrieveAllMultiDocumentWorkflows()

Returns:

MultiDocumentWorkflowDetailsResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/actions/{workflow_name}

Vault API Help Link:

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

Example Request:

 MultiDocumentWorkflowDetailsResponse resp = vaultClient.newRequest(MultiDocumentWorkflowsRequest.class)
                                .retrieveMultiDocumentWorkflowDetails(workflowName);

Example Response:

 if (resp.getData() != null) {
   MultiDocumentWorkflowDetailsResponse.MultiDocumentWorkflow workflow = resp.getData();
   System.out.println("Workflow Name " + workflow.getName());
   System.out.println("------------------------------");
   for (Control con : workflow.getControls()) {
     System.out.println("Control Exist\n");
     System.out.println("------------------------------");
     System.out.println("Control Instruction " + con.getInstructions());
     System.out.println("Control Label " + con.getLabel());
     System.out.println("Control Type " + con.getType());

     for (Prompt prompts : con.getPrompts()) {
       System.out.println("\tPrompts Exist\n");
       System.out.println("------------------------------");
       System.out.println("\tPrompt Lable " + prompts.getLabel());
       System.out.println("\tPrompt Name " + prompts.getName());
       System.out.println("\tPrompt Multivalue " + prompts.getMultiValue());

     }
   }
 }
 

initiateMultiDocumentWorkflow

public InitiateMultiDocumentWorkflowResponse initiateMultiDocumentWorkflow(String workflowName,
                                                                           List<String> documents,
                                                                           Map<String,String> participantName,
                                                                           String description)

Initiate Multi-Document Workflow
Initiate a multi-document workflow on a set of documents. If any document is not in the relevant state or does not meet configured field conditions, the API returns INVALID_DATA for the invalid documents and the workflow does not start.

Parameters:

workflowName - The multi-document workflow name value. Obtained from the Retrieve All MultiDocument Workflows request retrieveAllMultiDocumentWorkflows()

documents - Input a comma-separated list of document id field values.

participantName - Enter the participant name and input the user or group id value. For example, approvers__c: user:123,group:234.

description - Description of the workflow. Maximum 1,000 characters.

Returns:

InitiateMultiDocumentWorkflowsResponse

Vault API Endpoint:

 POST /api/{version}/objects/documents/actions/{workflow_name}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#initiate-multi-document-workflow

Example Request:

 InitiateMultiDocumentWorkflowResponse resp = vaultClient.newRequest(MultiDocumentWorkflowsRequest.class)
                                                .initiateMultiDocumentWorkflow(workflowName, documents,participantName,description);

Example Response:

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

 if (resp.isSuccessful()) {
   System.out.println("Record ID " + resp.getData().getRecordId());
   System.out.println("Record URL " + resp.getData().getRecordUrl());
   System.out.println("Workflow ID " + resp.getData().getWorkflowId());
 }

setLoc

public MultiDocumentWorkflowsRequest setLoc(Boolean loc)

When localized (translated) strings are available, retrieve them by setting loc to true

Parameters:

loc - Set to true to retrieve localized (translated) strings (if available)

Returns:

The request

setAcceptJSON

public MultiDocumentWorkflowsRequest setAcceptJSON()

Set the Header Accept to return JSON

Returns:

The Request