Package com.docusign.maestro.api

Class WorkflowTriggerApi

java.lang.Object

com.docusign.maestro.api.WorkflowTriggerApi

public class WorkflowTriggerApi
extends Object

WorkflowTriggerApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WorkflowTriggerApi.TriggerWorkflowOptions	TriggerWorkflowOptions Class.

Constructor Summary

Constructors

Constructor	Description
WorkflowTriggerApi()	WorkflowTriggerApi.
WorkflowTriggerApi(ApiClient apiClient)	WorkflowTriggerApi.

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	getApiClient Method.
void	setApiClient(ApiClient apiClient)	setApiClient Method.
TriggerWorkflowViaPostResponse	triggerWorkflow(String accountId, String workflowDefinitionId, TriggerPayload body)	Creates a new workflow instance after authenticating with DS Account Server.
TriggerWorkflowViaPostResponse	triggerWorkflow(String accountId, String workflowDefinitionId, TriggerPayload body, WorkflowTriggerApi.TriggerWorkflowOptions options)	Creates a new workflow instance after authenticating with DS Account Server.
ApiResponse<TriggerWorkflowViaPostResponse>	triggerWorkflowWithHttpInfo(String accountId, String workflowDefinitionId, TriggerPayload body, WorkflowTriggerApi.TriggerWorkflowOptions options)	Creates a new workflow instance after authenticating with DS Account Server Creates a new workflow instance after authenticating with DS Account Server

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowTriggerApi

public WorkflowTriggerApi()

WorkflowTriggerApi.

WorkflowTriggerApi

public WorkflowTriggerApi(ApiClient apiClient)

WorkflowTriggerApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

triggerWorkflow

public TriggerWorkflowViaPostResponse triggerWorkflow(String accountId,
                                                      String workflowDefinitionId,
                                                      TriggerPayload body)
                                               throws ApiException

Creates a new workflow instance after authenticating with DS Account Server. Creates a new workflow instance after authenticating with DS Account Server

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

body - JSON payload that will be passed to the triggered workflow (required)

Returns:

TriggerWorkflowViaPostResponse

Throws:

ApiException

triggerWorkflow

public TriggerWorkflowViaPostResponse triggerWorkflow(String accountId,
                                                      String workflowDefinitionId,
                                                      TriggerPayload body,
                                                      WorkflowTriggerApi.TriggerWorkflowOptions options)
                                               throws ApiException

Creates a new workflow instance after authenticating with DS Account Server. Creates a new workflow instance after authenticating with DS Account Server

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

body - JSON payload that will be passed to the triggered workflow (required)

options - for modifying the method behavior.

Returns:

TriggerWorkflowViaPostResponse

Throws:

ApiException - if fails to make API call

triggerWorkflowWithHttpInfo

public ApiResponse<TriggerWorkflowViaPostResponse> triggerWorkflowWithHttpInfo(String accountId,
                                                                               String workflowDefinitionId,
                                                                               TriggerPayload body,
                                                                               WorkflowTriggerApi.TriggerWorkflowOptions options)
                                                                        throws ApiException

Creates a new workflow instance after authenticating with DS Account Server Creates a new workflow instance after authenticating with DS Account Server

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

body - JSON payload that will be passed to the triggered workflow (required)

options - for modifying the method behavior.

Returns:

TriggerWorkflowViaPostResponse

Throws:

ApiException - if fails to make API call