Package com.veeva.vault.sdk.api.workflow

Interface WorkflowMetadataService

All Superinterfaces:

Service

public interface WorkflowMetadataService
extends Service

Provides methods to interact with workflow metadata.

Method Summary

Modifier and Type	Method	Description
AvailableWorkflowMetadataCollectionResponse	getAvailableWorkflows(AvailableWorkflowMetadataCollectionRequest request)	Retrieves a list of available workflows for the given documents or record IDs.
WorkflowStartMetadataResponse	getWorkflowStartMetadata(WorkflowStartMetadataRequest request)	Retrieves the workflow start metadata on the given workflow name and list of documents or record IDs.
AvailableWorkflowMetadataCollectionRequest.Builder	newAvailableWorkflowMetadataCollectionRequestBuilder()	Creates an AvailableWorkflowMetadataCollectionRequest.Builder.
WorkflowStartMetadataRequest.Builder	newWorkflowStartMetadataRequestBuilder()	Creates a WorkflowStartMetadataRequest.Builder.

Method Details

newAvailableWorkflowMetadataCollectionRequestBuilder

AvailableWorkflowMetadataCollectionRequest.Builder newAvailableWorkflowMetadataCollectionRequestBuilder()

Creates an AvailableWorkflowMetadataCollectionRequest.Builder.

Returns:

an AvailableWorkflowMetadataCollectionRequest.Builder

getAvailableWorkflows

AvailableWorkflowMetadataCollectionResponse getAvailableWorkflows(AvailableWorkflowMetadataCollectionRequest request)

Retrieves a list of available workflows for the given documents or record IDs.

Parameters:

request - the AvailableWorkflowMetadataCollectionRequest containing the information needed to retrieve the list of available workflows. Cannot be null.

Returns:

an AvailableWorkflowMetadataCollectionResponse containing the list of available workflows

newWorkflowStartMetadataRequestBuilder

WorkflowStartMetadataRequest.Builder newWorkflowStartMetadataRequestBuilder()

Creates a WorkflowStartMetadataRequest.Builder.

Returns:

a WorkflowStartMetadataRequest.Builder

getWorkflowStartMetadata

WorkflowStartMetadataResponse getWorkflowStartMetadata(WorkflowStartMetadataRequest request)

Retrieves the workflow start metadata on the given workflow name and list of documents or record IDs.

Parameters:

request - the WorkflowStartMetadataRequest containing the information needed to retrieve the workflow start details. Requires the workflow name and list of document or record IDs. Cannot be null.

Returns:

a WorkflowStartMetadataResponse containing workflow start details