Package org.wso2.am.integration.clients.admin.api

Class WorkflowCollectionApi

java.lang.Object

org.wso2.am.integration.clients.admin.api.WorkflowCollectionApi

public class WorkflowCollectionApi
extends Object

Constructor Summary

Constructors

Constructor	Description
WorkflowCollectionApi()
WorkflowCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
WorkflowListDTO	workflowsGet(Integer limit, Integer offset, String accept, String ifNoneMatch, String workflowType)	Retrieve All Pending Workflow Processes This operation can be used to retrieve list of workflow pending processes.
okhttp3.Call	workflowsGetAsync(Integer limit, Integer offset, String accept, String ifNoneMatch, String workflowType, ApiCallback<WorkflowListDTO> _callback)	Retrieve All Pending Workflow Processes (asynchronously) This operation can be used to retrieve list of workflow pending processes.
okhttp3.Call	workflowsGetCall(Integer limit, Integer offset, String accept, String ifNoneMatch, String workflowType, ApiCallback _callback)	Build call for workflowsGet
ApiResponse<WorkflowListDTO>	workflowsGetWithHttpInfo(Integer limit, Integer offset, String accept, String ifNoneMatch, String workflowType)	Retrieve All Pending Workflow Processes This operation can be used to retrieve list of workflow pending processes.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowCollectionApi

public WorkflowCollectionApi()

WorkflowCollectionApi

public WorkflowCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

workflowsGetCall

public okhttp3.Call workflowsGetCall(Integer limit,
                                     Integer offset,
                                     String accept,
                                     String ifNoneMatch,
                                     String workflowType,
                                     ApiCallback _callback)
                              throws ApiException

Build call for workflowsGet

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

accept - Media types acceptable for the response. Default is application/json. (optional, default to "application/json")

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (optional)

workflowType - We need to show the values of each workflow process separately .for that we use workflow type. Workflow type can be AM_APPLICATION_CREATION, AM_SUBSCRIPTION_CREATION, AM_USER_SIGNUP, AM_APPLICATION_REGISTRATION_PRODUCTION, AM_APPLICATION_REGISTRATION_SANDBOX. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

workflowsGet

public WorkflowListDTO workflowsGet(Integer limit,
                                    Integer offset,
                                    String accept,
                                    String ifNoneMatch,
                                    String workflowType)
                             throws ApiException

Retrieve All Pending Workflow Processes This operation can be used to retrieve list of workflow pending processes.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

accept - Media types acceptable for the response. Default is application/json. (optional, default to "application/json")

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (optional)

workflowType - We need to show the values of each workflow process separately .for that we use workflow type. Workflow type can be AM_APPLICATION_CREATION, AM_SUBSCRIPTION_CREATION, AM_USER_SIGNUP, AM_APPLICATION_REGISTRATION_PRODUCTION, AM_APPLICATION_REGISTRATION_SANDBOX. (optional)

Returns:

WorkflowListDTO

Throws:

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

workflowsGetWithHttpInfo

public ApiResponse<WorkflowListDTO> workflowsGetWithHttpInfo(Integer limit,
                                                             Integer offset,
                                                             String accept,
                                                             String ifNoneMatch,
                                                             String workflowType)
                                                      throws ApiException

Retrieve All Pending Workflow Processes This operation can be used to retrieve list of workflow pending processes.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

accept - Media types acceptable for the response. Default is application/json. (optional, default to "application/json")

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (optional)

workflowType - We need to show the values of each workflow process separately .for that we use workflow type. Workflow type can be AM_APPLICATION_CREATION, AM_SUBSCRIPTION_CREATION, AM_USER_SIGNUP, AM_APPLICATION_REGISTRATION_PRODUCTION, AM_APPLICATION_REGISTRATION_SANDBOX. (optional)

Returns:

ApiResponse<WorkflowListDTO>

Throws:

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

workflowsGetAsync

public okhttp3.Call workflowsGetAsync(Integer limit,
                                      Integer offset,
                                      String accept,
                                      String ifNoneMatch,
                                      String workflowType,
                                      ApiCallback<WorkflowListDTO> _callback)
                               throws ApiException

Retrieve All Pending Workflow Processes (asynchronously) This operation can be used to retrieve list of workflow pending processes.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

accept - Media types acceptable for the response. Default is application/json. (optional, default to "application/json")

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (optional)

workflowType - We need to show the values of each workflow process separately .for that we use workflow type. Workflow type can be AM_APPLICATION_CREATION, AM_SUBSCRIPTION_CREATION, AM_USER_SIGNUP, AM_APPLICATION_REGISTRATION_PRODUCTION, AM_APPLICATION_REGISTRATION_SANDBOX. (optional)

_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