@Path(value="flowable/userRequests") public interface UserRequestService extends JAXRSService
CRLF, DOUBLE_DASH, 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
Modifier and Type | Method and Description |
---|---|
void |
cancelRequest(@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> |
listForms(UserRequestQuery query)
Returns a list of user request forms matching the given query.
|
PagedResult<UserRequest> |
listRequests(UserRequestQuery query)
Returns a list of running user requests matching the given query.
|
UserRequest |
startRequest(@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).
|
javax.ws.rs.core.Response |
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.
|
@GET @Produces(value={"application/json","application/yaml","application/xml"}) PagedResult<UserRequest> listRequests(@BeanParam UserRequestQuery query)
query
- query conditions@POST @Path(value="start/{bpmnProcess}") @Produces(value={"application/json","application/yaml","application/xml"}) UserRequest startRequest(@NotNull @PathParam(value="bpmnProcess") @NotNull String bpmnProcess, @QueryParam(value="user") String user, WorkflowTaskExecInput inputVariables)
bpmnProcess
- BPMN processuser
- if value looks like a UUID then it is interpreted as key otherwise as a usernameinputVariables
- initial request variables@DELETE @Path(value="{executionId}") @Produces(value={"application/json","application/yaml","application/xml"}) void cancelRequest(@NotNull @PathParam(value="executionId") @NotNull String executionId, @QueryParam(value="reason") String reason)
executionId
- execution idreason
- reason to cancel the user request@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)
username
- username of the logged usertaskId
- workflow task id@GET @Path(value="forms") @Produces(value={"application/json","application/yaml","application/xml"}) PagedResult<UserRequestForm> listForms(@BeanParam UserRequestQuery query)
query
- query conditions@POST @Path(value="forms/{taskId}/claim") @Produces(value={"application/json","application/yaml","application/xml"}) UserRequestForm claimForm(@NotNull @PathParam(value="taskId") @NotNull String taskId)
taskId
- workflow task id@POST @Path(value="forms/{taskId}/unclaim") @Produces(value={"application/json","application/yaml","application/xml"}) UserRequestForm unclaimForm(@NotNull @PathParam(value="taskId") @NotNull String taskId)
taskId
- workflow task id@POST @Path(value="forms") @Produces(value={"application/json","application/yaml","application/xml"}) @Consumes(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response submitForm(@NotNull @NotNull UserRequestForm form)
form
- user request form.Copyright © 2010–2023 The Apache Software Foundation. All rights reserved.