@5minds/node-red-contrib-processcube 1.5.4-develop-5e0b5a-m36zyoaj → 1.5.5-feature-4b765c-m3eudoth

Sign up to get free protection for your applications and to get access to all the features.
Files changed (19) hide show
  1. package/doc_generator/_process_instances_query.md +121 -0
  2. package/doc_generator/generator.js +41 -0
  3. package/doc_generator/generator_with_swagger.js +89 -0
  4. package/doc_generator/outputs/.gitkeep +0 -0
  5. package/doc_generator/package-lock.json +176 -0
  6. package/doc_generator/package.json +15 -0
  7. package/doc_generator/query_template.mustache +20 -0
  8. package/doc_generator/swagger.json +4110 -0
  9. package/externaltask-input.html +16 -1
  10. package/externaltask-input.js +9 -2
  11. package/nodered/flows.json +157 -1
  12. package/package.json +1 -1
  13. package/process-terminate.html +3 -2
  14. package/processdefinition-query.html +121 -0
  15. package/processinstance-delete.html +9 -9
  16. package/processinstance-query.html +115 -1
  17. package/usertask-event-listener.html +121 -0
  18. package/usertask-input.html +119 -0
  19. package/wait-for-usertask.html +119 -0
package/usertask-event-listener.html CHANGED
@@ -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 'UserTask Event Listener'
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<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
+
197
+
77
198
  ### References
78
199
 
