@5minds/node-red-contrib-processcube 1.5.5-feature-b1b4b4-m3etgwze → 1.5.5-feature-22f94f-m3eulbpf
Sign up to get free protection for your applications and to get access to all the features.
- package/doc_generator/README.md +6 -0
- package/doc_generator/_process_instances_query.md +7 -1
- package/doc_generator/generator.js +1 -1
- package/doc_generator/generator_with_swagger.js +53 -36
- package/doc_generator/outputs/.gitkeep +0 -0
- package/package.json +1 -1
- package/processdefinition-query.html +121 -0
- package/processinstance-delete.html +9 -9
- package/usertask-event-listener.html +121 -0
- package/usertask-input.html +119 -0
- package/wait-for-usertask.html +119 -0
@@ -1,4 +1,4 @@
|
|
1
|
-
|
1
|
+
### Query fields
|
2
2
|
|
3
3
|
**Summary**:
|
4
4
|
|
@@ -65,6 +65,12 @@
|
|
65
65
|
- Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
|
66
66
|
- object:
|
67
67
|
- Description: Filter by the ID of the parent ProcessInstance.
|
68
|
+
- Name: `embeddedProcessModelId` Required: ``
|
69
|
+
- Type: Array<string> | string | SearchQuery
|
70
|
+
- string: myModel1
|
71
|
+
- Array<string>: myModel1,myModel2
|
72
|
+
- object:
|
73
|
+
- Description: Filter by the ID of the embedded process model.
|
68
74
|
- Name: `terminatedByUserId` Required: ``
|
69
75
|
- Type: Array<string> | string | SearchQuery
|
70
76
|
- string: 12345678
|
@@ -31,7 +31,7 @@ const apiRouteData = {
|
|
31
31
|
};
|
32
32
|
|
33
33
|
// Mustache-Template einlesen
|
34
|
-
const template = fs.readFileSync('
|
34
|
+
const template = fs.readFileSync('query_template.mustache', 'utf-8');
|
35
35
|
|
36
36
|
// Mustache-Rendering
|
37
37
|
const output = Mustache.render(template, apiRouteData);
|
@@ -4,11 +4,11 @@ const fs = require('fs');
|
|
4
4
|
const SwaggerParser = require('swagger-parser');
|
5
5
|
|
6
6
|
//const swaggerFilename = '../../ProcessCube.Engine/docs/swagger/swagger.json'; // Dateiname der Swagger-Datei
|
7
|
-
const swaggerFilename = 'swagger.json'; // Dateiname der Swagger-Datei
|
7
|
+
//const swaggerFilename = 'swagger.json'; // Dateiname der Swagger-Datei
|
8
8
|
|
9
9
|
|
10
|
-
|
11
|
-
SwaggerParser.dereference(swaggerFilename)
|
10
|
+
SwaggerParser.dereference("http://localhost:56100/atlas_engine/api/v1/swagger")
|
11
|
+
//SwaggerParser.dereference(swaggerFilename)
|
12
12
|
.then(swaggerJson => {
|
13
13
|
console.log('Dereferenced API:', swaggerJson);
|
14
14
|
|
@@ -17,7 +17,7 @@ SwaggerParser.dereference(swaggerFilename)
|
|
17
17
|
"path": "/process_instances/query",
|
18
18
|
"method": "get"
|
19
19
|
},
|
20
|
-
"UserTasks
|
20
|
+
"UserTasks Input": {
|
21
21
|
"path": "/process_instances/query",
|
22
22
|
"method": "get"
|
23
23
|
},
|
@@ -31,40 +31,57 @@ SwaggerParser.dereference(swaggerFilename)
|
|
31
31
|
}
|
32
32
|
}];
|
33
33
|
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
};
|
55
|
-
|
56
|
-
// Mustache-Template einlesen
|
57
|
-
const template = fs.readFileSync('query_template.mustache', 'utf-8');
|
58
|
-
|
59
|
-
// Mustache-Rendering
|
60
|
-
const output = Mustache.render(template, apiRouteData);
|
61
|
-
|
62
|
-
// Ausgabe in eine Datei schreiben oder anzeigen
|
63
|
-
console.log(output);
|
34
|
+
apiPaths.forEach(apiEntry => {
|
35
|
+
console.log('API Entry:', apiEntry);
|
36
|
+
console.log('API Entry Keys:', Object.keys(apiEntry));
|
37
|
+
|
38
|
+
Object.keys(apiEntry).forEach(apiName => {
|
39
|
+
console.log('API Name:', apiName);
|
40
|
+
console.log('API Data:', apiEntry[apiName]);
|
41
|
+
|
42
|
+
let apiPath = apiEntry[apiName].path; // Die API-Route, die du dokumentieren möchtest
|
43
|
+
|
44
|
+
//let apiPath = '/process_instances/query'; // Die API-Route, die du dokumentieren möchtest
|
45
|
+
const routeData = swaggerJson.paths[apiPath];
|
46
|
+
|
47
|
+
if (routeData) {
|
48
|
+
console.log(`Details for ${apiPath}:`, routeData);
|
49
|
+
} else {
|
50
|
+
console.error(`Route ${apiPath} not found in Swagger documentation.`);
|
51
|
+
}
|
52
|
+
|
53
|
+
let description = routeData[Object.keys(routeData)[0]].description;
|
64
54
|
|
65
|
-
|
55
|
+
description = `Filter result for '${apiName}'`;
|
66
56
|
|
67
|
-
|
57
|
+
// API-Route-Information vorbereiten
|
58
|
+
const apiRouteData = {
|
59
|
+
path: apiPath,
|
60
|
+
method: Object.keys(routeData)[0], // z.B. GET, POST, etc.
|
61
|
+
summary: routeData[Object.keys(routeData)[0]].summary,
|
62
|
+
description: description,
|
63
|
+
parameters: routeData[Object.keys(routeData)[0]].parameters || [],
|
64
|
+
responses: Object.entries(routeData[Object.keys(routeData)[0]].responses).map(([status, response]) => ({
|
65
|
+
status,
|
66
|
+
description: response.description
|
67
|
+
}))
|
68
|
+
};
|
69
|
+
|
70
|
+
// Mustache-Template einlesen
|
71
|
+
const template = fs.readFileSync('query_template.mustache', 'utf-8');
|
72
|
+
|
73
|
+
// Mustache-Rendering
|
74
|
+
const output = Mustache.render(template, apiRouteData);
|
75
|
+
|
76
|
+
// Ausgabe in eine Datei schreiben oder anzeigen
|
77
|
+
//console.log(output);
|
78
|
+
|
79
|
+
const outputFilename = apiName.replace(/\/ /g, '_') + '.md';
|
80
|
+
console.log(`Writing output to ${outputFilename}`);
|
81
|
+
|
82
|
+
fs.writeFileSync(`outputs/${outputFilename}`, output);
|
83
|
+
});
|
84
|
+
});
|
68
85
|
|
69
86
|
})
|
70
87
|
.catch(err => {
|
File without changes
|
package/package.json
CHANGED
@@ -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 'ProcessInstance Query'
|
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<string> | string | SearchQuery
|
95
|
+
- string: myCorrelationId
|
96
|
+
- Array<string>: myCorrelationId1,myCorrelationId2
|
97
|
+
- object:
|
98
|
+
- Description: Filter by the CorrelationId of the ProcessInstances.
|
99
|
+
- Name: `processInstanceId` Required: ``
|
100
|
+
- Type: Array<string> | string | SearchQuery
|
101
|
+
- string: myProcessInstance_12345678
|
102
|
+
- Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
|
103
|
+
- object:
|
104
|
+
- Description: Filter by the ID of the ProcessInstances.
|
105
|
+
- Name: `processDefinitionId` Required: ``
|
106
|
+
- Type: Array<string> | string | SearchQuery
|
107
|
+
- string: myProcess_12345678
|
108
|
+
- Array<string>: 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<string> | string | SearchQuery
|
113
|
+
- string: myProcessModel_12345678
|
114
|
+
- Array<string>: 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<string> | string | SearchQuery
|
119
|
+
- string: My Process Model
|
120
|
+
- Array<string>: 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<string> | string | SearchQuery
|
125
|
+
- string: 12345678
|
126
|
+
- Array<string>: 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<string> | string | SearchQuery
|
131
|
+
- string: 12345678
|
132
|
+
- Array<string>: 12345678,87654321
|
133
|
+
- object:
|
134
|
+
- Description: Filter by the ID of the User that owns the ProcessInstances.
|
135
|
+
- Name: `state` Required: ``
|
136
|
+
- Type: Array<string> | string | SearchQuery
|
137
|
+
- string: running
|
138
|
+
- Array<string>: running,finished
|
139
|
+
- object:
|
140
|
+
- Description: Filter by the state of the ProcessInstances.
|
141
|
+
- Name: `parentProcessInstanceId` Required: ``
|
142
|
+
- Type: Array<string> | string | SearchQuery
|
143
|
+
- string: myParentProcessInstance_12345678
|
144
|
+
- Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
|
145
|
+
- object:
|
146
|
+
- Description: Filter by the ID of the parent ProcessInstance.
|
147
|
+
- Name: `embeddedProcessModelId` Required: ``
|
148
|
+
- Type: Array<string> | string | SearchQuery
|
149
|
+
- string: myModel1
|
150
|
+
- Array<string>: myModel1,myModel2
|
151
|
+
- object:
|
152
|
+
- Description: Filter by the ID of the embedded process model.
|
153
|
+
- Name: `terminatedByUserId` Required: ``
|
154
|
+
- Type: Array<string> | string | SearchQuery
|
155
|
+
- string: 12345678
|
156
|
+
- Array<string>: 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<string> | 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<string> | 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<string> | 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<string> | 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© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
|
@@ -45,19 +45,19 @@
|
|
45
45
|
</script>
|
46
46
|
|
47
47
|
<script type="text/markdown" data-help-name="processinstance-delete">
|
48
|
-
|
48
|
+
Delete old instances of a process model in the ProcessCube.
|
49
49
|
|
50
|
-
|
50
|
+
## Inputs
|
51
51
|
|
52
|
-
|
53
|
-
|
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
|
-
|
55
|
+
## Outputs
|
56
56
|
|
57
|
-
|
57
|
+
: payload (string[]): The ids of the processinstances that were deleted.
|
58
58
|
|
59
|
-
|
59
|
+
### References
|
60
60
|
|
61
|
-
|
62
|
-
|
61
|
+
- [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
|
62
|
+
- [Node-RED Integration in ProcessCube©](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube©
|
63
63
|
</script>
|
@@ -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
|