@5minds/node-red-contrib-processcube 1.5.6 → 1.5.7-develop-41d845-m3q6c4hg

Sign up to get free protection for your applications and to get access to all the features.
@@ -58,11 +58,26 @@
58
58
  Waiting for external tasks that correspond to the `Topic` configured in
59
59
  the connected ProcessCube Engine for processing.
60
60
 
61
+ ## Configs
62
+
63
+ : name (string) : The name of the node
64
+ : engine (string) : The ProcessCube Engine to connect to
65
+ : topic (string) : The topic of the external task
66
+ : workerConfig (object) : The configuration for the worker
67
+
68
+ ### workerConfig
69
+
70
+ - workerId (string): The id of the worker
71
+ - lockDuration (number): The duration in milliseconds the external task is locked for execution
72
+ - maxTasks (number): The maximum number of tasks that can be fetched at once
73
+ - longpollingTimeout (number): The duration in milliseconds the external task is locked for execution
74
+ - payloadFilter (Req-Expression): The filter for the payload of the external task
75
+
61
76
  ## Outputs
62
77
 
63
78
  : payload (string) : The payload the external task was started with.
64
79
  : task (object) : The external task object
65
- : flowNodeInstanceId : The unique identifier of the external task, which is needed to complete the task
80
+ : flowNodeInstanceId (string) : The unique identifier of the external task, which is needed to complete the task
66
81
 
67
82
  ### Details
68
83
 
@@ -98,7 +98,7 @@ module.exports = function (RED) {
98
98
  task: RED.util.encodeObject(externalTask),
99
99
  payload: payload,
100
100
  flowNodeInstanceId: externalTask.flowNodeInstanceId,
101
- processInstanceId: externalTask.processInstanceId
101
+ processInstanceId: externalTask.processInstanceId,
102
102
  };
103
103
 
104
104
  node.log(
@@ -109,8 +109,10 @@ module.exports = function (RED) {
109
109
  });
110
110
  };
111
111
 
112
+ let options = RED.util.evaluateNodeProperty(config.workerConfig, 'json', node);
113
+
112
114
  client.externalTasks
113
- .subscribeToExternalTaskTopic(config.topic, etwCallback, RED.util.evaluateNodeProperty(config.workerConfig, 'json', node))
115
+ .subscribeToExternalTaskTopic(config.topic, etwCallback, options)
114
116
  .then(async (externalTaskWorker) => {
115
117
  node.status({ fill: 'blue', shape: 'ring', text: 'subcribed' });
116
118
 
@@ -136,7 +138,8 @@ module.exports = function (RED) {
136
138
  showStatus(node, Object.keys(started_external_tasks).length);
137
139
  break;
138
140
  default:
139
- node.error(`Worker error ${errorType}: ${error.message}`);
141
+ // reduce noise error logs
142
+ // node.error(`Worker error ${errorType}: ${error.message}`);
140
143
  break;
141
144
  }
142
145
  });
@@ -71,6 +71,22 @@
71
71
  "info": "",
72
72
  "env": []
73
73
  },
74
+ {
75
+ "id": "76c047e0d8770a20",
76
+ "type": "tab",
77
+ "label": "Other Events",
78
+ "disabled": false,
79
+ "info": "",
80
+ "env": []
81
+ },
82
+ {
83
+ "id": "2766c40d84283368",
84
+ "type": "tab",
85
+ "label": "Placeholder",
86
+ "disabled": false,
87
+ "info": "",
88
+ "env": []
89
+ },
74
90
  {
75
91
  "id": "4c59118134081e05",
76
92
  "type": "group",
@@ -481,6 +497,7 @@
481
497
  "color": "#a4a4a4"
482
498
  },
