Queries for active executions.
Parameters
| Name | Type | Description |
|---|---|---|
| activityId | String | Only return executions which contain an activity with the given ID |
| executionId | String | Only select the execution with the given ID |
| firstResult | Number | The first result to return (results are numbered from 0); can be used in conjunction with maxResults to implement paging |
| includeActiveActivityIds | Boolean | True if the response should include details of the currently active activities for the selected executions; true by default |
| includeChildExecutions | Boolean | If true any child executions (eg sub-processes) will also be returned |
| includeList | Boolean | True if the response should include the actual query results, otherwise just a count will be returned; true by default |
| includeVariables | Boolean | True if the response should include process variables; true by default |
| localOnly | Boolean | Can be used in conjunction with includeVariables to specify that only variables local to the execution should be returned |
| maxResults | Number | The maximum number of results to return; can be used in conjunction with firstResult to implement paging. Defaults to 5000 if not set |
| messageEventSubscriptionName | String | Only return executions which have a message subscription for the given message name |
| orderByProcessDefinitionId | "asc" or "desc" | If specified, sort results by process definition ID using the specified ordering |
| orderByProcessDefinitionKey | "asc" or "desc" | If specified, sort results by process definition key using the specified ordering |
| orderByProcessInstanceId | "asc" or "desc" | Order results by process instance ID (note that the process instance ID is represented as a string so 77 will appear after 100) |
| parentId | String | Only return executions which are immediate children of the specified execution ID |
| processDefinitionId | String | Only return executions which have the specified process definition ID |
| processDefinitionKey | String | Only return executions which have the specified process definition key |
| processDefinitionKeyIn | List<String> | Only return executions that have a process definition key included in the supplied list |
| processDefinitionName | String | Only return executions which have the specified process definition name |
| processInstanceBusinessKey | String | Only return executions with the given business key; note that only process instances have a business key and you'll need to set includeChildExecutions to also return, for example, sub-processes |
| processInstanceId | String | Only return executions which have the specified process instance ID |
| signalEventSubscriptionName | String | Only return executions which have a signal event subscription for the given signal name |
| sortOrder | Array<Object> | Enables multi-column ordering. For example specify [{" processDefinitionKey ":"desc"},{" processInstanceId ":"asc"}] to sort by processDefinitionKey then processInstanceId |
| variableValue | String/Number | These parameters are used together, variableName specifies a process variable name, variableValue specifies a value and variableCondition specifies a condition; valid values for variableCondition are "equals", "equalsIgnoreCase", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual", "like" and "notEquals" |
| variableName | String | |
| variableCondition | String | |
| All parameters are optional | ||
Last modified on March 27, 2024
Share this page
