com.docdoku.api.services

Class WorkflowsApi

java.lang.Object

com.docdoku.api.services.WorkflowsApi

public class WorkflowsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WorkflowsApi()
WorkflowsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<WorkflowDTO>	getWorkflowAbortedWorkflowList(String workspaceId, Integer workflowId) Get workflow's aborted workflow list
com.squareup.okhttp.Call	getWorkflowAbortedWorkflowListAsync(String workspaceId, Integer workflowId, ApiCallback<List<WorkflowDTO>> callback) Get workflow's aborted workflow list (asynchronously)
ApiResponse<List<WorkflowDTO>>	getWorkflowAbortedWorkflowListWithHttpInfo(String workspaceId, Integer workflowId) Get workflow's aborted workflow list
WorkflowDTO	getWorkflowInstance(String workspaceId, Integer workflowId) Get instantiated workflow in workspace
com.squareup.okhttp.Call	getWorkflowInstanceAsync(String workspaceId, Integer workflowId, ApiCallback<WorkflowDTO> callback) Get instantiated workflow in workspace (asynchronously)
ApiResponse<WorkflowDTO>	getWorkflowInstanceWithHttpInfo(String workspaceId, Integer workflowId) Get instantiated workflow in workspace
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowsApi

public WorkflowsApi()

WorkflowsApi

public WorkflowsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getWorkflowInstance

public WorkflowDTO getWorkflowInstance(String workspaceId,
                                       Integer workflowId)
                                throws ApiException

Get instantiated workflow in workspace

Parameters:

workspaceId - Workspace id

workflowId - Workflow id

Returns:

WorkflowDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getWorkflowInstanceWithHttpInfo

public ApiResponse<WorkflowDTO> getWorkflowInstanceWithHttpInfo(String workspaceId,
                                                                Integer workflowId)
                                                         throws ApiException

Get instantiated workflow in workspace

Parameters:

workspaceId - Workspace id

workflowId - Workflow id

Returns:

ApiResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getWorkflowInstanceAsync

public com.squareup.okhttp.Call getWorkflowInstanceAsync(String workspaceId,
                                                         Integer workflowId,
                                                         ApiCallback<WorkflowDTO> callback)
                                                  throws ApiException

Get instantiated workflow in workspace (asynchronously)

Parameters:

workspaceId - Workspace id

workflowId - Workflow id

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getWorkflowAbortedWorkflowList

public List<WorkflowDTO> getWorkflowAbortedWorkflowList(String workspaceId,
                                                        Integer workflowId)
                                                 throws ApiException

Get workflow's aborted workflow list

Parameters:

workspaceId - Workspace id

workflowId - Workflow id

Returns:

List

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getWorkflowAbortedWorkflowListWithHttpInfo

public ApiResponse<List<WorkflowDTO>> getWorkflowAbortedWorkflowListWithHttpInfo(String workspaceId,
                                                                                 Integer workflowId)
                                                                          throws ApiException

Get workflow's aborted workflow list

Parameters:

workspaceId - Workspace id

workflowId - Workflow id

Returns:

ApiResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getWorkflowAbortedWorkflowListAsync

public com.squareup.okhttp.Call getWorkflowAbortedWorkflowListAsync(String workspaceId,
                                                                    Integer workflowId,
                                                                    ApiCallback<List<WorkflowDTO>> callback)
                                                             throws ApiException

Get workflow's aborted workflow list (asynchronously)

Parameters:

workspaceId - Workspace id

workflowId - Workflow id

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object