Package org.kie.server.remote.rest.casemgmt

Class CaseResource

  • @Path("server/containers/{containerId}/cases")
public class CaseResource
extends AbstractCaseResource

    • Constructor Detail

      • CaseResource

        public CaseResource()

      • CaseResource

        public CaseResource​(org.kie.server.services.casemgmt.CaseManagementServiceBase caseManagementServiceBase,
                    org.kie.server.services.casemgmt.CaseManagementRuntimeDataServiceBase caseManagementRuntimeDataServiceBase,
                    org.kie.server.services.api.KieServerRegistry context)

    • Method Detail

      • startCase

        @POST
@Path("{caseDefId}/instances")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response startCase​(@Context
                                           javax.ws.rs.core.HttpHeaders headers,
                                           @PathParam("containerId")
                                           String containerId,
                                           @PathParam("caseDefId")
                                           String caseDefId,
                                           String payload)

      • getCaseInstance

        @GET
@Path("instances/{caseId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstance​(@Context
                                                 javax.ws.rs.core.HttpHeaders headers,
                                                 @PathParam("containerId")
                                                 String containerId,
                                                 @PathParam("caseId")
                                                 String caseId,
                                                 @QueryParam("withData") @DefaultValue("false")
                                                 boolean withData,
                                                 @QueryParam("withRoles") @DefaultValue("false")
                                                 boolean withRoles,
                                                 @QueryParam("withMilestones") @DefaultValue("false")
                                                 boolean withMilestones,
                                                 @QueryParam("withStages") @DefaultValue("false")
                                                 boolean withStages)

      • cancelCaseInstance

        @DELETE
@Path("instances/{caseId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response cancelCaseInstance​(@Context
                                                    javax.ws.rs.core.HttpHeaders headers,
                                                    @PathParam("containerId")
                                                    String containerId,
                                                    @PathParam("caseId")
                                                    String caseId,
                                                    @QueryParam("destroy") @DefaultValue("false")
                                                    boolean destroy)

      • closeCaseInstance

        @POST
@Path("instances/{caseId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response closeCaseInstance​(@Context
                                                   javax.ws.rs.core.HttpHeaders headers,
                                                   @PathParam("containerId")
                                                   String containerId,
                                                   @PathParam("caseId")
                                                   String caseId,
                                                   String payload)

      • reopenCase

        @PUT
@Path("{caseDefId}/instances/{caseId}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response reopenCase​(@Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @PathParam("containerId")
                                            String containerId,
                                            @PathParam("caseDefId")
                                            String caseDefId,
                                            @PathParam("caseId")
                                            String caseId,
                                            String payload)

      • getCaseInstanceData

        @GET
@Path("instances/{caseId}/caseFile")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceData​(@Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @PathParam("containerId")
                                                     String containerId,
                                                     @PathParam("caseId")
                                                     String caseId,
                                                     @QueryParam("name")
                                                     List<String> names)

      • getCaseInstanceDataByName

        @GET
@Path("instances/{caseId}/caseFile/{dataId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceDataByName​(@Context
                                                           javax.ws.rs.core.HttpHeaders headers,
                                                           @PathParam("containerId")
                                                           String containerId,
                                                           @PathParam("caseId")
                                                           String caseId,
                                                           @PathParam("dataId")
                                                           String caseDataName)

      • putCaseInstanceData

        @POST
@Path("instances/{caseId}/caseFile")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response putCaseInstanceData​(@Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @PathParam("containerId")
                                                     String containerId,
                                                     @PathParam("caseId")
                                                     String caseId,
                                                     @QueryParam("restrictedTo")
                                                     List<String> restrictions,
                                                     String payload)

      • putCaseInstanceDataByName

        @POST
@Path("instances/{caseId}/caseFile/{dataId}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response putCaseInstanceDataByName​(@Context
                                                           javax.ws.rs.core.HttpHeaders headers,
                                                           @PathParam("containerId")
                                                           String containerId,
                                                           @PathParam("caseId")
                                                           String caseId,
                                                           @PathParam("dataId")
                                                           String caseDataName,
                                                           @QueryParam("restrictedTo")
                                                           List<String> restrictions,
                                                           String payload)

      • deleteCaseInstanceData

        @DELETE
@Path("instances/{caseId}/caseFile")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response deleteCaseInstanceData​(@Context
                                                        javax.ws.rs.core.HttpHeaders headers,
                                                        @PathParam("containerId")
                                                        String containerId,
                                                        @PathParam("caseId")
                                                        String caseId,
                                                        @QueryParam("dataId")
                                                        List<String> variableNames)

      • addDynamicTaskToCase

        @POST
@Path("instances/{caseId}/tasks")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response addDynamicTaskToCase​(@Context
                                                      javax.ws.rs.core.HttpHeaders headers,
                                                      @PathParam("containerId")
                                                      String containerId,
                                                      @PathParam("caseId")
                                                      String caseId,
                                                      String payload)

      • addDynamicTaskToCase

        @POST
