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

Interface UserWorkflowTaskService

  • All Superinterfaces:
    org.apache.syncope.common.rest.api.service.JAXRSService
    @Path("flowable/userWorkflowTasks")
public interface UserWorkflowTaskService
extends org.apache.syncope.common.rest.api.service.JAXRSService

    • Field Summary

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

        CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.apache.syncope.common.lib.to.UserTO executeNextTask​(@NotNull org.apache.syncope.common.lib.to.WorkflowTaskExecInput workflowTaskExecInput)
      Executes the next workflow task available, for matching user key.
      List<org.apache.syncope.common.lib.to.WorkflowTask> getAvailableTasks​(@NotNull String userKey)
      Returns a list of available tasks for the given user key.

    • Method Detail

      • getAvailableTasks

        @GET
@Path("tasks/{userKey}")
@Produces({"application/json","application/yaml","application/xml"})
List<org.apache.syncope.common.lib.to.WorkflowTask> getAvailableTasks​(@NotNull @PathParam("userKey")
                                                                      @NotNull 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

      • executeNextTask

        @POST
@Path("tasks/{userKey}")
@Produces({"application/json","application/yaml","application/xml"})
@Consumes({"application/json","application/yaml","application/xml"})
org.apache.syncope.common.lib.to.UserTO executeNextTask​(@NotNull
                                                        @NotNull org.apache.syncope.common.lib.to.WorkflowTaskExecInput workflowTaskExecInput)
        Executes the next workflow task available, for matching user key.
        Parameters:
        workflowTaskExecInput - input for task execution
        Returns:
        updated user