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

Class WorkflowsIndividualApi

java.lang.Object

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

public class WorkflowsIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WorkflowsIndividualApi()
WorkflowsIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
WorkflowInfoDTO	workflowsExternalWorkflowRefGet(String externalWorkflowRef, String ifNoneMatch) Get details of a the pending workflow request according to the External Workflow Reference.
com.squareup.okhttp.Call	workflowsExternalWorkflowRefGetAsync(String externalWorkflowRef, String ifNoneMatch, ApiCallback<WorkflowInfoDTO> callback) Get details of a the pending workflow request according to the External Workflow Reference.
com.squareup.okhttp.Call	workflowsExternalWorkflowRefGetCall(String externalWorkflowRef, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for workflowsExternalWorkflowRefGet
ApiResponse<WorkflowInfoDTO>	workflowsExternalWorkflowRefGetWithHttpInfo(String externalWorkflowRef, String ifNoneMatch) Get details of a the pending workflow request according to the External Workflow Reference.
WorkflowDTO	workflowsUpdateWorkflowStatusPost(String workflowReferenceId, WorkflowDTO body) Update workflow status This operation can be used to approve or reject a workflow task.
com.squareup.okhttp.Call	workflowsUpdateWorkflowStatusPostAsync(String workflowReferenceId, WorkflowDTO body, ApiCallback<WorkflowDTO> callback) Update workflow status (asynchronously) This operation can be used to approve or reject a workflow task.
com.squareup.okhttp.Call	workflowsUpdateWorkflowStatusPostCall(String workflowReferenceId, WorkflowDTO body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for workflowsUpdateWorkflowStatusPost
ApiResponse<WorkflowDTO>	workflowsUpdateWorkflowStatusPostWithHttpInfo(String workflowReferenceId, WorkflowDTO body) Update workflow status This operation can be used to approve or reject a workflow task.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowsIndividualApi

public WorkflowsIndividualApi()

WorkflowsIndividualApi

public WorkflowsIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

workflowsExternalWorkflowRefGetCall

public com.squareup.okhttp.Call workflowsExternalWorkflowRefGetCall(String externalWorkflowRef,
                                                                    String ifNoneMatch,
                                                                    ProgressResponseBody.ProgressListener progressListener,
                                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                             throws ApiException

Build call for workflowsExternalWorkflowRefGet

Parameters:

externalWorkflowRef - from the externel workflow reference we decide what is the the pending request that the are requesting. (required)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

workflowsExternalWorkflowRefGet

public WorkflowInfoDTO workflowsExternalWorkflowRefGet(String externalWorkflowRef,
                                                       String ifNoneMatch)
                                                throws ApiException

Get details of a the pending workflow request according to the External Workflow Reference. Using this operation, you can retrieve complete details of a pending workflow request that either belongs to application creation, application subscription, application registration, api state change, user self sign up.. You need to provide the External_Workflow_Reference of the workflow Request to retrive it.

Parameters:

externalWorkflowRef - from the externel workflow reference we decide what is the the pending request that the are requesting. (required)

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

Returns:

WorkflowInfoDTO

Throws:

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

workflowsExternalWorkflowRefGetWithHttpInfo

public ApiResponse<WorkflowInfoDTO> workflowsExternalWorkflowRefGetWithHttpInfo(String externalWorkflowRef,
                                                                                String ifNoneMatch)
                                                                         throws ApiException

Get details of a the pending workflow request according to the External Workflow Reference. Using this operation, you can retrieve complete details of a pending workflow request that either belongs to application creation, application subscription, application registration, api state change, user self sign up.. You need to provide the External_Workflow_Reference of the workflow Request to retrive it.

Parameters:

externalWorkflowRef - from the externel workflow reference we decide what is the the pending request that the are requesting. (required)

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

Returns:

ApiResponse<WorkflowInfoDTO>

Throws:

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

workflowsExternalWorkflowRefGetAsync

public com.squareup.okhttp.Call workflowsExternalWorkflowRefGetAsync(String externalWorkflowRef,
                                                                     String ifNoneMatch,
                                                                     ApiCallback<WorkflowInfoDTO> callback)
                                                              throws ApiException

Get details of a the pending workflow request according to the External Workflow Reference. (asynchronously) Using this operation, you can retrieve complete details of a pending workflow request that either belongs to application creation, application subscription, application registration, api state change, user self sign up.. You need to provide the External_Workflow_Reference of the workflow Request to retrive it.

Parameters:

externalWorkflowRef - from the externel workflow reference we decide what is the the pending request that the are requesting. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (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

workflowsUpdateWorkflowStatusPostCall

public com.squareup.okhttp.Call workflowsUpdateWorkflowStatusPostCall(String workflowReferenceId,
                                                                      WorkflowDTO body,
                                                                      ProgressResponseBody.ProgressListener progressListener,
                                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                               throws ApiException

Build call for workflowsUpdateWorkflowStatusPost

Parameters:

workflowReferenceId - Workflow reference id (required)

body - Workflow event that need to be updated (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

workflowsUpdateWorkflowStatusPost

public WorkflowDTO workflowsUpdateWorkflowStatusPost(String workflowReferenceId,
                                                     WorkflowDTO body)
                                              throws ApiException

Update workflow status This operation can be used to approve or reject a workflow task.

Parameters:

workflowReferenceId - Workflow reference id (required)

body - Workflow event that need to be updated (required)

Returns:

WorkflowDTO

Throws:

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

workflowsUpdateWorkflowStatusPostWithHttpInfo

public ApiResponse<WorkflowDTO> workflowsUpdateWorkflowStatusPostWithHttpInfo(String workflowReferenceId,
                                                                              WorkflowDTO body)
                                                                       throws ApiException

Update workflow status This operation can be used to approve or reject a workflow task.

Parameters:

workflowReferenceId - Workflow reference id (required)

body - Workflow event that need to be updated (required)

Returns:

ApiResponse<WorkflowDTO>

Throws:

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

workflowsUpdateWorkflowStatusPostAsync

public com.squareup.okhttp.Call workflowsUpdateWorkflowStatusPostAsync(String workflowReferenceId,
                                                                       WorkflowDTO body,
                                                                       ApiCallback<WorkflowDTO> callback)
                                                                throws ApiException

Update workflow status (asynchronously) This operation can be used to approve or reject a workflow task.

Parameters:

workflowReferenceId - Workflow reference id (required)

body - Workflow event that need to be updated (required)

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