@Path("instances/{caseId}/stages/{caseStageId}/tasks")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response addDynamicTaskToCase​(@Context
                                                      javax.ws.rs.core.HttpHeaders headers,
                                                      @PathParam("containerId")
                                                      String containerId,
                                                      @PathParam("caseId")
                                                      String caseId,
                                                      @PathParam("caseStageId")
                                                      String stageId,
                                                      String payload)

      • addDynamicProcessToCase

        @POST
@Path("instances/{caseId}/processes/{processId}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response addDynamicProcessToCase​(@Context
                                                         javax.ws.rs.core.HttpHeaders headers,
                                                         @PathParam("containerId")
                                                         String containerId,
                                                         @PathParam("caseId")
                                                         String caseId,
                                                         @PathParam("processId")
                                                         String processId,
                                                         String payload)

      • addDynamicProcessToCase

        @POST
@Path("instances/{caseId}/stages/{caseStageId}/processes/{processId}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response addDynamicProcessToCase​(@Context
                                                         javax.ws.rs.core.HttpHeaders headers,
                                                         @PathParam("containerId")
                                                         String containerId,
                                                         @PathParam("caseId")
                                                         String caseId,
                                                         @PathParam("caseStageId")
                                                         String stageId,
                                                         @PathParam("processId")
                                                         String processId,
                                                         String payload)

      • triggerAdHocNodeInStage

        @PUT
@Path("instances/{caseId}/stages/{caseStageId}/tasks/{nodeName}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response triggerAdHocNodeInStage​(@Context
                                                         javax.ws.rs.core.HttpHeaders headers,
                                                         @PathParam("containerId")
                                                         String containerId,
                                                         @PathParam("caseId")
                                                         String caseId,
                                                         @PathParam("caseStageId")
                                                         String stageId,
                                                         @PathParam("nodeName")
                                                         String adHocName,
                                                         String payload)

      • triggerAdHocNode

        @PUT
@Path("instances/{caseId}/tasks/{nodeName}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response triggerAdHocNode​(@Context
                                                  javax.ws.rs.core.HttpHeaders headers,
                                                  @PathParam("containerId")
                                                  String containerId,
                                                  @PathParam("caseId")
                                                  String caseId,
                                                  @PathParam("nodeName")
                                                  String adHocName,
                                                  String payload)

      • getCaseInstanceMilestones

        @GET
@Path("instances/{caseId}/milestones")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceMilestones​(@Context
                                                           javax.ws.rs.core.HttpHeaders headers,
                                                           @PathParam("containerId")
                                                           String containerId,
                                                           @PathParam("caseId")
                                                           String caseId,
                                                           @QueryParam("achievedOnly") @DefaultValue("true")
                                                           boolean achievedOnly,
                                                           @QueryParam("page") @DefaultValue("0")
                                                           Integer page,
                                                           @QueryParam("pageSize") @DefaultValue("10")
                                                           Integer pageSize)

      • getCaseInstanceStages

        @GET
@Path("instances/{caseId}/stages")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceStages​(@Context
                                                       javax.ws.rs.core.HttpHeaders headers,
                                                       @PathParam("containerId")
                                                       String containerId,
                                                       @PathParam("caseId")
                                                       String caseId,
                                                       @QueryParam("activeOnly") @DefaultValue("true")
                                                       boolean activeOnly,
                                                       @QueryParam("page") @DefaultValue("0")
                                                       Integer page,
                                                       @QueryParam("pageSize") @DefaultValue("10")
                                                       Integer pageSize)

      • getCaseInstanceAdHocFragments

        @GET
@Path("instances/{caseId}/adhocfragments")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceAdHocFragments​(@Context
                                                               javax.ws.rs.core.HttpHeaders headers,
                                                               @PathParam("containerId")
                                                               String containerId,
                                                               @PathParam("caseId")
                                                               String caseId)

      • getCaseInstanceProcessInstance

        @GET
@Path("instances/{caseId}/processes/instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceProcessInstance​(@Context
                                                                javax.ws.rs.core.HttpHeaders headers,
                                                                @PathParam("containerId")
                                                                String containerId,
                                                                @PathParam("caseId")
                                                                String caseId,
                                                                @QueryParam("status")
                                                                List<Integer> status,
                                                                @QueryParam("page") @DefaultValue("0")
                                                                Integer page,
                                                                @QueryParam("pageSize") @DefaultValue("10")
                                                                Integer pageSize,
                                                                @QueryParam("sort")
                                                                String sort,
                                                                @QueryParam("sortOrder") @DefaultValue("true")
                                                                boolean sortOrder)

      • getCaseInstanceActiveNodes

        @GET
@Path("instances/{caseId}/nodes/instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceActiveNodes​(@Context
                                                            javax.ws.rs.core.HttpHeaders headers,
                                                            @PathParam("containerId")
                                                            String containerId,
                                                            @PathParam("caseId")
                                                            String caseId,
                                                            @QueryParam("completed") @DefaultValue("false")
                                                            Boolean completed,
                                                            @QueryParam("page") @DefaultValue("0")
                                                            Integer page,
                                                            @QueryParam("pageSize") @DefaultValue("10")
                                                            Integer pageSize)

      • getCaseInstanceRoleAssignments

        @GET
