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

Interface UserWorkflowService

All Superinterfaces:

JAXRSService

@Path(value="userworkflow")
public interface UserWorkflowService
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_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
WorkflowFormTO	claimForm(String taskId) Claims the form for the given task id.
UserTO	executeTask(String taskId, UserTO userTO) Executes workflow task for matching id.
List<WorkflowTaskTO>	getAvailableTasks(String userKey) Returns a list of available tasks for the given user key.
WorkflowFormTO	getFormForUser(String userKey) Returns a list of available forms for the given user key.
PagedResult<WorkflowFormTO>	getForms(WorkflowFormQuery query) Returns a list of all available workflow forms.
UserTO	submitForm(WorkflowFormTO form) Submits a workflow form.
WorkflowFormTO	unclaimForm(String taskId) Unclaims the form for the given task id.

Method Detail

getForms

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

Returns a list of all available workflow forms.

Parameters:

query - query conditions

Returns:

list of all available workflow forms

getFormForUser

@GET
 @Path(value="forms/{userKey}")
 @Produces(value={"application/json","application/yaml","application/xml"})
WorkflowFormTO getFormForUser(@NotNull @PathParam(value="userKey")
                                                                                                                                               String userKey)

Returns a list of available forms for the given user key.

Parameters:

userKey - user key

Returns:

list of available forms for the given user key

claimForm

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

Claims the form for the given task id.

Parameters:

taskId - workflow task id

Returns:

the workflow form for the given task id

unclaimForm

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

Unclaims 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
                                                                                                                                                                                                      WorkflowFormTO form)

Submits a workflow form.

Parameters:

form - workflow form.

Returns:

updated user

getAvailableTasks

@GET
 @Path(value="tasks/{userKey}")
List<WorkflowTaskTO> getAvailableTasks(@NotNull @PathParam(value="userKey")
                                                                            String userKey)

Returns a list of available tasks for the given user key.

Parameters:

userKey - user key

Returns:

list of available tasks for the given user key

executeTask

@POST
 @Path(value="tasks/{taskId}/execute")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
UserTO executeTask(@NotNull @PathParam(value="taskId")
                                                                                                                                                                                                                        String taskId,
                                                                                                                                                                                                                        @NotNull
                                                                                                                                                                                                                        UserTO userTO)

Executes workflow task for matching id.

Parameters:

taskId - workflow task id

userTO - argument to be passed to workflow task

Returns:

updated user