Package org.kie.server.remote.rest.jbpm

Class UserTaskResource

java.lang.Object

org.kie.server.remote.rest.jbpm.UserTaskResource

@Path("server/containers/{containerId}/tasks")
public class UserTaskResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
UserTaskResource()
UserTaskResource(org.kie.server.services.jbpm.UserTaskServiceBase userTaskServiceBase, org.kie.server.services.jbpm.RuntimeDataServiceBase runtimeDataServiceBase, org.kie.server.services.api.KieServerRegistry context)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	activate(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	addAttachment(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId, String name, String attachmentPayload)
javax.ws.rs.core.Response	addComment(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String payload)
javax.ws.rs.core.Response	claim(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	claimBulk(javax.ws.rs.core.HttpHeaders headers, String containerId, List<Long> taskIds, String userId)
javax.ws.rs.core.Response	complete(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId, boolean autoProgress, String payload)
javax.ws.rs.core.Response	delegate(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId, String targetUserId)
javax.ws.rs.core.Response	deleteAttachment(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, Long attachmentId)
javax.ws.rs.core.Response	deleteComment(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, Long commentId)
javax.ws.rs.core.Response	deleteContent(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, Long contentId)
javax.ws.rs.core.Response	exit(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	fail(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId, String payload)
javax.ws.rs.core.Response	forward(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId, String targetUserId)
javax.ws.rs.core.Response	getAttachmentById(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, Long attachmentId)
javax.ws.rs.core.Response	getAttachmentContentById(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, Long attachmentId)
javax.ws.rs.core.Response	getAttachmentsByTaskId(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId)
javax.ws.rs.core.Response	getCommentById(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, Long commentId)
javax.ws.rs.core.Response	getCommentsByTaskId(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId)
javax.ws.rs.core.Response	getTask(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, boolean withInput, boolean withOutput, boolean withAssignments)
javax.ws.rs.core.Response	getTaskEvents(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getTaskInputContentByTaskId(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId)
javax.ws.rs.core.Response	getTaskOutputContentByTaskId(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId)
javax.ws.rs.core.Response	nominate(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId, List<String> potentialOwners)
javax.ws.rs.core.Response	release(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	resume(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	saveContent(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId, String payload)
javax.ws.rs.core.Response	setDescription(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String descriptionPayload)
javax.ws.rs.core.Response	setExpirationDate(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String datePayload)
javax.ws.rs.core.Response	setName(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String namePayload)
javax.ws.rs.core.Response	setPriority(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String priorityPayload)
javax.ws.rs.core.Response	setSkipable(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String skipablePayload)
javax.ws.rs.core.Response	skip(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	start(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	stop(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	suspend(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId)
javax.ws.rs.core.Response	update(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, String userId, String payload)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

Constructor Detail

UserTaskResource

public UserTaskResource()

UserTaskResource

public UserTaskResource(org.kie.server.services.jbpm.UserTaskServiceBase userTaskServiceBase,
                        org.kie.server.services.jbpm.RuntimeDataServiceBase runtimeDataServiceBase,
                        org.kie.server.services.api.KieServerRegistry context)

Method Detail

activate

@PUT
@Path("{taskInstanceId}/states/activated")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response activate(@Context
                                          javax.ws.rs.core.HttpHeaders headers,
                                          @PathParam("containerId")
                                          String containerId,
                                          @PathParam("taskInstanceId")
                                          Long taskId,
                                          @QueryParam("user")
                                          String userId)

claim

@PUT
@Path("{taskInstanceId}/states/claimed")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response claim(@Context
                                       javax.ws.rs.core.HttpHeaders headers,
                                       @PathParam("containerId")
                                       String containerId,
                                       @PathParam("taskInstanceId")
                                       Long taskId,
                                       @QueryParam("user")
                                       String userId)

claimBulk

@POST
@Path("states/claimed")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response claimBulk(@Context
                                           javax.ws.rs.core.HttpHeaders headers,
                                           @PathParam("containerId")
                                           String containerId,
                                           @QueryParam("taskId")
                                           List<Long> taskIds,
                                           @QueryParam("user")
                                           String userId)

complete

@PUT
@Path("{taskInstanceId}/states/completed")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response complete(@Context
                                          javax.ws.rs.core.HttpHeaders headers,
                                          @PathParam("containerId")
                                          String containerId,
                                          @PathParam("taskInstanceId")
                                          Long taskId,
                                          @QueryParam("user")
                                          String userId,
                                          @QueryParam("auto-progress")
                                          boolean autoProgress,
                                          String payload)

delegate

@PUT
@Path("{taskInstanceId}/states/delegated")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response delegate(@Context
                                          javax.ws.rs.core.HttpHeaders headers,
                                          @PathParam("containerId")
                                          String containerId,
                                          @PathParam("taskInstanceId")
                                          Long taskId,
                                          @QueryParam("user")
                                          String userId,
                                          @QueryParam("targetUser")
                                          String targetUserId)

exit

@PUT
@Path("{taskInstanceId}/states/exited")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response exit(@Context
                                      javax.ws.rs.core.HttpHeaders headers,
                                      @PathParam("containerId")
                                      String containerId,
                                      @PathParam("taskInstanceId")
                                      Long taskId,
                                      @QueryParam("user")
                                      String userId)

fail

@PUT
@Path("{taskInstanceId}/states/failed")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response fail(@Context
                                      javax.ws.rs.core.HttpHeaders headers,
                                      @PathParam("containerId")
                                      String containerId,
                                      @PathParam("taskInstanceId")
                                      Long taskId,
                                      @QueryParam("user")
                                      String userId,
                                      String payload)

forward

@PUT
@Path("{taskInstanceId}/states/forwarded")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response forward(@Context
                                         javax.ws.rs.core.HttpHeaders headers,
                                         @PathParam("containerId")
                                         String containerId,
                                         @PathParam("taskInstanceId")
                                         Long taskId,
                                         @QueryParam("user")
                                         String userId,
                                         @QueryParam("targetUser")
                                         String targetUserId)

release

@PUT
@Path("{taskInstanceId}/states/released")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response release(@Context
                                         javax.ws.rs.core.HttpHeaders headers,
                                         @PathParam("containerId")
                                         String containerId,
                                         @PathParam("taskInstanceId")
                                         Long taskId,
                                         @QueryParam("user")
                                         String userId)

resume

@PUT
@Path("{taskInstanceId}/states/resumed")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response resume(@Context
                                        javax.ws.rs.core.HttpHeaders headers,
                                        @PathParam("containerId")
                                        String containerId,
                                        @PathParam("taskInstanceId")
                                        Long taskId,
                                        @QueryParam("user")
                                        String userId)

skip

@PUT
@Path("{taskInstanceId}/states/skipped")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response skip(@Context
                                      javax.ws.rs.core.HttpHeaders headers,
                                      @PathParam("containerId")
                                      String containerId,
                                      @PathParam("taskInstanceId")
                                      Long taskId,
                                      @QueryParam("user")
                                      String userId)

start

@PUT
@Path("{taskInstanceId}/states/started")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response start(@Context
                                       javax.ws.rs.core.HttpHeaders headers,
                                       @PathParam("containerId")
                                       String containerId,
                                       @PathParam("taskInstanceId")
                                       Long taskId,
                                       @QueryParam("user")
                                       String userId)

stop

@PUT
@Path("{taskInstanceId}/states/stopped")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response stop(@Context
                                      javax.ws.rs.core.HttpHeaders headers,
                                      @PathParam("containerId")
                                      String containerId,
                                      @PathParam("taskInstanceId")
                                      Long taskId,
                                      @QueryParam("user")
                                      String userId)

suspend

@PUT
@Path("{taskInstanceId}/states/suspended")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response suspend(@Context
                                         javax.ws.rs.core.HttpHeaders headers,
                                         @PathParam("containerId")
                                         String containerId,
                                         @PathParam("taskInstanceId")
                                         Long taskId,
                                         @QueryParam("user")
                                         String userId)

nominate

@PUT
@Path("{taskInstanceId}/states/nominated")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response nominate(@Context
                                          javax.ws.rs.core.HttpHeaders headers,
                                          @PathParam("containerId")
                                          String containerId,
                                          @PathParam("taskInstanceId")
                                          Long taskId,
                                          @QueryParam("user")
                                          String userId,
                                          @QueryParam("potOwner")
                                          List<String> potentialOwners)

setPriority

@PUT
@Path("{taskInstanceId}/priority")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response setPriority(@Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @PathParam("containerId")
                                             String containerId,
                                             @PathParam("taskInstanceId")
                                             Long taskId,
                                             String priorityPayload)

setExpirationDate

@PUT
@Path("{taskInstanceId}/expiration")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response setExpirationDate(@Context
                                                   javax.ws.rs.core.HttpHeaders headers,
                                                   @PathParam("containerId")
                                                   String containerId,
                                                   @PathParam("taskInstanceId")
                                                   Long taskId,
                                                   String datePayload)

setSkipable

@PUT
@Path("{taskInstanceId}/skipable")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response setSkipable(@Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @PathParam("containerId")
                                             String containerId,
                                             @PathParam("taskInstanceId")
                                             Long taskId,
                                             String skipablePayload)

setName

@PUT
@Path("{taskInstanceId}/name")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response setName(@Context
                                         javax.ws.rs.core.HttpHeaders headers,
                                         @PathParam("containerId")
                                         String containerId,
                                         @PathParam("taskInstanceId")
                                         Long taskId,
                                         String namePayload)

setDescription

@PUT
@Path("{taskInstanceId}/description")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response setDescription(@Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @PathParam("containerId")
                                                String containerId,
                                                @PathParam("taskInstanceId")
                                                Long taskId,
                                                String descriptionPayload)

saveContent

@PUT
@Path("{taskInstanceId}/contents/output")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response saveContent(@Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @PathParam("containerId")
                                             String containerId,
                                             @PathParam("taskInstanceId")
                                             Long taskId,
                                             @QueryParam("user")
                                             String userId,
                                             String payload)

getTaskOutputContentByTaskId

@GET
@Path("{taskInstanceId}/contents/output")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getTaskOutputContentByTaskId(@Context
                                                              javax.ws.rs.core.HttpHeaders headers,
                                                              @PathParam("containerId")
                                                              String containerId,
                                                              @PathParam("taskInstanceId")
                                                              Long taskId)

getTaskInputContentByTaskId

@GET
@Path("{taskInstanceId}/contents/input")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getTaskInputContentByTaskId(@Context
                                                             javax.ws.rs.core.HttpHeaders headers,
                                                             @PathParam("containerId")
                                                             String containerId,
                                                             @PathParam("taskInstanceId")
                                                             Long taskId)

deleteContent

@DELETE
@Path("{taskInstanceId}/contents/{contentId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response deleteContent(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @PathParam("containerId")
                                               String containerId,
                                               @PathParam("taskInstanceId")
                                               Long taskId,
                                               @PathParam("contentId")
                                               Long contentId)

addComment

@POST
@Path("{taskInstanceId}/comments")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response addComment(@Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @PathParam("containerId")
                                            String containerId,
                                            @PathParam("taskInstanceId")
                                            Long taskId,
                                            String payload)

deleteComment

@DELETE
@Path("{taskInstanceId}/comments/{commentId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response deleteComment(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @PathParam("containerId")
                                               String containerId,
                                               @PathParam("taskInstanceId")
                                               Long taskId,
                                               @PathParam("commentId")
                                               Long commentId)

getCommentsByTaskId

@GET
@Path("{taskInstanceId}/comments")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCommentsByTaskId(@Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @PathParam("containerId")
                                                     String containerId,
                                                     @PathParam("taskInstanceId")
                                                     Long taskId)

getCommentById

@GET
@Path("{taskInstanceId}/comments/{commentId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCommentById(@Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @PathParam("containerId")
                                                String containerId,
                                                @PathParam("taskInstanceId")
                                                Long taskId,
                                                @PathParam("commentId")
                                                Long commentId)

addAttachment

@POST
@Path("{taskInstanceId}/attachments")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response addAttachment(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @PathParam("containerId")
                                               String containerId,
                                               @PathParam("taskInstanceId")
                                               Long taskId,
                                               @QueryParam("user")
                                               String userId,
                                               @QueryParam("name")
                                               String name,
                                               String attachmentPayload)

deleteAttachment

@DELETE
@Path("{taskInstanceId}/attachments/{attachmentId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response deleteAttachment(@Context
                                                  javax.ws.rs.core.HttpHeaders headers,
                                                  @PathParam("containerId")
                                                  String containerId,
                                                  @PathParam("taskInstanceId")
                                                  Long taskId,
                                                  @PathParam("attachmentId")
                                                  Long attachmentId)

getAttachmentById

@GET
@Path("{taskInstanceId}/attachments/{attachmentId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getAttachmentById(@Context
                                                   javax.ws.rs.core.HttpHeaders headers,
                                                   @PathParam("containerId")
                                                   String containerId,
                                                   @PathParam("taskInstanceId")
                                                   Long taskId,
                                                   @PathParam("attachmentId")
                                                   Long attachmentId)

getAttachmentContentById

@GET
@Path("{taskInstanceId}/attachments/{attachmentId}/content")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getAttachmentContentById(@Context
                                                          javax.ws.rs.core.HttpHeaders headers,
                                                          @PathParam("containerId")
                                                          String containerId,
                                                          @PathParam("taskInstanceId")
                                                          Long taskId,
                                                          @PathParam("attachmentId")
                                                          Long attachmentId)

getAttachmentsByTaskId

@GET
@Path("{taskInstanceId}/attachments")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getAttachmentsByTaskId(@Context
                                                        javax.ws.rs.core.HttpHeaders headers,
                                                        @PathParam("containerId")
                                                        String containerId,
                                                        @PathParam("taskInstanceId")
                                                        Long taskId)

getTask

@GET
@Path("{taskInstanceId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getTask(@Context
                                         javax.ws.rs.core.HttpHeaders headers,
                                         @PathParam("containerId")
                                         String containerId,
                                         @PathParam("taskInstanceId")
                                         Long taskId,
                                         @QueryParam("withInputData")
                                         boolean withInput,
                                         @QueryParam("withOutputData")
                                         boolean withOutput,
                                         @QueryParam("withAssignments")
                                         boolean withAssignments)

getTaskEvents

@GET
@Path("{taskInstanceId}/events")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getTaskEvents(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @PathParam("containerId")
                                               String containerId,
                                               @PathParam("taskInstanceId")
                                               Long taskId,
                                               @QueryParam("page") @DefaultValue("0")
                                               Integer page,
                                               @QueryParam("pageSize") @DefaultValue("10")
                                               Integer pageSize,
                                               @QueryParam("sort")
                                               String sort,
                                               @QueryParam("sortOrder") @DefaultValue("true")
                                               boolean sortOrder)

update

@PUT
@Path("{taskInstanceId}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response update(@Context
                                        javax.ws.rs.core.HttpHeaders headers,
                                        @PathParam("containerId")
                                        String containerId,
                                        @PathParam("taskInstanceId")
                                        Long taskId,
                                        @QueryParam("user")
                                        String userId,
                                        String payload)