@5minds/node-red-contrib-processcube 1.7.5-develop-106e2c-m6jdhezm → 1.7.5-feature-f9d61e-m6l18es1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.processcube/nodered/.config.nodes.json +1 -1
- package/.processcube/nodered/config.js +2 -3
- package/.processcube/nodered/settings.js +1 -1
- package/README.md +8 -2
- package/doc_generator/generator.js +5 -5
- package/doc_generator/generator_with_swagger.js +80 -78
- package/endevent-finished-listener.html +16 -16
- package/externaltask-error.html +11 -11
- package/externaltask-error.js +3 -1
- package/externaltask-event-listener.html +9 -9
- package/externaltask-input.html +26 -26
- package/externaltask-input.js +6 -7
- package/externaltask-output.html +7 -7
- package/message-event-trigger.html +8 -8
- package/message-event-trigger.js +3 -0
- package/package.json +5 -2
- package/process-event-listener.html +74 -74
- package/process-event-listener.js +1 -2
- package/process-start.html +12 -12
- package/process-start.js +6 -3
- package/process-terminate.html +9 -9
- package/process-terminate.js +3 -1
- package/processcube-engine-config.html +8 -8
- package/processcube-engine-config.js +0 -2
- package/processdefinition-deploy.html +9 -9
- package/processdefinition-deploy.js +4 -2
- package/processdefinition-query.html +139 -140
- package/processdefinition-query.js +4 -0
- package/processinstance-delete.html +48 -46
- package/processinstance-delete.js +24 -9
- package/processinstance-query.html +120 -119
- package/processinstance-query.js +3 -1
- package/signal-event-trigger.html +8 -9
- package/signal-event-trigger.js +3 -0
- package/usertask-event-listener.html +126 -127
- package/usertask-input.html +126 -125
- package/usertask-input.js +3 -1
- package/usertask-output.html +7 -7
- package/usertask-output.js +5 -2
- package/wait-for-usertask.html +173 -164
- package/wait-for-usertask.js +36 -25
@@ -46,133 +46,134 @@
|
|
46
46
|
</script>
|
47
47
|
|
48
48
|
<script type="text/markdown" data-help-name="processinstance-query">
|
49
|
-
A node to query process instances on the ProcessCube Engine.
|
49
|
+
A node to query process instances on the ProcessCube Engine.
|
50
50
|
|
51
|
-
## Inputs
|
51
|
+
## Inputs
|
52
52
|
|
53
|
-
: msg (Object | JSON) : The selected field of the
|
54
|
-
: query (Object) : The query that was used.
|
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.
|
55
55
|
|
56
|
-
## Outputs
|
56
|
+
## Outputs
|
57
57
|
|
58
|
-
: processInstances (Array) : The process instances that matched the query.
|
59
|
-
: totalCount (number) : The number of matches.
|
58
|
+
: processInstances (Array) : The process instances that matched the query.
|
59
|
+
: totalCount (number) : The number of matches.
|
60
60
|
|
61
|
-
### Query fields
|
61
|
+
### Query fields
|
62
62
|
|
63
|
-
**Summary**:
|
63
|
+
**Summary**:
|
64
64
|
|
65
|
-
**Description**: Gets all ProcessInstances that match the given query.
|
65
|
+
**Description**: Gets all ProcessInstances that match the given query.
|
66
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<string> | string | SearchQuery
|
76
|
-
- string: myCorrelationId
|
77
|
-
- Array<string>: myCorrelationId1,myCorrelationId2
|
78
|
-
- object:
|
79
|
-
- Description: Filter by the CorrelationId of the ProcessInstances.
|
80
|
-
- Name: `processInstanceId` Required: ``
|
81
|
-
- Type: Array<string> | string | SearchQuery
|
82
|
-
- string: myProcessInstance_12345678
|
83
|
-
- Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
|
84
|
-
- object:
|
85
|
-
- Description: Filter by the ID of the ProcessInstances.
|
86
|
-
- Name: `processDefinitionId` Required: ``
|
87
|
-
- Type: Array<string> | string | SearchQuery
|
88
|
-
- string: myProcess_12345678
|
89
|
-
- Array<string>: 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<string> | string | SearchQuery
|
94
|
-
- string: myProcessModel_12345678
|
95
|
-
- Array<string>: 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<string> | string | SearchQuery
|
100
|
-
- string: My Process Model
|
101
|
-
- Array<string>: 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<string> | string | SearchQuery
|
106
|
-
- string: 12345678
|
107
|
-
- Array<string>: 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<string> | string | SearchQuery
|
112
|
-
- string: 12345678
|
113
|
-
- Array<string>: 12345678,87654321
|
114
|
-
- object:
|
115
|
-
- Description: Filter by the ID of the User that owns the ProcessInstances.
|
116
|
-
- Name: `state` Required: ``
|
117
|
-
- Type: Array<string> | string | SearchQuery
|
118
|
-
- string: running
|
119
|
-
- Array<string>: running,finished
|
120
|
-
- object:
|
121
|
-
- Description: Filter by the state of the ProcessInstances.
|
122
|
-
- Name: `parentProcessInstanceId` Required: ``
|
123
|
-
- Type: Array<string> | string | SearchQuery
|
124
|
-
- string: myParentProcessInstance_12345678
|
125
|
-
- Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
|
126
|
-
- object:
|
127
|
-
- Description: Filter by the ID of the parent ProcessInstance.
|
128
|
-
- Name: `terminatedByUserId` Required: ``
|
129
|
-
- Type: Array<string> | string | SearchQuery
|
130
|
-
- string: 12345678
|
131
|
-
- Array<string>: 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<string> | 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<string> | 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<string> | 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<string> | 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.
|
67
|
+
#### Parameters:
|
173
68
|
|
174
|
-
|
69
|
+
- Name: `offset` Required: `false`
|
70
|
+
- Type: number
|
71
|
+
- Description: The index of the first ProcessInstance to include in the result set.
|
72
|
+
- Name: `limit` Required: `false`
|
73
|
+
- Type: number
|
74
|
+
- Description: The maximum number of ProcessInstances to return.
|
75
|
+
- Name: `correlationId` Required: `false`
|
76
|
+
- Type: Array<string> | string | SearchQuery
|
77
|
+
- string: myCorrelationId
|
78
|
+
- Array<string>: myCorrelationId1,myCorrelationId2
|
79
|
+
- object:
|
80
|
+
- Description: Filter by the CorrelationId of the ProcessInstances.
|
81
|
+
- Name: `processInstanceId` Required: ``
|
82
|
+
- Type: Array<string> | string | SearchQuery
|
83
|
+
- string: myProcessInstance_12345678
|
84
|
+
- Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
|
85
|
+
- object:
|
86
|
+
- Description: Filter by the ID of the ProcessInstances.
|
87
|
+
- Name: `processDefinitionId` Required: ``
|
88
|
+
- Type: Array<string> | string | SearchQuery
|
89
|
+
- string: myProcess_12345678
|
90
|
+
- Array<string>: myProcess_12345678,myProcess_87654321
|
91
|
+
- object:
|
92
|
+
- Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
|
93
|
+
- Name: `processModelId` Required: ``
|
94
|
+
- Type: Array<string> | string | SearchQuery
|
95
|
+
- string: myProcessModel_12345678
|
96
|
+
- Array<string>: myProcessModel_12345678,myProcessModel_87654321
|
97
|
+
- object:
|
98
|
+
- Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
|
99
|
+
- Name: `processModelName` Required: ``
|
100
|
+
- Type: Array<string> | string | SearchQuery
|
101
|
+
- string: My Process Model
|
102
|
+
- Array<string>: My Process Model,My Other Process Model
|
103
|
+
- object:
|
104
|
+
- Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
|
105
|
+
- Name: `processModelHash` Required: ``
|
106
|
+
- Type: Array<string> | string | SearchQuery
|
107
|
+
- string: 12345678
|
108
|
+
- Array<string>: 12345678,87654321
|
109
|
+
- object:
|
110
|
+
- Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
|
111
|
+
- Name: `ownerId` Required: ``
|
112
|
+
- Type: Array<string> | string | SearchQuery
|
113
|
+
- string: 12345678
|
114
|
+
- Array<string>: 12345678,87654321
|
115
|
+
- object:
|
116
|
+
- Description: Filter by the ID of the User that owns the ProcessInstances.
|
117
|
+
- Name: `state` Required: ``
|
118
|
+
- Type: Array<string> | string | SearchQuery
|
119
|
+
- string: running
|
120
|
+
- Array<string>: running,finished
|
121
|
+
- object:
|
122
|
+
- Description: Filter by the state of the ProcessInstances.
|
123
|
+
- Name: `parentProcessInstanceId` Required: ``
|
124
|
+
- Type: Array<string> | string | SearchQuery
|
125
|
+
- string: myParentProcessInstance_12345678
|
126
|
+
- Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
|
127
|
+
- object:
|
128
|
+
- Description: Filter by the ID of the parent ProcessInstance.
|
129
|
+
- Name: `terminatedByUserId` Required: ``
|
130
|
+
- Type: Array<string> | string | SearchQuery
|
131
|
+
- string: 12345678
|
132
|
+
- Array<string>: 12345678,87654321
|
133
|
+
- object:
|
134
|
+
- Description: Filter by the ID of the User that terminated the ProcessInstances.
|
135
|
+
- Name: `createdBefore` Required: ``
|
136
|
+
- Type: string
|
137
|
+
- Description: The maximum created date of the ProcessInstances to include in the results.
|
138
|
+
- Name: `createdAt` Required: ``
|
139
|
+
- Type: Array<string> | string
|
140
|
+
- string: 2021-01-01T00:00:00.000Z
|
141
|
+
- array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
|
142
|
+
- Description: The minimum created date of the ProcessInstances to include in the results.
|
143
|
+
- Name: `createdAfter` Required: ``
|
144
|
+
- Type: string
|
145
|
+
- Description: The minimum created date of the ProcessInstances to include in the results.
|
146
|
+
- Name: `updatedBefore` Required: ``
|
147
|
+
- Type: string
|
148
|
+
- Description: The maximum updated date of the ProcessInstances to include in the results.
|
149
|
+
- Name: `updatedAt` Required: ``
|
150
|
+
- Type: Array<string> | string
|
151
|
+
- string: 2021-01-01T00:00:00.000Z
|
152
|
+
- array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
|
153
|
+
- Description: The exact updated date of the ProcessInstances to include in the results.
|
154
|
+
- Name: `updatedAfter` Required: ``
|
155
|
+
- Type: string
|
156
|
+
- Description: The minimum updated date of the ProcessInstances to include in the results.
|
157
|
+
- Name: `finishedBefore` Required: ``
|
158
|
+
- Type: string
|
159
|
+
- Description: The maximum finished date of the ProcessInstances to include in the results.
|
160
|
+
- Name: `finishedAt` Required: ``
|
161
|
+
- Type: Array<string> | 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 exact finished date of the ProcessInstances to include in the results.
|
165
|
+
- Name: `finishedAfter` Required: ``
|
166
|
+
- Type: string
|
167
|
+
- Description: The minimum finished date of the ProcessInstances to include in the results.
|
168
|
+
- Name: `triggeredByFlowNodeInstance` Required: ``
|
169
|
+
- Type: Array<string> | string | SearchQuery
|
170
|
+
- string: myFlowNodeInstance_12345678
|
171
|
+
- array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
|
172
|
+
- object:
|
173
|
+
- Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
|
175
174
|
|
176
|
-
|
177
|
-
|
175
|
+
### References
|
176
|
+
|
177
|
+
- [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
|
178
|
+
- [ProcessCube© LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube©
|
178
179
|
</script>
|
package/processinstance-query.js
CHANGED
@@ -8,6 +8,8 @@ module.exports = function (RED) {
|
|
8
8
|
|
9
9
|
node.engine = RED.nodes.getNode(config.engine);
|
10
10
|
const client = node.engine.engineClient;
|
11
|
+
const isUser = !!msg._client?.user;
|
12
|
+
const userIdentity = isUser ? { userId: msg._client.user.id, token: msg._client.user.accessToken } : null;
|
11
13
|
|
12
14
|
if (!client) {
|
13
15
|
node.error('No engine configured.', msg);
|
@@ -15,7 +17,7 @@ module.exports = function (RED) {
|
|
15
17
|
}
|
16
18
|
|
17
19
|
client.processInstances
|
18
|
-
.query(query)
|
20
|
+
.query(query, { identity: userIdentity })
|
19
21
|
.then((matchingInstances) => {
|
20
22
|
msg.payload = matchingInstances;
|
21
23
|
|
@@ -29,21 +29,20 @@
|
|
29
29
|
<label for="node-input-signalname"><i class="fa fa-tag"></i> Signal Name</label>
|
30
30
|
<input type="text" id="node-input-signalname" placeholder="Name of the Signal" />
|
31
31
|
</div>
|
32
|
-
|
33
32
|
</script>
|
34
33
|
|
35
34
|
<script type="text/markdown" data-help-name="signal-event-trigger">
|
36
|
-
A node which emmits a signal event to the Engine.
|
35
|
+
A node which emmits a signal event to the Engine.
|
37
36
|
|
38
|
-
From the config the `signalname` and the `processInstanceId` must be set.
|
37
|
+
From the config the `signalname` and the `processInstanceId` must be set.
|
39
38
|
|
40
|
-
## Inputs
|
39
|
+
## Inputs
|
41
40
|
|
42
|
-
: payload (Object) : Will sent to the event and used an new token payload.
|
43
|
-
: processInstanceId (string) : The process instance where the signal event should be triggered.
|
41
|
+
: payload (Object) : Will sent to the event and used an new token payload.
|
42
|
+
: processInstanceId (string) : The process instance where the signal event should be triggered.
|
44
43
|
|
45
|
-
### References
|
44
|
+
### References
|
46
45
|
|
47
|
-
-
|
48
|
-
-
|
46
|
+
- [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
|
47
|
+
- [ProcessCube© LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube©
|
49
48
|
</script>
|
package/signal-event-trigger.js
CHANGED
@@ -7,6 +7,8 @@ module.exports = function (RED) {
|
|
7
7
|
node.engine = RED.nodes.getNode(config.engine);
|
8
8
|
|
9
9
|
const client = node.engine.engineClient;
|
10
|
+
const isUser = !!msg._client?.user;
|
11
|
+
const userIdentity = isUser ? { userId: msg._client.user.id, token: msg._client.user.accessToken } : null;
|
10
12
|
|
11
13
|
if (!client) {
|
12
14
|
node.error('No engine configured.', msg);
|
@@ -17,6 +19,7 @@ module.exports = function (RED) {
|
|
17
19
|
.triggerSignalEvent(config.signalname, {
|
18
20
|
processInstanceId: msg.processinstanceid,
|
19
21
|
payload: msg.payload,
|
22
|
+
identity: userIdentity,
|
20
23
|
})
|
21
24
|
.then((result) => {
|
22
25
|
msg.payload = result;
|
@@ -27,7 +27,7 @@
|
|
27
27
|
},
|
28
28
|
oneditsave: function () {
|
29
29
|
if ($('#node-input-query').typedInput('value') == '') {
|
30
|
-
$('#node-input-query').typedInput('value', '{}')
|
30
|
+
$('#node-input-query').typedInput('value', '{}');
|
31
31
|
}
|
32
32
|
(this.query = $('#node-input-query').typedInput('value')),
|
33
33
|
(this.query_type = $('#node-input-query').typedInput('type'));
|
@@ -64,139 +64,138 @@
|
|
64
64
|
</script>
|
65
65
|
|
66
66
|
<script type="text/markdown" data-help-name="usertask-event-listener">
|
67
|
-
A node which listens for events triggered by usertasks
|
67
|
+
A node which listens for events triggered by usertasks
|
68
68
|
|
69
|
-
## Outputs
|
69
|
+
## Outputs
|
70
70
|
|
71
|
-
: flowNodeInstanceId (string): The unique identifier for the usertask instance.
|
72
|
-
: userTaskEvent (Object): An Object representing the event returned by the engine.
|
73
|
-
: processInstance (Object): An Object representing the process instance data.
|
74
|
-
: action (string): The event that occured.
|
75
|
-
: type (string): The target of the event.
|
71
|
+
: flowNodeInstanceId (string): The unique identifier for the usertask instance.
|
72
|
+
: userTaskEvent (Object): An Object representing the event returned by the engine.
|
73
|
+
: processInstance (Object): An Object representing the process instance data.
|
74
|
+
: action (string): The event that occured.
|
75
|
+
: type (string): The target of the event.
|
76
76
|
|
77
|
+
### Query fields
|
77
78
|
|
78
|
-
|
79
|
+
**Summary**:
|
79
80
|
|
80
|
-
**
|
81
|
+
**Description**: Filter result for 'UserTask Event Listener'
|
81
82
|
|
82
|
-
|
83
|
+
#### Parameters:
|
83
84
|
|
84
|
-
|
85
|
-
-
|
86
|
-
|
87
|
-
|
88
|
-
-
|
89
|
-
|
90
|
-
|
91
|
-
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
-
|
158
|
-
|
159
|
-
|
160
|
-
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
-
|
166
|
-
|
167
|
-
|
168
|
-
-
|
169
|
-
|
170
|
-
|
171
|
-
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
-
|
177
|
-
|
178
|
-
|
179
|
-
-
|
180
|
-
|
181
|
-
|
182
|
-
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
-
|
188
|
-
|
189
|
-
|
190
|
-
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
- Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
|
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<string> | string | SearchQuery
|
93
|
+
- string: myCorrelationId
|
94
|
+
- Array<string>: myCorrelationId1,myCorrelationId2
|
95
|
+
- object:
|
96
|
+
- Description: Filter by the CorrelationId of the ProcessInstances.
|
97
|
+
- Name: `processInstanceId` Required: ``
|
98
|
+
- Type: Array<string> | string | SearchQuery
|
99
|
+
- string: myProcessInstance_12345678
|
100
|
+
- Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
|
101
|
+
- object:
|
102
|
+
- Description: Filter by the ID of the ProcessInstances.
|
103
|
+
- Name: `processDefinitionId` Required: ``
|
104
|
+
- Type: Array<string> | string | SearchQuery
|
105
|
+
- string: myProcess_12345678
|
106
|
+
- Array<string>: 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<string> | string | SearchQuery
|
111
|
+
- string: myProcessModel_12345678
|
112
|
+
- Array<string>: 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<string> | string | SearchQuery
|
117
|
+
- string: My Process Model
|
118
|
+
- Array<string>: 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<string> | string | SearchQuery
|
123
|
+
- string: 12345678
|
124
|
+
- Array<string>: 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<string> | string | SearchQuery
|
129
|
+
- string: 12345678
|
130
|
+
- Array<string>: 12345678,87654321
|
131
|
+
- object:
|
132
|
+
- Description: Filter by the ID of the User that owns the ProcessInstances.
|
133
|
+
- Name: `state` Required: ``
|
134
|
+
- Type: Array<string> | string | SearchQuery
|
135
|
+
- string: running
|
136
|
+
- Array<string>: running,finished
|
137
|
+
- object:
|
138
|
+
- Description: Filter by the state of the ProcessInstances.
|
139
|
+
- Name: `parentProcessInstanceId` Required: ``
|
140
|
+
- Type: Array<string> | string | SearchQuery
|
141
|
+
- string: myParentProcessInstance_12345678
|
142
|
+
- Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
|
143
|
+
- object:
|
144
|
+
- Description: Filter by the ID of the parent ProcessInstance.
|
145
|
+
- Name: `embeddedProcessModelId` Required: ``
|
146
|
+
- Type: Array<string> | string | SearchQuery
|
147
|
+
- string: myModel1
|
148
|
+
- Array<string>: myModel1,myModel2
|
149
|
+
- object:
|
150
|
+
- Description: Filter by the ID of the embedded process model.
|
151
|
+
- Name: `terminatedByUserId` Required: ``
|
152
|
+
- Type: Array<string> | string | SearchQuery
|
153
|
+
- string: 12345678
|
154
|
+
- Array<string>: 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<string> | 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<string> | 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<string> | 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<string> | 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
196
|
|
197
|
+
### References
|
197
198
|
|
198
|
-
|
199
|
-
|
200
|
-
- [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
|
201
|
-
- [ProcessCube© LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube©
|
199
|
+
- [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
|
200
|
+
- [ProcessCube© LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube©
|
202
201
|
</script>
|