483
499
  "nodes": [
500
+
484
501
  "2fadb4c4667ecaf2",
485
502
  "93331783b7ef3fc5",
486
503
  "bc26f9821540f097",
@@ -1485,7 +1502,7 @@
1485
1502
  "g": "a71a168415778e2c",
1486
1503
  "name": "",
1487
1504
  "engine": "42e6796dddd9d4db",
1488
- "query": "{\"includeXml\":false}",
1505
+ "query": "{\"includeXml\":false,\"processDefinitionId\":\"External-Task-Sample_Definition\"}",
1489
1506
  "query_type": "json",
1490
1507
  "x": 320,
1491
1508
  "y": 140,
@@ -2094,5 +2111,95 @@
2094
2111
  "x": 760,
2095
2112
  "y": 60,
2096
2113
  "wires": []
2114
+ },
2115
+ {
2116
+ "id": "930624edc6169c55",
2117
+ "type": "process-event-listener",
2118
+ "z": "76c047e0d8770a20",
2119
+ "g": "865723b71ced9418",
2120
+ "name": "",
2121
+ "engine": "42e6796dddd9d4db",
2122
+ "processmodel": "External-Task-Sample_Process",
2123
+ "eventtype": "starting",
2124
+ "query": "{}",
2125
+ "query_type": "json",
2126
+ "x": 160,
2127
+ "y": 140,
2128
+ "wires": [
2129
+ [
2130
+ "2f2ec1cc0213eab5"
2131
+ ]
2132
+ ]
2133
+ },
2134
+ {
2135
+ "id": "2f2ec1cc0213eab5",
2136
+ "type": "debug",
2137
+ "z": "76c047e0d8770a20",
2138
+ "g": "865723b71ced9418",
2139
+ "name": "debug 34",
2140
+ "active": true,
2141
+ "tosidebar": true,
2142
+ "console": false,
2143
+ "tostatus": false,
2144
+ "complete": "false",
2145
+ "statusVal": "",
2146
+ "statusType": "auto",
2147
+ "x": 430,
2148
+ "y": 140,
2149
+ "wires": []
2150
+ },
2151
+ {
2152
+ "id": "bde205e77cd20558",
2153
+ "type": "comment",
2154
+ "z": "76c047e0d8770a20",
2155
+ "g": "865723b71ced9418",
2156
+ "name": "Hört auf die Events der Processe",
2157
+ "info": "",
2158
+ "x": 190,
2159
+ "y": 80,
2160
+ "wires": []
2161
+ },
2162
+ {
2163
+ "id": "03ac7bc273197c45",
2164
+ "type": "process-terminate",
2165
+ "z": "2766c40d84283368",
2166
+ "g": "9081b057a931f0cf",
2167
+ "name": "",
2168
+ "engine": "42e6796dddd9d4db",
2169
+ "x": 170,
2170
+ "y": 140,
2171
+ "wires": [
2172
+ [
2173
+ "bb734a85d4b37728"
2174
+ ]
2175
+ ]
2176
+ },
2177
+ {
2178
+ "id": "bb734a85d4b37728",
2179
+ "type": "debug",
2180
+ "z": "2766c40d84283368",
2181
+ "g": "9081b057a931f0cf",
2182
+ "name": "debug 35",
2183
+ "active": true,
2184
+ "tosidebar": true,
2185
+ "console": false,
2186
+ "tostatus": false,
2187
+ "complete": "false",
2188
+ "statusVal": "",
2189
+ "statusType": "auto",
2190
+ "x": 370,
2191
+ "y": 140,
2192
+ "wires": []
2193
+ },
2194
+ {
2195
+ "id": "3d03550f7d93bfd3",
2196
+ "type": "comment",
2197
+ "z": "2766c40d84283368",
2198
+ "g": "9081b057a931f0cf",
2199
+ "name": "Event for Terminating a Process",
2200
+ "info": "",
2201
+ "x": 210,
2202
+ "y": 80,
2203
+ "wires": []
2097
2204
  }
2098
2205
  ]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@5minds/node-red-contrib-processcube",
3
- "version": "1.5.6",
3
+ "version": "1.5.7-develop-41d845-m3q6c4hg",
4
4
  "license": "MIT",
5
5
  "description": "Node-RED nodes for ProcessCube",
6
6
  "scripts": {
@@ -29,9 +29,10 @@
29
29
  <script type="text/markdown" data-help-name="process-terminate">
30
30
  Terminate an instance of a process model in the ProcessCube.
31
31
 
32
- ## Inputs
32
+ ## Configs
33
33
 
34
- : payload (string): The id of the processinstance that is going to be terminated.
34
+ : name (string): name of the node
35
+ : engine (string): the engine to connect to
35
36
 
36
37
  ## Outputs
37
38
 
@@ -76,6 +76,127 @@ Only models can be queried by setting the `models_only` flag.
76
76
  : processDefinitions / models (Array) : The processDefinitions / models that matched the query.
77
77
  : totalCount (number) : The number of matches.
78
78
 
79
+
80
+ ### Query fields
81
+
82
+ **Summary**:
83
+
84
+ **Description**: Filter result for &#39;ProcessInstance Query&#39;
85
+
86
+ #### Parameters:
87
+ - Name: `offset` Required: `false`
88
+ - Type: number
89
+ - Description: The index of the first ProcessInstance to include in the result set.
90
+ - Name: `limit` Required: `false`
91
+ - Type: number
92
+ - Description: The maximum number of ProcessInstances to return.
93
+ - Name: `correlationId` Required: `false`
94
+ - Type: Array&lt;string&gt; | string | SearchQuery
95
+ - string: myCorrelationId
96
+ - Array&lt;string&gt;: myCorrelationId1,myCorrelationId2
97
+ - object:
98
+ - Description: Filter by the CorrelationId of the ProcessInstances.
99
+ - Name: `processInstanceId` Required: ``
100
+ - Type: Array&lt;string&gt; | string | SearchQuery
101
+ - string: myProcessInstance_12345678
102
+ - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
103
+ - object:
104
+ - Description: Filter by the ID of the ProcessInstances.
105
+ - Name: `processDefinitionId` Required: ``
106
+ - Type: Array&lt;string&gt; | string | SearchQuery
107
+ - string: myProcess_12345678
108
+ - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
109
+ - object:
110
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
111
+ - Name: `processModelId` Required: ``
112
+ - Type: Array&lt;string&gt; | string | SearchQuery
113
+ - string: myProcessModel_12345678
114
+ - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
115
+ - object:
116
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
117
+ - Name: `processModelName` Required: ``
118
+ - Type: Array&lt;string&gt; | string | SearchQuery
119
+ - string: My Process Model
120
+ - Array&lt;string&gt;: My Process Model,My Other Process Model
121
+ - object:
122
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
123
+ - Name: `processModelHash` Required: ``
124
+ - Type: Array&lt;string&gt; | string | SearchQuery
125
+ - string: 12345678
126
+ - Array&lt;string&gt;: 12345678,87654321
127
+ - object:
128
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
129
+ - Name: `ownerId` Required: ``
130
+ - Type: Array&lt;string&gt; | string | SearchQuery
131
+ - string: 12345678
132
+ - Array&lt;string&gt;: 12345678,87654321
133
+ - object:
134
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
135
+ - Name: `state` Required: ``
136
+ - Type: Array&lt;string&gt; | string | SearchQuery
137
+ - string: running
138
+ - Array&lt;string&gt;: running,finished
139
+ - object:
140
+ - Description: Filter by the state of the ProcessInstances.
141
+ - Name: `parentProcessInstanceId` Required: ``
142
+ - Type: Array&lt;string&gt; | string | SearchQuery
143
+ - string: myParentProcessInstance_12345678
144
+ - Array&lt;string&gt;: myParentProcessInstance_12345678,myParentProcessInstance_87654321
145
+ - object:
146
+ - Description: Filter by the ID of the parent ProcessInstance.
147
+ - Name: `embeddedProcessModelId` Required: ``
148
+ - Type: Array&lt;string&gt; | string | SearchQuery
149
+ - string: myModel1
150
+ - Array&lt;string&gt;: myModel1,myModel2
151
+ - object:
152
+ - Description: Filter by the ID of the embedded process model.
153
+ - Name: `terminatedByUserId` Required: ``
154
+ - Type: Array&lt;string&gt; | string | SearchQuery
155
+ - string: 12345678
156
+ - Array&lt;string&gt;: 12345678,87654321
157
+ - object:
158
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
159
+ - Name: `createdBefore` Required: ``
160
+ - Type: string
161
+ - Description: The maximum created date of the ProcessInstances to include in the results.
162
+ - Name: `createdAt` Required: ``
163
+ - Type: Array&lt;string&gt; | string
164
+ - string: 2021-01-01T00:00:00.000Z
165
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
166
+ - Description: The minimum created date of the ProcessInstances to include in the results.
167
+ - Name: `createdAfter` Required: ``
168
+ - Type: string
169
+ - Description: The minimum created date of the ProcessInstances to include in the results.
170
+ - Name: `updatedBefore` Required: ``
171
+ - Type: string
172
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
173
+ - Name: `updatedAt` Required: ``
174
+ - Type: Array&lt;string&gt; | string
175
+ - string: 2021-01-01T00:00:00.000Z
176
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
177
+ - Description: The exact updated date of the ProcessInstances to include in the results.
178
+ - Name: `updatedAfter` Required: ``
179
+ - Type: string
180
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
181
+ - Name: `finishedBefore` Required: ``
182
+ - Type: string
183
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
184
+ - Name: `finishedAt` Required: ``
185
+ - Type: Array&lt;string&gt; | string
186
+ - string: 2021-01-01T00:00:00.000Z
187
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
188
+ - Description: The exact finished date of the ProcessInstances to include in the results.
189
+ - Name: `finishedAfter` Required: ``
190
+ - Type: string
191
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
192
+ - Name: `triggeredByFlowNodeInstance` Required: ``
193
+ - Type: Array&lt;string&gt; | string | SearchQuery
194
+ - string: myFlowNodeInstance_12345678
195
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
196
+ - object:
197
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
198
+
199
+
79
200
  ### References
80
201
 
81
202
  - [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
@@ -45,19 +45,19 @@
45
45
  </script>
46
46
 
47
47
  <script type="text/markdown" data-help-name="processinstance-delete">
48
- Delete old instances of a process model in the ProcessCube.
48
+ Delete old instances of a process model in the ProcessCube.
49
49
 
50
- ## Inputs
50
+ ## Inputs
51
51
 
52
- : payload.time (number): The number of given time periods.
53
- : payload.time_type ('hours' | 'days'): The type of time period to use.
52
+ : payload.time (number): The number of given time periods.
53
+ : payload.time_type ('hours' | 'days'): The type of time period to use.
54
54
 
55
- ## Outputs
55
+ ## Outputs
56
56
 
57
- : payload (string[]): The ids of the processinstances that were deleted.
57
+ : payload (string[]): The ids of the processinstances that were deleted.
58
58
 
59
- ### References
59
+ ### References
60
60
 
61
- - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
62
- - [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
61
+ - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
62
+ - [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
63
63
  </script>
@@ -50,13 +50,127 @@ A node to query process instances on the ProcessCube Engine.
50
50
 
51
51
  ## Inputs
52
52
 
53
- : payload (Object | JSON) : Will be used as the input for the query or can be directly set as JSON.
53
+ : msg (Object | JSON) : The selected field of the *msg*, eg *payload*, will be used as the input for the query or can be directly set as JSON.
54
+ : query (Object) : The query that was used.
54
55
 
55
56
  ## Outputs
56
57
 
57
58
  : processInstances (Array) : The process instances that matched the query.
58
59
  : totalCount (number) : The number of matches.
59
60
 
61
+ ### Query fields
62
+
63
+ **Summary**:
64
+
65
+ **Description**: Gets all ProcessInstances that match the given query.
66
+
67
+ #### Parameters:
68
+ - Name: `offset` Required: `false`
69
+ - Type: number
70
+ - Description: The index of the first ProcessInstance to include in the result set.
71
+ - Name: `limit` Required: `false`
72
+ - Type: number
73
+ - Description: The maximum number of ProcessInstances to return.
74
+ - Name: `correlationId` Required: `false`
75
+ - Type: Array&lt;string&gt; | string | SearchQuery
76
+ - string: myCorrelationId
77
+ - Array&lt;string&gt;: myCorrelationId1,myCorrelationId2
78
+ - object:
79
+ - Description: Filter by the CorrelationId of the ProcessInstances.
80
+ - Name: `processInstanceId` Required: ``
81
+ - Type: Array&lt;string&gt; | string | SearchQuery
82
+ - string: myProcessInstance_12345678
83
+ - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
84
+ - object:
85
+ - Description: Filter by the ID of the ProcessInstances.
86
+ - Name: `processDefinitionId` Required: ``
87
+ - Type: Array&lt;string&gt; | string | SearchQuery
88
+ - string: myProcess_12345678
89
+ - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
90
+ - object:
91
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
92
+ - Name: `processModelId` Required: ``
93
+ - Type: Array&lt;string&gt; | string | SearchQuery
94
+ - string: myProcessModel_12345678
95
+ - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
96
+ - object:
97
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
98
+ - Name: `processModelName` Required: ``
99
+ - Type: Array&lt;string&gt; | string | SearchQuery
100
+ - string: My Process Model
101
+ - Array&lt;string&gt;: My Process Model,My Other Process Model
102
+ - object:
103
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
104
+ - Name: `processModelHash` Required: ``
105
+ - Type: Array&lt;string&gt; | string | SearchQuery
106
+ - string: 12345678
107
+ - Array&lt;string&gt;: 12345678,87654321
108
+ - object:
109
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
110
+ - Name: `ownerId` Required: ``
111
+ - Type: Array&lt;string&gt; | string | SearchQuery
112
+ - string: 12345678
113
+ - Array&lt;string&gt;: 12345678,87654321
114
+ - object:
115
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
116
+ - Name: `state` Required: ``
117
+ - Type: Array&lt;string&gt; | string | SearchQuery
118
+ - string: running
119
+ - Array&lt;string&gt;: running,finished
120
+ - object:
121
+ - Description: Filter by the state of the ProcessInstances.
122
+ - Name: `parentProcessInstanceId` Required: ``
123
+ - Type: Array&lt;string&gt; | string | SearchQuery
124
+ - string: myParentProcessInstance_12345678
125
+ - Array&lt;string&gt;: myParentProcessInstance_12345678,myParentProcessInstance_87654321
126
+ - object:
127
+ - Description: Filter by the ID of the parent ProcessInstance.
128
+ - Name: `terminatedByUserId` Required: ``
129
+ - Type: Array&lt;string&gt; | string | SearchQuery
130
+ - string: 12345678
131
+ - Array&lt;string&gt;: 12345678,87654321
132
+ - object:
133
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
134
+ - Name: `createdBefore` Required: ``
135
+ - Type: string
136
+ - Description: The maximum created date of the ProcessInstances to include in the results.
137
+ - Name: `createdAt` Required: ``
138
+ - Type: Array&lt;string&gt; | string
139
+ - string: 2021-01-01T00:00:00.000Z
140
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
141
+ - Description: The minimum created date of the ProcessInstances to include in the results.
142
+ - Name: `createdAfter` Required: ``
143
+ - Type: string
144
+ - Description: The minimum created date of the ProcessInstances to include in the results.
145
+ - Name: `updatedBefore` Required: ``
146
+ - Type: string
147
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
148
+ - Name: `updatedAt` Required: ``
149
+ - Type: Array&lt;string&gt; | string
150
+ - string: 2021-01-01T00:00:00.000Z
151
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
152
+ - Description: The exact updated date of the ProcessInstances to include in the results.
153
+ - Name: `updatedAfter` Required: ``
154
+ - Type: string
155
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
156
+ - Name: `finishedBefore` Required: ``
157
+ - Type: string
158
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
159
+ - Name: `finishedAt` Required: ``
160
+ - Type: Array&lt;string&gt; | string
161
+ - string: 2021-01-01T00:00:00.000Z
162
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
163
+ - Description: The exact finished date of the ProcessInstances to include in the results.
164
+ - Name: `finishedAfter` Required: ``
165
+ - Type: string
166
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
167
+ - Name: `triggeredByFlowNodeInstance` Required: ``
168
+ - Type: Array&lt;string&gt; | string | SearchQuery
169
+ - string: myFlowNodeInstance_12345678
170
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
171
+ - object:
172
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
173
+
60
174
  ### References
61
175
 
62
176
  - [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
@@ -74,6 +74,127 @@ A node which listens for events triggered by usertasks
74
74
  : action (string): The event that occured.
75
75
  : type (string): The target of the event.
76
76
 
77
+
78
+ ### Query fields
79
+
80
+ **Summary**:
81
+
82
+ **Description**: Filter result for &#39;UserTask Event Listener&#39;
83
+
84
+ #### Parameters:
85
+ - Name: `offset` Required: `false`
86
+ - Type: number
87
+ - Description: The index of the first ProcessInstance to include in the result set.
88
+ - Name: `limit` Required: `false`
89
+ - Type: number
90
+ - Description: The maximum number of ProcessInstances to return.
91
+ - Name: `correlationId` Required: `false`
92
+ - Type: Array&lt;string&gt; | string | SearchQuery
93
+ - string: myCorrelationId
94
+ - Array&lt;string&gt;: myCorrelationId1,myCorrelationId2
95
+ - object:
96
+ - Description: Filter by the CorrelationId of the ProcessInstances.
97
+ - Name: `processInstanceId` Required: ``
98
+ - Type: Array&lt;string&gt; | string | SearchQuery
99
+ - string: myProcessInstance_12345678
100
+ - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
101
+ - object:
102
+ - Description: Filter by the ID of the ProcessInstances.
103
+ - Name: `processDefinitionId` Required: ``
104
+ - Type: Array&lt;string&gt; | string | SearchQuery
105
+ - string: myProcess_12345678
106
+ - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
107
+ - object:
108
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
109
+ - Name: `processModelId` Required: ``
110
+ - Type: Array&lt;string&gt; | string | SearchQuery
111
+ - string: myProcessModel_12345678
112
+ - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
113
+ - object:
114
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
115
+ - Name: `processModelName` Required: ``
116
+ - Type: Array&lt;string&gt; | string | SearchQuery
117
+ - string: My Process Model
118
+ - Array&lt;string&gt;: My Process Model,My Other Process Model
119
+ - object:
120
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
121
+ - Name: `processModelHash` Required: ``
122
+ - Type: Array&lt;string&gt; | string | SearchQuery
123
+ - string: 12345678
124
+ - Array&lt;string&gt;: 12345678,87654321
125
+ - object:
126
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
127
+ - Name: `ownerId` Required: ``
128
+ - Type: Array&lt;string&gt; | string | SearchQuery
129
+ - string: 12345678
130
+ - Array&lt;string&gt;: 12345678,87654321
131
+ - object:
132
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
133
+ - Name: `state` Required: ``
134
+ - Type: Array&lt;string&gt; | string | SearchQuery
135
+ - string: running
136
+ - Array&lt;string&gt;: running,finished
137
+ - object:
138
+ - Description: Filter by the state of the ProcessInstances.
139
+ - Name: `parentProcessInstanceId` Required: ``
140
+ - Type: Array&lt;string&gt; | string | SearchQuery
141
+ - string: myParentProcessInstance_12345678
142
+ - Array&lt;string&gt;: myParentProcessInstance_12345678,myParentProcessInstance_87654321
143
+ - object:
144
+ - Description: Filter by the ID of the parent ProcessInstance.
145
+ - Name: `embeddedProcessModelId` Required: ``
146
+ - Type: Array&lt;string&gt; | string | SearchQuery
147
+ - string: myModel1
148
+ - Array&lt;string&gt;: myModel1,myModel2
149
+ - object:
150
+ - Description: Filter by the ID of the embedded process model.
151
+ - Name: `terminatedByUserId` Required: ``
152
+ - Type: Array&lt;string&gt; | string | SearchQuery
153
+ - string: 12345678
154
+ - Array&lt;string&gt;: 12345678,87654321
155
+ - object:
156
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
157
+ - Name: `createdBefore` Required: ``
158
+ - Type: string
159
+ - Description: The maximum created date of the ProcessInstances to include in the results.
160
+ - Name: `createdAt` Required: ``
161
+ - Type: Array&lt;string&gt; | string
162
+ - string: 2021-01-01T00:00:00.000Z
163
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
164
+ - Description: The minimum created date of the ProcessInstances to include in the results.
165
+ - Name: `createdAfter` Required: ``
166
+ - Type: string
167
+ - Description: The minimum created date of the ProcessInstances to include in the results.
168
+ - Name: `updatedBefore` Required: ``
169
+ - Type: string
170
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
171
+ - Name: `updatedAt` Required: ``
172
+ - Type: Array&lt;string&gt; | string
173
+ - string: 2021-01-01T00:00:00.000Z
174
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
175
+ - Description: The exact updated date of the ProcessInstances to include in the results.
176
+ - Name: `updatedAfter` Required: ``
177
+ - Type: string
178
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
179
+ - Name: `finishedBefore` Required: ``
180
+ - Type: string
181
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
182
+ - Name: `finishedAt` Required: ``
183
+ - Type: Array&lt;string&gt; | string
184
+ - string: 2021-01-01T00:00:00.000Z
185
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
186
+ - Description: The exact finished date of the ProcessInstances to include in the results.
187
+ - Name: `finishedAfter` Required: ``
188
+ - Type: string
189
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
190
+ - Name: `triggeredByFlowNodeInstance` Required: ``
191
+ - Type: Array&lt;string&gt; | string | SearchQuery
192
+ - string: myFlowNodeInstance_12345678
193
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
194
+ - object:
195
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
196
+
197
+
77
198
  ### References
78
199
 
79
200
  - [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform