Package com.docusign.maestro.api

Class WorkflowInstanceManagementApi

java.lang.Object

com.docusign.maestro.api.WorkflowInstanceManagementApi

public class WorkflowInstanceManagementApi
extends Object

WorkflowInstanceManagementApi class.

Constructor Summary

Constructors

Constructor	Description
WorkflowInstanceManagementApi()	WorkflowInstanceManagementApi.
WorkflowInstanceManagementApi(ApiClient apiClient)	WorkflowInstanceManagementApi.

Method Summary

Modifier and Type	Method	Description
CancelResponse	cancelWorkflowInstance(String accountId, String instanceId)	Cancels a running workflow instance..
ApiResponse<CancelResponse>	cancelWorkflowInstanceWithHttpInfo(String accountId, String instanceId)	Cancels a running workflow instance.
ApiClient	getApiClient()	getApiClient Method.
List<WorkflowStepHistory>	getWorkflowHistory(String accountId, String instanceId)	Get List of Step Histories.
ApiResponse<List<WorkflowStepHistory>>	getWorkflowHistoryWithHttpInfo(String accountId, String instanceId)	Get List of Step Histories Returns a list of step history for a workflow instance
WorkflowInstance	getWorkflowInstance(String accountId, String workflowDefinitionId, String instanceId)	Get Workflow Instance Details.
List<WorkflowInstance>	getWorkflowInstances(String accountId, String workflowDefinitionId)	Get List of Workflow Instances.
ApiResponse<List<WorkflowInstance>>	getWorkflowInstancesWithHttpInfo(String accountId, String workflowDefinitionId)	Get List of Workflow Instances Returns the list of instances for a deployed workflow definition.
ApiResponse<WorkflowInstance>	getWorkflowInstanceWithHttpInfo(String accountId, String workflowDefinitionId, String instanceId)	Get Workflow Instance Details Returns the details for a specific instance for a deployed workflow definition.
void	setApiClient(ApiClient apiClient)	setApiClient Method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowInstanceManagementApi

public WorkflowInstanceManagementApi()

WorkflowInstanceManagementApi.

WorkflowInstanceManagementApi

public WorkflowInstanceManagementApi(ApiClient apiClient)

WorkflowInstanceManagementApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

cancelWorkflowInstance

public CancelResponse cancelWorkflowInstance(String accountId,
                                             String instanceId)
                                      throws ApiException

Cancels a running workflow instance.. Cancels a running workflow instance.

Parameters:

accountId - Account ID (required)

instanceId - DS Workflow Instance Id (dacId) (required)

Returns:

CancelResponse

Throws:

ApiException - if fails to make API call

cancelWorkflowInstanceWithHttpInfo

public ApiResponse<CancelResponse> cancelWorkflowInstanceWithHttpInfo(String accountId,
                                                                      String instanceId)
                                                               throws ApiException

Cancels a running workflow instance. Cancels a running workflow instance.

Parameters:

accountId - Account ID (required)

instanceId - DS Workflow Instance Id (dacId) (required)

Returns:

CancelResponse

Throws:

ApiException - if fails to make API call

getWorkflowHistory

public List<WorkflowStepHistory> getWorkflowHistory(String accountId,
                                                    String instanceId)
                                             throws ApiException

Get List of Step Histories. Returns a list of step history for a workflow instance

Parameters:

accountId - Account ID (required)

instanceId - DS Workflow Instance Id (dacId) (required)

Returns:

java.util.List

Throws:

ApiException - if fails to make API call

getWorkflowHistoryWithHttpInfo

public ApiResponse<List<WorkflowStepHistory>> getWorkflowHistoryWithHttpInfo(String accountId,
                                                                             String instanceId)
                                                                      throws ApiException

Get List of Step Histories Returns a list of step history for a workflow instance

Parameters:

accountId - Account ID (required)

instanceId - DS Workflow Instance Id (dacId) (required)

Returns:

java.util.List

Throws:

ApiException - if fails to make API call

getWorkflowInstance

public WorkflowInstance getWorkflowInstance(String accountId,
                                            String workflowDefinitionId,
                                            String instanceId)
                                     throws ApiException

Get Workflow Instance Details. Returns the details for a specific instance for a deployed workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

instanceId - DS Workflow Instance Id (dacId) (required)

Returns:

WorkflowInstance

Throws:

ApiException - if fails to make API call

getWorkflowInstanceWithHttpInfo

public ApiResponse<WorkflowInstance> getWorkflowInstanceWithHttpInfo(String accountId,
                                                                     String workflowDefinitionId,
                                                                     String instanceId)
                                                              throws ApiException

Get Workflow Instance Details Returns the details for a specific instance for a deployed workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

instanceId - DS Workflow Instance Id (dacId) (required)

Returns:

WorkflowInstance

Throws:

ApiException - if fails to make API call

getWorkflowInstances

public List<WorkflowInstance> getWorkflowInstances(String accountId,
                                                   String workflowDefinitionId)
                                            throws ApiException

Get List of Workflow Instances. Returns the list of instances for a deployed workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

Returns:

java.util.List

Throws:

ApiException - if fails to make API call

getWorkflowInstancesWithHttpInfo

public ApiResponse<List<WorkflowInstance>> getWorkflowInstancesWithHttpInfo(String accountId,
                                                                            String workflowDefinitionId)
                                                                     throws ApiException

Get List of Workflow Instances Returns the list of instances for a deployed workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

Returns:

java.util.List

Throws:

ApiException - if fails to make API call