79
200
  - [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
package/usertask-input.html CHANGED
@@ -65,6 +65,125 @@ A node which sends a payload to a usertask in the ProcessCube.
65
65
  : force_send_array (Boolean) : Will be used to force the payload to be sent as an array.
66
66
  : multisend (Boolean) : Will be used to send one output of each usertask input.
67
67
 
68
+ ### Query fields
69
+
70
+ **Summary**:
71
+
72
+ **Description**: Filter result for 'UserTasks Input'
73
+
74
+ #### Parameters:
75
+ - Name: `offset` Required: `false`
76
+ - Type: number
77
+ - Description: The index of the first ProcessInstance to include in the result set.
78
+ - Name: `limit` Required: `false`
79
+ - Type: number
80
+ - Description: The maximum number of ProcessInstances to return.
81
+ - Name: `correlationId` Required: `false`
82
+ - Type: Array<string> | string | SearchQuery
83
+ - string: myCorrelationId
84
+ - Array<string>: myCorrelationId1,myCorrelationId2
85
+ - object:
86
+ - Description: Filter by the CorrelationId of the ProcessInstances.
87
+ - Name: `processInstanceId` Required: ``
88
+ - Type: Array<string> | string | SearchQuery
89
+ - string: myProcessInstance_12345678
90
+ - Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
91
+ - object:
92
+ - Description: Filter by the ID of the ProcessInstances.
93
+ - Name: `processDefinitionId` Required: ``
94
+ - Type: Array<string> | string | SearchQuery
95
+ - string: myProcess_12345678
96
+ - Array<string>: myProcess_12345678,myProcess_87654321
97
+ - object:
98
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
99
+ - Name: `processModelId` Required: ``
100
+ - Type: Array<string> | string | SearchQuery
101
+ - string: myProcessModel_12345678
102
+ - Array<string>: myProcessModel_12345678,myProcessModel_87654321
103
+ - object:
104
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
105
+ - Name: `processModelName` Required: ``
106
+ - Type: Array<string> | string | SearchQuery
107
+ - string: My Process Model
108
+ - Array<string>: My Process Model,My Other Process Model
109
+ - object:
110
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
111
+ - Name: `processModelHash` Required: ``
112
+ - Type: Array<string> | string | SearchQuery
113
+ - string: 12345678
114
+ - Array<string>: 12345678,87654321
115
+ - object:
116
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
117
+ - Name: `ownerId` Required: ``
118
+ - Type: Array<string> | string | SearchQuery
119
+ - string: 12345678
120
+ - Array<string>: 12345678,87654321
121
+ - object:
122
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
123
+ - Name: `state` Required: ``
124
+ - Type: Array<string> | string | SearchQuery
125
+ - string: running
126
+ - Array<string>: running,finished
127
+ - object:
128
+ - Description: Filter by the state of the ProcessInstances.
129
+ - Name: `parentProcessInstanceId` Required: ``
130
+ - Type: Array<string> | string | SearchQuery
131
+ - string: myParentProcessInstance_12345678
132
+ - Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
133
+ - object:
134
+ - Description: Filter by the ID of the parent ProcessInstance.
135
+ - Name: `embeddedProcessModelId` Required: ``
136
+ - Type: Array<string> | string | SearchQuery
137
+ - string: myModel1
138
+ - Array<string>: myModel1,myModel2
139
+ - object:
140
+ - Description: Filter by the ID of the embedded process model.
141
+ - Name: `terminatedByUserId` Required: ``
142
+ - Type: Array<string> | string | SearchQuery
143
+ - string: 12345678
144
+ - Array<string>: 12345678,87654321
145
+ - object:
146
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
147
+ - Name: `createdBefore` Required: ``
148
+ - Type: string
149
+ - Description: The maximum created date of the ProcessInstances to include in the results.
150
+ - Name: `createdAt` Required: ``
151
+ - Type: Array<string> | string
152
+ - string: 2021-01-01T00:00:00.000Z
153
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
154
+ - Description: The minimum created date of the ProcessInstances to include in the results.
155
+ - Name: `createdAfter` Required: ``
156
+ - Type: string
157
+ - Description: The minimum created date of the ProcessInstances to include in the results.
158
+ - Name: `updatedBefore` Required: ``
159
+ - Type: string
160
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
161
+ - Name: `updatedAt` Required: ``
162
+ - Type: Array<string> | string
163
+ - string: 2021-01-01T00:00:00.000Z
164
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
165
+ - Description: The exact updated date of the ProcessInstances to include in the results.
166
+ - Name: `updatedAfter` Required: ``
167
+ - Type: string
168
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
169
+ - Name: `finishedBefore` Required: ``
170
+ - Type: string
171
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
172
+ - Name: `finishedAt` Required: ``
173
+ - Type: Array<string> | string
174
+ - string: 2021-01-01T00:00:00.000Z
175
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
176
+ - Description: The exact finished date of the ProcessInstances to include in the results.
177
+ - Name: `finishedAfter` Required: ``
178
+ - Type: string
179
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
180
+ - Name: `triggeredByFlowNodeInstance` Required: ``
181
+ - Type: Array<string> | string | SearchQuery
182
+ - string: myFlowNodeInstance_12345678
183
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
184
+ - object:
185
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
186
+
68
187
  ### References
69
188
 
70
189
  - [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
package/wait-for-usertask.html CHANGED
@@ -70,6 +70,125 @@ Waiting for Usertasks of the connected ProcessCube Engine.
70
70
  - `msg.payload` or a constant json to filter the UserTasks for Waiting for
71
71
  - `Only for new` will trigger only for new UserTasks if checked and also for old ones if not checked.
72
72
 
73
+ ### Query fields
74
+
75
+ **Summary**:
76
+
77
+ **Description**: Filter result for 'Wait for UserTask'
78
+
79
+ #### Parameters:
80
+ - Name: `offset` Required: `false`
81
+ - Type: number
82
+ - Description: The index of the first ProcessInstance to include in the result set.
83
+ - Name: `limit` Required: `false`
84
+ - Type: number
85
+ - Description: The maximum number of ProcessInstances to return.
86
+ - Name: `correlationId` Required: `false`
87
+ - Type: Array<string> | string | SearchQuery
88
+ - string: myCorrelationId
89
+ - Array<string>: myCorrelationId1,myCorrelationId2
90
+ - object:
91
+ - Description: Filter by the CorrelationId of the ProcessInstances.
92
+ - Name: `processInstanceId` Required: ``
93
+ - Type: Array<string> | string | SearchQuery
94
+ - string: myProcessInstance_12345678
95
+ - Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
96
+ - object:
97
+ - Description: Filter by the ID of the ProcessInstances.
98
+ - Name: `processDefinitionId` Required: ``
99
+ - Type: Array<string> | string | SearchQuery
100
+ - string: myProcess_12345678
101
+ - Array<string>: myProcess_12345678,myProcess_87654321
102
+ - object:
103
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
104
+ - Name: `processModelId` Required: ``
105
+ - Type: Array<string> | string | SearchQuery
106
+ - string: myProcessModel_12345678
107
+ - Array<string>: myProcessModel_12345678,myProcessModel_87654321
108
+ - object:
109
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
110
+ - Name: `processModelName` Required: ``
111
+ - Type: Array<string> | string | SearchQuery
112
+ - string: My Process Model
113
+ - Array<string>: My Process Model,My Other Process Model
114
+ - object:
115
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
116
+ - Name: `processModelHash` Required: ``
117
+ - Type: Array<string> | string | SearchQuery
118
+ - string: 12345678
119
+ - Array<string>: 12345678,87654321
120
+ - object:
121
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
122
+ - Name: `ownerId` Required: ``
123
+ - Type: Array<string> | string | SearchQuery
124
+ - string: 12345678
125
+ - Array<string>: 12345678,87654321
126
+ - object:
127
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
128
+ - Name: `state` Required: ``
129
+ - Type: Array<string> | string | SearchQuery
130
+ - string: running
131
+ - Array<string>: running,finished
132
+ - object:
133
+ - Description: Filter by the state of the ProcessInstances.
134
+ - Name: `parentProcessInstanceId` Required: ``
135
+ - Type: Array<string> | string | SearchQuery
136
+ - string: myParentProcessInstance_12345678
137
+ - Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
138
+ - object:
139
+ - Description: Filter by the ID of the parent ProcessInstance.
140
+ - Name: `embeddedProcessModelId` Required: ``
141
+ - Type: Array<string> | string | SearchQuery
142
+ - string: myModel1
143
+ - Array<string>: myModel1,myModel2
144
+ - object:
145
+ - Description: Filter by the ID of the embedded process model.
146
+ - Name: `terminatedByUserId` Required: ``
147
+ - Type: Array<string> | string | SearchQuery
148
+ - string: 12345678
149
+ - Array<string>: 12345678,87654321
150
+ - object:
151
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
152
+ - Name: `createdBefore` Required: ``
153
+ - Type: string
154
+ - Description: The maximum created date of the ProcessInstances to include in the results.
155
+ - Name: `createdAt` Required: ``
156
+ - Type: Array<string> | string
157
+ - string: 2021-01-01T00:00:00.000Z
158
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
159
+ - Description: The minimum created date of the ProcessInstances to include in the results.
160
+ - Name: `createdAfter` Required: ``
161
+ - Type: string
162
+ - Description: The minimum created date of the ProcessInstances to include in the results.
163
+ - Name: `updatedBefore` Required: ``
164
+ - Type: string
165
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
166
+ - Name: `updatedAt` Required: ``
167
+ - Type: Array<string> | string
168
+ - string: 2021-01-01T00:00:00.000Z
169
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
170
+ - Description: The exact updated date of the ProcessInstances to include in the results.
171
+ - Name: `updatedAfter` Required: ``
172
+ - Type: string
173
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
174
+ - Name: `finishedBefore` Required: ``
175
+ - Type: string
176
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
177
+ - Name: `finishedAt` Required: ``
178
+ - Type: Array<string> | string
179
+ - string: 2021-01-01T00:00:00.000Z
180
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
181
+ - Description: The exact finished date of the ProcessInstances to include in the results.
182
+ - Name: `finishedAfter` Required: ``
183
+ - Type: string
184
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
185
+ - Name: `triggeredByFlowNodeInstance` Required: ``
186
+ - Type: Array<string> | string | SearchQuery
187
+ - string: myFlowNodeInstance_12345678
188
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
189
+ - object:
190
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
191
+
73
192
  ### References
74
193
 
75
194
  - [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform