Get Case Instances
Queries for case instances that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of case instances. The size of the result set can be retrieved by using the Get Case Instance Count method.
Method
GET /case-instance
Parameters
Query Parameters
Name | Description |
---|---|
caseInstanceId | Filter by a case instance id. |
businessKey | Filter by case instance business key. |
caseDefinitionId | Filter by the case definition the case instances run on. |
caseDefinitionKey | Filter by the key of the case definition the case instances run on. |
deploymentId | Filter by the deployment the id belongs to. |
superProcessInstance | Restrict query to all case instances that are sub case instances of the given process instance. Takes a process instance id. |
subProcessInstance | Restrict query to all case instances that have the given process instance as a sub process instance. Takes a process instance id. |
superCaseInstance | Restrict query to all case instances that are sub case instances of the given case instance. Takes a case instance id. |
subCaseInstance | Restrict query to all case instances that have the given case instance as a sub case instance. Takes a case instance id. |
active | Only include active case instances. Value may only be true , as false is the default behavior. |
completed | Only include completed case instances. Value may only be true , as false is the default behavior. |
tenantIdIn | Filter by a comma-separated list of tenant ids. A case instance must have one of the given tenant ids. |
withoutTenantId | Only include case instances which belong to no tenant. Value may only be true , as false is the default behavior. |
variables | Only include case instances that have variables with certain values.
Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form key_operator_value .
key is the variable name, operator is the comparison operator to be used and value the variable value.Note: Values are always treated as String objects on server side.Valid operator values are: eq - equal to; neq - not equal to; gt - greater than;
gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to;
like .key and value may not contain underscore or comma characters.
|
sortBy | Sort the results lexicographically by a given criterion. Valid values are
caseInstanceId , casedefinitionKey , caseDefinitionId and tenantId .
Must be used in conjunction with the sortOrder parameter. |
sortOrder | Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter. |
firstResult | Pagination of results. Specifies the index of the first result to return. |
maxResults | Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. |
Result
A JSON array of case instance objects. Each case instance object has the following properties:
Name | Value | Description |
---|---|---|
id | String | The id of the case instance. |
caseDefinitionId | String | The id of the case definition that this case instance belongs to. |
businessKey | String | The business key of the case instance. |
active | Boolean | A flag indicating whether the case instance is active or not. |
completed | Boolean | A flag indicating whether the case instance is completed or not. |
tenantId | String | The tenant id of the case instance. |
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
400 | application/json | Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy , or if an invalid operator for variable comparison is used. See the Introduction for the error response format. |
Example
Request
GET /case-instance?variables=myVariable_eq_camunda,mySecondVariable_neq_aBadValue
Response
[
{
"links" : [],
"id" : "anId",
"caseDefinitionId" : "aCaseDefId",
"businessKey" : "aKey",
"active" : true,
"completed" : false,
"tenantId" : null
}
]