@Path("instances/{caseId}/roles")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceRoleAssignments​(@Context
                                                                javax.ws.rs.core.HttpHeaders headers,
                                                                @PathParam("containerId")
                                                                String containerId,
                                                                @PathParam("caseId")
                                                                String caseId)

      • addRoleAssignment

        @PUT
@Path("instances/{caseId}/roles/{caseRoleName}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response addRoleAssignment​(@Context
                                                   javax.ws.rs.core.HttpHeaders headers,
                                                   @PathParam("containerId")
                                                   String containerId,
                                                   @PathParam("caseId")
                                                   String caseId,
                                                   @PathParam("caseRoleName")
                                                   String roleName,
                                                   @QueryParam("user")
                                                   String user,
                                                   @QueryParam("group")
                                                   String group)

      • removeRoleAssignment

        @DELETE
@Path("instances/{caseId}/roles/{caseRoleName}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response removeRoleAssignment​(@Context
                                                      javax.ws.rs.core.HttpHeaders headers,
                                                      @PathParam("containerId")
                                                      String containerId,
                                                      @PathParam("caseId")
                                                      String caseId,
                                                      @PathParam("caseRoleName")
                                                      String roleName,
                                                      @QueryParam("user")
                                                      String user,
                                                      @QueryParam("group")
                                                      String group)

      • getCaseInstanceComments

        @GET
@Path("instances/{caseId}/comments")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceComments​(@Context
                                                         javax.ws.rs.core.HttpHeaders headers,
                                                         @PathParam("containerId")
                                                         String containerId,
                                                         @PathParam("caseId")
                                                         String caseId,
                                                         @QueryParam("sort")
                                                         String sort,
                                                         @QueryParam("page") @DefaultValue("0")
                                                         Integer page,
                                                         @QueryParam("pageSize") @DefaultValue("10")
                                                         Integer pageSize)

      • addComment

        @POST
@Path("instances/{caseId}/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("caseId")
                                            String caseId,
                                            @QueryParam("author")
                                            String author,
                                            @QueryParam("restrictedTo")
                                            List<String> restrictions,
                                            String payload)

      • updateComment

        @PUT
@Path("instances/{caseId}/comments/{caseCommentId}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response updateComment​(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @PathParam("containerId")
                                               String containerId,
                                               @PathParam("caseId")
                                               String caseId,
                                               @PathParam("caseCommentId")
                                               String commentId,
                                               @QueryParam("author")
                                               String author,
                                               @QueryParam("restrictedTo")
                                               List<String> restrictions,
                                               String payload)

      • removeComment

        @DELETE
@Path("instances/{caseId}/comments/{caseCommentId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response removeComment​(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @PathParam("containerId")
                                               String containerId,
                                               @PathParam("caseId")
                                               String caseId,
                                               @PathParam("caseCommentId")
                                               String commentId)

      • getCaseInstancesByContainer

        @GET
@Path("instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstancesByContainer​(@Context
                                                             javax.ws.rs.core.HttpHeaders headers,
                                                             @PathParam("containerId")
                                                             String containerId,
                                                             @QueryParam("status")
                                                             List<String> status,
                                                             @QueryParam("page") @DefaultValue("0")
                                                             Integer page,
                                                             @QueryParam("pageSize") @DefaultValue("10")
                                                             Integer pageSize,
                                                             @QueryParam("sort")
                                                             String sort,
                                                             @QueryParam("sortOrder") @DefaultValue("true")
                                                             boolean sortOrder,
                                                             @QueryParam("withData") @DefaultValue("false")
                                                             boolean withData)

      • getCaseInstancesByDefinition

        @GET
@Path("{caseDefId}/instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstancesByDefinition​(@Context
                                                              javax.ws.rs.core.HttpHeaders headers,
                                                              @PathParam("containerId")
                                                              String containerId,
                                                              @PathParam("caseDefId")
                                                              String caseDefId,
                                                              @QueryParam("status")
                                                              List<String> status,
                                                              @QueryParam("page") @DefaultValue("0")
                                                              Integer page,
                                                              @QueryParam("pageSize") @DefaultValue("10")
                                                              Integer pageSize,
                                                              @QueryParam("sort")
                                                              String sort,
                                                              @QueryParam("sortOrder") @DefaultValue("true")
                                                              boolean sortOrder,
                                                              @QueryParam("withData") @DefaultValue("false")
                                                              boolean withData)

      • getCaseDefinitionsByContainer

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

      • getCaseDefinitionsByDefinition

        @GET
@Path("definitions/{caseDefId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseDefinitionsByDefinition​(@Context
                                                                javax.ws.rs.core.HttpHeaders headers,
                                                                @PathParam("containerId")
                                                                String containerId,
                                                                @PathParam("caseDefId")
                                                                String caseDefId)