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

Class CaseQueryResource

java.lang.Object

org.kie.server.remote.rest.casemgmt.AbstractCaseResource

org.kie.server.remote.rest.casemgmt.CaseQueryResource

@Path("server/queries/cases")
public class CaseQueryResource
extends AbstractCaseResource

Field Summary

Fields inherited from class org.kie.server.remote.rest.casemgmt.AbstractCaseResource

caseManagementRuntimeDataServiceBase, context

Constructor Summary

Constructors

Constructor	Description
CaseQueryResource()
CaseQueryResource(org.kie.server.services.casemgmt.CaseManagementRuntimeDataServiceBase caseManagementRuntimeDataServiceBase, org.kie.server.services.api.KieServerRegistry context)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getCaseDefinitions(javax.ws.rs.core.HttpHeaders headers, String filter, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getCaseInstanceDataItems(javax.ws.rs.core.HttpHeaders headers, String caseId, List<String> names, List<String> types, Integer page, Integer pageSize)
javax.ws.rs.core.Response	getCaseInstances(javax.ws.rs.core.HttpHeaders headers, String dataItemName, String dataItemValue, String owner, List<String> status, Integer page, Integer pageSize, String sort, boolean sortOrder, boolean withData)
javax.ws.rs.core.Response	getCaseInstancesByRole(javax.ws.rs.core.HttpHeaders headers, String roleName, List<String> status, Integer page, Integer pageSize, String sort, boolean sortOrder, boolean withData)
javax.ws.rs.core.Response	getCaseInstanceTasksAsAdmin(javax.ws.rs.core.HttpHeaders headers, String caseId, String user, List<String> status, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getCaseInstanceTasksAsPotentialOwner(javax.ws.rs.core.HttpHeaders headers, String caseId, String user, List<String> status, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getCaseInstanceTasksAsStakeholder(javax.ws.rs.core.HttpHeaders headers, String caseId, String user, List<String> status, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getProcessDefinitions(javax.ws.rs.core.HttpHeaders headers, String filter, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getProcessDefinitionsByContainer(javax.ws.rs.core.HttpHeaders headers, String containerId, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	queryCaseByVariables(javax.ws.rs.core.HttpHeaders headers, String payload, Integer page, Integer pageSize)
javax.ws.rs.core.Response	queryCaseUserTasksByVariables(javax.ws.rs.core.HttpHeaders headers, String payload, Integer page, Integer pageSize)

Methods inherited from class org.kie.server.remote.rest.casemgmt.AbstractCaseResource

invokeCaseOperation, invokeCaseOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

CaseQueryResource

public CaseQueryResource()

CaseQueryResource

public CaseQueryResource(org.kie.server.services.casemgmt.CaseManagementRuntimeDataServiceBase caseManagementRuntimeDataServiceBase,
                         org.kie.server.services.api.KieServerRegistry context)

Method Detail

getCaseInstances

@GET
@Path("instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstances(@Context
                                                  javax.ws.rs.core.HttpHeaders headers,
                                                  @QueryParam("dataItemName")
                                                  String dataItemName,
                                                  @QueryParam("dataItemValue")
                                                  String dataItemValue,
                                                  @QueryParam("owner")
                                                  String owner,
                                                  @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)

getCaseInstancesByRole

@GET
@Path("{caseRoleName}/instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstancesByRole(@Context
                                                        javax.ws.rs.core.HttpHeaders headers,
                                                        @PathParam("caseRoleName")
                                                        String roleName,
                                                        @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)

getCaseDefinitions

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

getProcessDefinitions

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

getProcessDefinitionsByContainer

@GET
@Path("{containerId}/processes")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getProcessDefinitionsByContainer(@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)

getCaseInstanceTasksAsPotentialOwner

@GET
@Path("instances/{caseId}/tasks/instances/pot-owners")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceTasksAsPotentialOwner(@Context
                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                      @PathParam("caseId")
                                                                      String caseId,
                                                                      @QueryParam("user")
                                                                      String user,
                                                                      @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)

getCaseInstanceTasksAsAdmin

@GET
@Path("instances/{caseId}/tasks/instances/admins")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceTasksAsAdmin(@Context
                                                             javax.ws.rs.core.HttpHeaders headers,
                                                             @PathParam("caseId")
                                                             String caseId,
                                                             @QueryParam("user")
                                                             String user,
                                                             @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)

getCaseInstanceTasksAsStakeholder

@GET
@Path("instances/{caseId}/tasks/instances/stakeholders")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceTasksAsStakeholder(@Context
                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                   @PathParam("caseId")
                                                                   String caseId,
                                                                   @QueryParam("user")
                                                                   String user,
                                                                   @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)

getCaseInstanceDataItems

@GET
@Path("instances/{caseId}/caseFile")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getCaseInstanceDataItems(@Context
                                                          javax.ws.rs.core.HttpHeaders headers,
                                                          @PathParam("caseId")
                                                          String caseId,
                                                          @QueryParam("name")
                                                          List<String> names,
                                                          @QueryParam("type")
                                                          List<String> types,
                                                          @QueryParam("page") @DefaultValue("0")
                                                          Integer page,
                                                          @QueryParam("pageSize") @DefaultValue("10")
                                                          Integer pageSize)

queryCaseByVariables

@POST
@Path("variables/cases")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response queryCaseByVariables(@Context
                                                      javax.ws.rs.core.HttpHeaders headers,
                                                      String payload,
                                                      @QueryParam("page") @DefaultValue("0")
                                                      Integer page,
                                                      @QueryParam("pageSize") @DefaultValue("10")
                                                      Integer pageSize)

queryCaseUserTasksByVariables

@POST
@Path("variables/cases/tasks")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response queryCaseUserTasksByVariables(@Context
                                                               javax.ws.rs.core.HttpHeaders headers,
                                                               String payload,
                                                               @QueryParam("page") @DefaultValue("0")
                                                               Integer page,
                                                               @QueryParam("pageSize") @DefaultValue("10")
                                                               Integer pageSize)