org.apache.syncope.common.rest.api.service

Interface UserRequestService

All Superinterfaces:

JAXRSService

@Path(value="flowable/userRequests")
public interface UserRequestService
extends JAXRSService

REST operations related to user workflow.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
void	cancel(@NotNull String executionId, String reason) Cancel a running user request.
UserRequestForm	claimForm(@NotNull String taskId) Requests to manage the form for the given task id.
UserRequestForm	getForm(@NotNull String username, @NotNull String taskId) Returns a user request form matching the given task id.
PagedResult<UserRequestForm>	getForms(UserRequestFormQuery query) Returns a list of user request forms matching the given query.
PagedResult<UserRequest>	list(UserRequestQuery query) Returns a list of running user requests matching the given query.
UserRequest	start(@NotNull String bpmnProcess, String user, WorkflowTaskExecInput inputVariables) Starts a new request for the given BPMN Process and user (if provided) or requesting user (if not provided).
UserTO	submitForm(@NotNull UserRequestForm form) Submits a user request form.
UserRequestForm	unclaimForm(@NotNull String taskId) Cancels request to manage the form for the given task id.

Method Detail

list

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
PagedResult<UserRequest> list(@BeanParam
                                                                                                               UserRequestQuery query)

Returns a list of running user requests matching the given query.

Parameters:

query - query conditions

Returns:

list of all running user requests

start

@POST
 @Path(value="start/{bpmnProcess}")
 @Produces(value={"application/json","application/yaml","application/xml"})
UserRequest start(@NotNull @PathParam(value="bpmnProcess")
                                                                                                                                        @NotNull String bpmnProcess,
                                                                                                                                        @QueryParam(value="user")
                                                                                                                                        String user,
                                                                                                                                        WorkflowTaskExecInput inputVariables)

Starts a new request for the given BPMN Process and user (if provided) or requesting user (if not provided).

Parameters:

bpmnProcess - BPMN process

user - if value looks like a UUID then it is interpreted as key otherwise as a username

inputVariables - initial request variables

Returns:

data about the started request service, including execution id

cancel

@DELETE
 @Path(value="{executionId}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void cancel(@NotNull @PathParam(value="executionId")
                                                                                                                              @NotNull String executionId,
                                                                                                                              @QueryParam(value="reason")
                                                                                                                              String reason)

Cancel a running user request.

Parameters:

executionId - execution id

reason - reason to cancel the user request

getForm

@GET
 @Path(value="forms/{username}/{taskId}")
 @Produces(value={"application/json","application/yaml","application/xml"})
UserRequestForm getForm(@NotNull @PathParam(value="username")
                                                                                                                                                   @NotNull String username,
                                                                                                                                                   @NotNull @PathParam(value="taskId")
                                                                                                                                                   @NotNull String taskId)

Returns a user request form matching the given task id.

Parameters:

username - username of the logged user

taskId - workflow task id

Returns:

the form for the given task id

getForms

@GET
 @Path(value="forms")
 @Produces(value={"application/json","application/yaml","application/xml"})
PagedResult<UserRequestForm> getForms(@BeanParam
                                                                                                                                             UserRequestFormQuery query)

Returns a list of user request forms matching the given query.

Parameters:

query - query conditions

Returns:

list of all available user request forms

claimForm

@POST
 @Path(value="forms/{taskId}/claim")
 @Produces(value={"application/json","application/yaml","application/xml"})
UserRequestForm claimForm(@NotNull @PathParam(value="taskId")
                                                                                                                                                 @NotNull String taskId)

Requests to manage the form for the given task id.

Parameters:

taskId - workflow task id

Returns:

the form for the given task id

unclaimForm

@POST
 @Path(value="forms/{taskId}/unclaim")
 @Produces(value={"application/json","application/yaml","application/xml"})
UserRequestForm unclaimForm(@NotNull @PathParam(value="taskId")
                                                                                                                                                     @NotNull String taskId)

Cancels request to manage the form for the given task id.

Parameters:

taskId - workflow task id

Returns:

the workflow form for the given task id

submitForm

@POST
 @Path(value="forms")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
UserTO submitForm(@NotNull
                                                                                                                                                                                                      @NotNull UserRequestForm form)

Submits a user request form.

Parameters:

form - user request form.

Returns:

updated user