Expose cmmn query by caseInstanceIds over REST (#4103)

Author: roumn

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/runtime/caze/BaseCaseInstanceResource.java

@@ -73,6 +73,9 @@ protected DataResponse<CaseInstanceResponse> getQueryResponse(CaseInstanceQueryR
         if (queryRequest.getCaseInstanceId() != null) {
             query.caseInstanceId(queryRequest.getCaseInstanceId());
         }
+        if (queryRequest.getCaseInstanceIds() != null) {
+            query.caseInstanceIds(queryRequest.getCaseInstanceIds());
+        }
         if (queryRequest.getCaseDefinitionKey() != null) {
             query.caseDefinitionKey(queryRequest.getCaseDefinitionKey());
         }

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/runtime/caze/CaseInstanceCollectionResource.java

@@ -60,7 +60,8 @@ public class CaseInstanceCollectionResource extends BaseCaseInstanceResource {
 
     @ApiOperation(value = "List case instances", nickname ="listCaseInstances", tags = { "Case Instances" })
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "id", dataType = "string", value = "Only return models with the given version.", paramType = "query"),
+            @ApiImplicitParam(name = "id", dataType = "string", value = "Only return case instances with the given id.", paramType = "query"),
+            @ApiImplicitParam(name = "ids", dataType = "string", value = "Only return case instances with the given comma-separated ids.", paramType = "query"),
             @ApiImplicitParam(name = "caseDefinitionKey", dataType = "string", value = "Only return case instances with the given case definition key.", paramType = "query"),
             @ApiImplicitParam(name = "caseDefinitionKeyLike", dataType = "string", value = "Only return case instances like given case definition key.", paramType = "query"),
             @ApiImplicitParam(name = "caseDefinitionKeyLikeIgnoreCase", dataType = "string", value = "Only return case instances like given case definition key, ignoring case.", paramType = "query"),
@@ -116,6 +117,10 @@ public DataResponse<CaseInstanceResponse> getCaseInstances(@ApiParam(hidden = tr
             queryRequest.setCaseInstanceId(allRequestParams.get("id"));
         }
 
+        if (allRequestParams.containsKey("ids")) {
+            queryRequest.setCaseInstanceIds(RequestUtil.parseToSet(allRequestParams.get("ids")));
+        }
+
         if (allRequestParams.containsKey("caseDefinitionKey")) {
             queryRequest.setCaseDefinitionKey(allRequestParams.get("caseDefinitionKey"));
         }

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/runtime/caze/CaseInstanceQueryRequest.java

@@ -30,6 +30,7 @@
 public class CaseInstanceQueryRequest extends PaginateRequest {
 
     private String caseInstanceId;
+    private Set<String> caseInstanceIds;
     private String caseDefinitionId;
     private String caseDefinitionKey;
     private String caseDefinitionKeyLike;
@@ -84,6 +85,14 @@ public void setCaseInstanceId(String caseInstanceId) {
         this.caseInstanceId = caseInstanceId;
     }
 
+    public Set<String> getCaseInstanceIds() {
+        return caseInstanceIds;
+    }
+
+    public void setCaseInstanceIds(Set<String> caseInstanceIds) {
+        this.caseInstanceIds = caseInstanceIds;
+    }
+
     public String getCaseBusinessKey() {
         return caseBusinessKey;
     }

modules/flowable-cmmn-rest/src/test/java/org/flowable/cmmn/rest/service/api/runtime/CaseInstanceCollectionResourceTest.java

@@ -101,6 +101,24 @@ public void testGetCaseInstances() throws Exception {
 
         url = CmmnRestUrls.createRelativeResourceUrl(CmmnRestUrls.URL_CASE_INSTANCE_COLLECTION) + "?id=anotherId";
         assertResultsPresentInDataResponse(url);
+
+        // Case instance ids
+        String id2 = runtimeService.createCaseInstanceBuilder()
+                .caseDefinitionKey("oneHumanTaskCase")
+                .name("myCaseInstanceName")
+                .businessKey("myBusinessKey")
+                .businessStatus("myBusinessStatus")
+                .start().getId();
+        String id3 = runtimeService.createCaseInstanceBuilder()
+                .caseDefinitionKey("oneHumanTaskCase")
+                .name("myCaseInstanceName")
+                .businessKey("myBusinessKey")
+                .businessStatus("myBusinessStatus")
+                .start().getId();
+        url = CmmnRestUrls.createRelativeResourceUrl(CmmnRestUrls.URL_CASE_INSTANCE_COLLECTION) + "?ids=" + id + "," + id2;
+        assertResultsPresentInDataResponse(url, id, id2);
+        runtimeService.terminateCaseInstance(id2);
+        runtimeService.terminateCaseInstance(id3);
 
         // Case instance name
         url = CmmnRestUrls.createRelativeResourceUrl(CmmnRestUrls.URL_CASE_INSTANCE_COLLECTION) + "?name=myCaseInstanceName";

modules/flowable-cmmn-rest/src/test/java/org/flowable/cmmn/rest/service/api/runtime/CaseInstanceQueryResourceTest.java

@@ -66,6 +66,20 @@ public void testQueryCaseInstancesWithVariables() throws Exception {
         String url = CmmnRestUrls.createRelativeResourceUrl(CmmnRestUrls.URL_CASE_INSTANCE_QUERY);
 
         ObjectNode requestNode = objectMapper.createObjectNode();
+        requestNode.put("caseInstanceId", caseInstance.getId());
+        assertResultsPresentInPostDataResponse(url, requestNode, caseInstance.getId());
+
+        CaseInstance caseInstance2 = runtimeService.createCaseInstanceBuilder().caseDefinitionKey("oneHumanTaskCase").start();
+        CaseInstance caseInstance3 = runtimeService.createCaseInstanceBuilder().caseDefinitionKey("oneHumanTaskCase").start();
+
+        requestNode = objectMapper.createObjectNode();
+        requestNode.putArray("caseInstanceIds").add(caseInstance.getId()).add(caseInstance2.getId());
+        assertResultsPresentInPostDataResponse(url, requestNode, caseInstance.getId(), caseInstance2.getId());
+
+        runtimeService.terminateCaseInstance(caseInstance2.getId());
+        runtimeService.terminateCaseInstance(caseInstance3.getId());
+
+        requestNode = objectMapper.createObjectNode();
         requestNode.put("caseInstanceBusinessKey", "myBusinessKey");
         assertResultsPresentInPostDataResponse(url, requestNode, caseInstance.getId());
 

modules/flowable-common-rest/src/main/java/org/flowable/common/rest/api/RequestUtil.java

@@ -16,8 +16,10 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Date;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 import org.apache.commons.lang3.time.FastDateFormat;
 import org.flowable.common.engine.api.FlowableIllegalArgumentException;
@@ -110,4 +112,14 @@ public static List<String> parseToList(String value) {
         Collections.addAll(values, valueParts);
         return values;
     }
+
+    public static Set<String> parseToSet(String value) {
+        if (value == null || value.isEmpty()) {
+            return null;
+        }
+        String[] valueParts = value.split(",");
+        Set<String> values = new HashSet<>(valueParts.length);
+        Collections.addAll(values, valueParts);
+        return values;
+    }
 }