@5minds/processcube_engine_sdk 6.1.0-develop-c028f8-m209uxnd → 6.1.0-feature-361d3e-m20dodea

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.
Files changed (25) hide show
  1. package/dist/Engine.d.ts +9 -1
  2. package/dist/EngineEventBus.d.ts +87 -0
  3. package/dist/EngineEventBusSettings.d.ts +88 -0
  4. package/dist/EngineEvents/EventPayloads/TerminateProcessInstance.d.ts +1 -0
  5. package/dist/EngineEvents/index.d.ts +0 -1
  6. package/dist/EngineRestApiSettings.d.ts +2020 -0
  7. package/dist/EngineSocketIoSettings.d.ts +62 -0
  8. package/dist/ExtensionAdapter/NotificationExtensionAdapter.d.ts +4 -4
  9. package/dist/commonjs/Engine.js.map +1 -1
  10. package/dist/commonjs/{EngineEvents/Subscription.js → EngineEventBus.js} +1 -1
  11. package/dist/commonjs/EngineEventBus.js.map +1 -0
  12. package/dist/commonjs/EngineEventBusSettings.js +95 -0
  13. package/dist/commonjs/EngineEventBusSettings.js.map +1 -0
  14. package/dist/commonjs/EngineEvents/index.js +0 -1
  15. package/dist/commonjs/EngineEvents/index.js.map +1 -1
  16. package/dist/commonjs/EngineRestApiSettings.js +2052 -0
  17. package/dist/commonjs/EngineRestApiSettings.js.map +1 -0
  18. package/dist/commonjs/EngineSocketIoSettings.js +67 -0
  19. package/dist/commonjs/EngineSocketIoSettings.js.map +1 -0
  20. package/dist/commonjs/index.js +4 -0
  21. package/dist/commonjs/index.js.map +1 -1
  22. package/dist/index.d.ts +4 -0
  23. package/package.json +1 -1
  24. package/dist/EngineEvents/Subscription.d.ts +0 -26
  25. package/dist/commonjs/EngineEvents/Subscription.js.map +0 -1
package/dist/EngineRestApiSettings.d.ts ADDED
@@ -0,0 +1,2020 @@
1
+ export declare const EngineRestApiSettings: {
2
+ params: {
3
+ correlationId: string;
4
+ untypedTaskInstanceId: string;
5
+ emptyActivityInstanceId: string;
6
+ eventId: string;
7
+ eventName: string;
8
+ externalTaskId: string;
9
+ flowNodeId: string;
10
+ flowNodeInstanceId: string;
11
+ manualTaskInstanceId: string;
12
+ processInstanceId: string;
13
+ processDefinitionId: string;
14
+ processModelId: string;
15
+ sessionId: string;
16
+ userId: string;
17
+ userTaskInstanceId: string;
18
+ userMetadataKey: string;
19
+ };
20
+ paths: {
21
+ /**
22
+ * @swagger
23
+ * /info:
24
+ * get:
25
+ * description: Gets some basic info about the host application.
26
+ * tags: [ApplicationInfo]
27
+ * responses:
28
+ * 200:
29
+ * description: Returns some basic info about the host application.
30
+ * content:
31
+ * application/json:
32
+ * schema:
33
+ * $ref: '#/components/schemas/ApplicationInfo'
34
+ */
35
+ getApplicationInfo: string;
36
+ /**
37
+ * @swagger
38
+ * /authority:
39
+ * get:
40
+ * description: Gets the address of the authority that the host application uses for claim checks.
41
+ * tags: [ApplicationInfo]
42
+ * responses:
43
+ * 200:
44
+ * description: Returns the address of the authority.
45
+ * content:
46
+ * application/json:
47
+ * schema:
48
+ * type: string
49
+ * example: http://localhost:5000
50
+ */
51
+ getAuthorityAddress: string;
52
+ /**
53
+ * @swagger
54
+ * /correlations:
55
+ * get:
56
+ * description: Gets all Correlations.
57
+ * tags: [Correlations]
58
+ * parameters:
59
+ * - name: limit
60
+ * in: query
61
+ * description: The maximum amount of Correlations to be returned.
62
+ * required: false
63
+ * schema:
64
+ * type: number
65
+ * example: 10
66
+ * - name: offset
67
+ * in: query
68
+ * description: The index of the first Correlation to be returned.
69
+ * required: false
70
+ * schema:
71
+ * type: number
72
+ * example: 5
73
+ * responses:
74
+ * 200:
75
+ * description: Returns all Correlations.
76
+ * content:
77
+ * application/json:
78
+ * schema:
79
+ * $ref: '#/components/schemas/CorrelationList'
80
+ */
81
+ getCorrelations: string;
82
+ /**
83
+ * @swagger
84
+ * /correlations/{correlation_id}:
85
+ * get:
86
+ * description: Gets a Correlation by its ID.
87
+ * tags: [Correlations]
88
+ * parameters:
89
+ * - name: correlation_id
90
+ * in: path
91
+ * description: The ID of the Correlation to retrieve.
92
+ * required: true
93
+ * schema:
94
+ * type: string
95
+ * example: 123
96
+ * responses:
97
+ * 200:
98
+ * description: Returns the Correlation with the given ID.
99
+ * content:
100
+ * application/json:
101
+ * schema:
102
+ * $ref: '#/components/schemas/Correlation'
103
+ */
104
+ getCorrelationById: string;
105
+ /**
106
+ * @swagger
107
+ * /cronjobs/query:
108
+ * get:
109
+ * description: Queries a list of deployed Cronjobs.
110
+ * tags: [Cronjobs]
111
+ * parameters:
112
+ * - name: limit
113
+ * in: query
114
+ * description: The maximum amount of Cronjobs to be returned.
115
+ * required: false
116
+ * schema:
117
+ * type: number
118
+ * example: 10
119
+ * - name: offset
120
+ * in: query
121
+ * description: The index of the first Cronjob to be returned.
122
+ * required: false
123
+ * schema:
124
+ * type: number
125
+ * example: 5
126
+ * - name: processDefinitionId
127
+ * in: query
128
+ * description: The ID of the ProcessDefinition for which to retrieve Cronjobs.
129
+ * required: false
130
+ * schema:
131
+ * type: string
132
+ * example: myProcess_12345678
133
+ * - name: processModelId
134
+ * in: query
135
+ * description: The ID of the ProcessModel for which to retrieve Cronjobs.
136
+ * required: false
137
+ * schema:
138
+ * type: string
139
+ * example: myProcessModel_12345678
140
+ * - name: startEventId
141
+ * in: query
142
+ * description: The ID of the StartEvent for which to retrieve Cronjobs.
143
+ * required: false
144
+ * schema:
145
+ * type: string
146
+ * example: myStartEvent_12345678
147
+ * - name: crontab
148
+ * in: query
149
+ * description: The crontab expression for which to retrieve Cronjobs.
150
+ * required: false
151
+ * schema:
152
+ * type: string
153
+ * example: 0 0 1 * *
154
+ * - name: enabled
155
+ * in: query
156
+ * description: The enabled state for which to retrieve Cronjobs.
157
+ * required: false
158
+ * schema:
159
+ * type: boolean
160
+ * example: true
161
+ * - name: nextExecution
162
+ * in: query
163
+ * description: The nextExecution date for which to retrieve Cronjobs.
164
+ * required: false
165
+ * schema:
166
+ * type: string
167
+ * example: 2020-01-01T00:00:00.000Z
168
+ * responses:
169
+ * 200:
170
+ * description: Returns a list of Cronjobs.
171
+ * content:
172
+ * application/json:
173
+ * schema:
174
+ * $ref: '#/components/schemas/CronjobList'
175
+ */
176
+ queryCronjobs: string;
177
+ /**
178
+ * @swagger
179
+ * /cronjobs/process_models/{processModelId}/flow_node/{flowNodeId}/enable:
180
+ * post:
181
+ * description: Enables the given Cronjob for the given ProcessModel.
182
+ * tags: [Cronjobs]
183
+ * parameters:
184
+ * - name: processModelId
185
+ * in: path
186
+ * description: The ID of the ProcessModel for which to enable the Cronjob.
187
+ * required: true
188
+ * schema:
189
+ * type: string
190
+ * example: myProcessModel_12345678
191
+ * - name: flowNodeId
192
+ * in: path
193
+ * description: The ID of the FlowNode for which to enable the Cronjob.
194
+ * required: true
195
+ * schema:
196
+ * type: string
197
+ * example: myFlowNode_12345678
198
+ * responses:
199
+ * 204:
200
+ * description: The Cronjob was successfully enabled.
201
+ */
202
+ enableCronjob: string;
203
+ /**
204
+ * @swagger
205
+ * /cronjobs/process_models/{processModelId}/flow_node/{flowNodeId}/disable:
206
+ * post:
207
+ * description: Disables the given Cronjob for the given ProcessModel.
208
+ * tags: [Cronjobs]
209
+ * parameters:
210
+ * - name: processModelId
211
+ * in: path
212
+ * description: The ID of the ProcessModel for which to disable the Cronjob.
213
+ * required: true
214
+ * schema:
215
+ * type: string
216
+ * example: myProcessModel_12345678
217
+ * - name: flowNodeId
218
+ * in: path
219
+ * description: The ID of the FlowNode for which to disable the Cronjob.
220
+ * required: true
221
+ * schema:
222
+ * type: string
223
+ * example: myFlowNode_12345678
224
+ * responses:
225
+ * 204:
226
+ * description: The Cronjob was successfully disabled.
227
+ */
228
+ disableCronjob: string;
229
+ /**
230
+ * @swagger
231
+ * /data_object_instances/query:
232
+ * get:
233
+ * description: Gets the DataObjectInstances that match the given query.
234
+ * tags: [DataObjectInstances]
235
+ * parameters:
236
+ * - name: limit
237
+ * in: query
238
+ * description: The maximum amount of DataObjectInstances to be returned.
239
+ * schema:
240
+ * type: number
241
+ * example: 100
242
+ * - name: offset
243
+ * in: query
244
+ * description: The index of the first DataObjectInstance to be returned.
245
+ * schema:
246
+ * type: number
247
+ * example: 5
248
+ * - name: dataObjectId
249
+ * in: query
250
+ * description: The ID of the DataObject for which to retrieve DataObjectInstances.
251
+ * schema:
252
+ * type: string
253
+ * example: myDataObject_12345678
254
+ * - name: processDefinitionId
255
+ * in: query
256
+ * description: The ID of the ProcessDefinition for which to retrieve DataObjectInstances.
257
+ * schema:
258
+ * type: string
259
+ * example: myProcessDefinition_12345678
260
+ * - name: processModelId
261
+ * in: query
262
+ * description: The ID of the ProcessModel for which to retrieve DataObjectInstances.
263
+ * schema:
264
+ * type: string
265
+ * example: myProcessModel_12345678
266
+ * - name: processInstanceId
267
+ * in: query
268
+ * description: The ID of the ProcessInstance for which to retrieve DataObjectInstances.
269
+ * schema:
270
+ * type: string
271
+ * example: myProcessInstance_12345678
272
+ * - name: flowNodeInstanceId
273
+ * in: query
274
+ * description: The ID of the FlowNodeInstance for which to retrieve DataObjectInstances.
275
+ * schema:
276
+ * type: string
277
+ * example: myFlowNodeInstance_12345678
278
+ * - name: createdAt
279
+ * in: query
280
+ * description: The createdAt date for which to retrieve DataObjectInstances.
281
+ * schema:
282
+ * type: string
283
+ * example: 2020-01-01T00:00:00.000Z
284
+ * responses:
285
+ * 200:
286
+ * description: Returns a list of DataObjectInstances.
287
+ * content:
288
+ * application/json:
289
+ * schema:
290
+ * $ref: '#/components/schemas/DataObjectInstanceList'
291
+ */
292
+ getDataObjects: string;
293
+ /**
294
+ * @swagger
295
+ * /flow_node_instances:
296
+ * get:
297
+ * description: Gets all FlowNodeInstances that match the given query.
298
+ * tags: [FlowNodeInstances]
299
+ * parameters:
300
+ * - name: limit
301
+ * in: query
302
+ * description: The maximum amount of FlowNodeInstances to be returned.
303
+ * schema:
304
+ * type: number
305
+ * example: 100
306
+ * - name: offset
307
+ * in: query
308
+ * description: The index of the first FlowNodeInstance to be returned.
309
+ * schema:
310
+ * type: number
311
+ * example: 5
312
+ * - name: flowNodeInstanceId
313
+ * in: query
314
+ * description: The ID of the FlowNodeInstance to be returned.
315
+ * schema:
316
+ * type: string
317
+ * example: myFlowNodeInstance_12345678
318
+ * - name: flowNodeId
319
+ * in: query
320
+ * description: The ID of the FlowNode for which to retrieve FlowNodeInstances.
321
+ * schema:
322
+ * type: string
323
+ * example: myFlowNode_12345678
324
+ * - name: flowNodeName
325
+ * in: query
326
+ * description: The name of the FlowNode for which to retrieve FlowNodeInstances.
327
+ * schema:
328
+ * type: string
329
+ * example: myFlowNode
330
+ * - name: flowNodeLane
331
+ * in: query
332
+ * description: The name of the Lane for which to retrieve FlowNodeInstances.
333
+ * schema:
334
+ * type: string
335
+ * example: myLane
336
+ * - name: flowNodeType
337
+ * in: query
338
+ * description: The type of the FlowNode for which to retrieve FlowNodeInstances.
339
+ * schema:
340
+ * type: string
341
+ * example: bpmn:BoundaryEvent
342
+ * - name: eventType
343
+ * in: query
344
+ * description: The event type of the FlowNodeInstance to be returned.
345
+ * schema:
346
+ * type: string
347
+ * example: messageEvent
348
+ * - name: correlationId
349
+ * in: query
350
+ * description: The correlationId of the FlowNodeInstance to be returned.
351
+ * schema:
352
+ * type: string
353
+ * example: myCorrelationId_12345678
354
+ * - name: processDefinitionId
355
+ * in: query
356
+ * description: The ID of the ProcessDefinition for which to retrieve FlowNodeInstances.
357
+ * schema:
358
+ * type: string
359
+ * example: myProcessDefinition_12345678
360
+ * - name: processModelId
361
+ * in: query
362
+ * description: The ID of the ProcessModel for which to retrieve FlowNodeInstances.
363
+ * schema:
364
+ * type: string
365
+ * example: myProcessModel_12345678
366
+ * - name: processInstanceId
367
+ * in: query
368
+ * description: The ID of the ProcessInstance for which to retrieve FlowNodeInstances.
369
+ * schema:
370
+ * type: string
371
+ * example: myProcessInstance_12345678
372
+ * - name: ownerId
373
+ * in: query
374
+ * description: The ID of the FlowNodeInstance owner for which to retrieve FlowNodeInstances.
375
+ * schema:
376
+ * type: string
377
+ * example: myOwner_12345678
378
+ * - name: state
379
+ * in: query
380
+ * description: The state of the FlowNodeInstance to be returned.
381
+ * schema:
382
+ * type: string
383
+ * example: running
384
+ * - name: previousFlowNodeInstanceId
385
+ * in: query
386
+ * description: The ID of the previous FlowNodeInstance for which to retrieve FlowNodeInstances.
387
+ * schema:
388
+ * type: string
389
+ * example: myPreviousFlowNodeInstance_12345678
390
+ * - name: parentProcessInstanceId
391
+ * in: query
392
+ * description: The ID of the parent ProcessInstance for which to retrieve FlowNodeInstances.
393
+ * schema:
394
+ * type: string
395
+ * example: myParentProcessInstance_12345678
396
+ * - name: createdAt
397
+ * in: query
398
+ * description: The createdAt date for which to retrieve FlowNodeInstances.
399
+ * schema:
400
+ * type: string
401
+ * example: 2020-01-01T00:00:00.000Z
402
+ * - name: updatedAt
403
+ * in: query
404
+ * description: The updatedAt date for which to retrieve FlowNodeInstances.
405
+ * schema:
406
+ * type: string
407
+ * example: 2020-01-01T00:00:00.000Z
408
+ * - name: triggeredByFlowNodeInstance
409
+ * in: query
410
+ * description: The ID of the FlowNodeInstance that triggered the FlowNodeInstance to be returned.
411
+ * schema:
412
+ * type: Array<string> | string | SearchQuery
413
+ * oneOf:
414
+ * - type: Array<string>
415
+ * example: ['myTriggeredFlowNodeInstance_12345678', 'myTriggeredFlowNodeInstance_87654321']
416
+ * - type: string
417
+ * example: myTriggeredFlowNodeInstance_12345678
418
+ * - $ref: '#/components/schemas/SearchQuery'
419
+ * responses:
420
+ * 200:
421
+ * description: Returns a list of FlowNodeInstances.
422
+ * content:
423
+ * application/json:
424
+ * schema:
425
+ * $ref: '#/components/schemas/FlowNodeInstanceList'
426
+ */
427
+ queryFlowNodeInstances: string;
428
+ /**
429
+ * @swagger
430
+ * /messages/{eventName}/trigger:
431
+ * post:
432
+ * description: Triggers a MessageEvent by its name.
433
+ * tags: [Events]
434
+ * parameters:
435
+ * - name: eventName
436
+ * in: path
437
+ * description: The name of the MessageEvent to be triggered.
438
+ * required: true
439
+ * schema:
440
+ * type: string
441
+ * example: myMessageEvent
442
+ * - name: processInstanceId
443
+ * in: query
444
+ * description: The ID of the ProcessInstance for which to trigger the MessageEvent.
445
+ * required: false
446
+ * schema:
447
+ * type: string
448
+ * example: myProcessInstance_12345678
449
+ * requestBody:
450
+ * content:
451
+ * application/json:
452
+ * required: false
453
+ * schema:
454
+ * type: object
455
+ * properties:
456
+ * payload:
457
+ * type: string
458
+ * description: The payload to be sent with the MessageEvent.
459
+ * required: false
460
+ * example: myPayload
461
+ * responses:
462
+ * 204:
463
+ * description: Indicates the MessageEvent was successfully triggered.
464
+ */
465
+ triggerMessageEvent: string;
466
+ /**
467
+ * @swagger
468
+ * /signals/{eventName}/trigger:
469
+ * post:
470
+ * description: Triggers a SignalEvent by its name.
471
+ * tags: [Events]
472
+ * parameters:
473
+ * - name: eventName
474
+ * in: path
475
+ * description: The name of the SignalEvent to be triggered.
476
+ * required: true
477
+ * schema:
478
+ * type: string
479
+ * example: mySignalEvent
480
+ * - name: process_instance_id
481
+ * in: query
482
+ * description: The ID of the ProcessInstance for which to trigger the SignalEvent.
483
+ * required: false
484
+ * schema:
485
+ * type: string
486
+ * example: myProcessInstance_12345678
487
+ * responses:
488
+ * 204:
489
+ * description: Indicates the SignalEvent was successfully triggered.
490
+ */
491
+ triggerSignalEvent: string;
492
+ /**
493
+ * @swagger
494
+ * /empty_activities/{emptyActivityInstanceId}/finish:
495
+ * put:
496
+ * deprecated: true
497
+ * description: DEPRECATED - Use `PUT /untyped_tasks/:untyped_task_instance_id/finish` instead.
498
+ * tags: [UntypedTasks]
499
+ * parameters:
500
+ * - name: emptyActivityInstanceId
501
+ * in: path
502
+ * description: The ID of the EmptyActivityInstance to be finished.
503
+ * required: true
504
+ * schema:
505
+ * type: string
506
+ * example: myEmptyActivityInstance_12345678
507
+ * responses:
508
+ * 204:
509
+ * description: Indicates the EmptyActivityInstance was successfully finished.
510
+ */
511
+ finishEmptyActivity: string;
512
+ /**
513
+ * @swagger
514
+ * /untyped_tasks/{untypedTaskInstanceId}/finish:
515
+ * put:
516
+ * description: Finishes a specific UntypedTask by its UntypedTaskInstanceId.
517
+ * tags: [UntypedTasks]
518
+ * parameters:
519
+ * - name: untypedTaskInstanceId
520
+ * in: path
521
+ * description: The ID of the UntypedTaskInstance to be finished.
522
+ * required: true
523
+ * schema:
524
+ * type: string
525
+ * example: myUntypedTaskInstance_12345678
526
+ * responses:
527
+ * 204:
528
+ * description: Indicates the UntypedTaskInstance was successfully finished.
529
+ */
530
+ finishUntypedTask: string;
531
+ /**
532
+ * @swagger
533
+ * /manual_tasks/{manualTaskInstanceId}/finish:
534
+ * put:
535
+ * description: Finishes a specific ManualTask by its ManualTaskInstanceId.
536
+ * tags: [ManualTasks]
537
+ * parameters:
538
+ * - name: manualTaskInstanceId
539
+ * in: path
540
+ * description: The ID of the ManualTaskInstance to be finished.
541
+ * required: true
542
+ * schema:
543
+ * type: string
544
+ * example: myManualTaskInstance_12345678
545
+ * responses:
546
+ * 204:
547
+ * description: Indicates the ManualTaskInstance was successfully finished.
548
+ */
549
+ finishManualTask: string;
550
+ /**
551
+ * @swagger
552
+ * /user_tasks/{userTaskInstanceId}/finish:
553
+ * put:
554
+ * description: Finishes a specific UserTask by its UserTaskInstanceId.
555
+ * tags: [UserTasks]
556
+ * parameters:
557
+ * - name: userTaskInstanceId
558
+ * in: path
559
+ * description: The ID of the UserTaskInstance to be finished.
560
+ * required: true
561
+ * schema:
562
+ * type: string
563
+ * example: myUserTaskInstance_12345678
564
+ * requestBody:
565
+ * content:
566
+ * application/json:
567
+ * required: false
568
+ * schema:
569
+ * type: object
570
+ * responses:
571
+ * 204:
572
+ * description: Indicates the UserTaskInstance was successfully finished.
573
+ */
574
+ finishUserTask: string;
575
+ /**
576
+ * @swagger
577
+ * /user_tasks/{userTaskInstanceId}/reserve:
578
+ * put:
579
+ * description: Reserves a UserTask for a specific User.
580
+ * tags: [UserTasks]
581
+ * parameters:
582
+ * - name: userTaskInstanceId
583
+ * in: path
584
+ * description: The ID of the UserTaskInstance to be reserved.
585
+ * required: true
586
+ * schema:
587
+ * type: string
588
+ * example: myUserTaskInstance_12345678
589
+ * requestBody:
590
+ * content:
591
+ * application/json:
592
+ * required: true
593
+ * schema:
594
+ * type: object
595
+ * properties:
596
+ * actualOwnerId:
597
+ * type: string
598
+ * description: The ID of the User who reserves the UserTask.
599
+ * required: true
600
+ * example: myUser_12345678
601
+ * responses:
602
+ * 204:
603
+ * description: Indicates the UserTaskInstance was successfully reserved.
604
+ */
605
+ reserveUserTaskInstance: string;
606
+ /**
607
+ * @swagger
608
+ * /user_tasks/{userTaskInstanceId}/cancel-reservation:
609
+ * delete:
610
+ * description: Cancels the reservation of the given UserTask instance.
611
+ * tags: [UserTasks]
612
+ * parameters:
613
+ * - name: userTaskInstanceId
614
+ * in: path
615
+ * description: The ID of the UserTaskInstance for which to cancel the reservation.
616
+ * required: true
617
+ * schema:
618
+ * type: string
619
+ * example: myUserTaskInstance_12345678
620
+ * responses:
621
+ * 204:
622
+ * description: Indicates the UserTaskInstance reservation was successfully canceled.
623
+ */
624
+ cancelUserTaskInstanceReservation: string;
625
+ /**
626
+ * @swagger
627
+ * /external_tasks/deployed_topics:
628
+ * get:
629
+ * description: Fetches a list of all ExternalTask topics from all deployed Process Models.
630
+ * tags: [ExternalTasks]
631
+ * responses:
632
+ * 200:
633
+ * description: A list of all ExternalTask topics from all deployed Process Models.
634
+ * content:
635
+ * application/json:
636
+ * schema:
637
+ * description: A list of all ExternalTask topics from all deployed Process Models.
638
+ * type: array
639
+ * items:
640
+ * type: string
641
+ * example:
642
+ * - myTopic
643
+ * - myOtherTopic
644
+ * - myThirdTopic
645
+ * - myFourthTopic
646
+ */
647
+ getAllDeployedTopics: string;
648
+ /**
649
+ * @swagger
650
+ * /external_tasks/fetch_and_lock:
651
+ * post:
652
+ * description: Fetches the tasks available for an ExternalTaskWorker and locks them for a defined time.
653
+ * tags: [ExternalTasks]
654
+ * requestBody:
655
+ * content:
656
+ * application/json:
657
+ * required: true
658
+ * schema:
659
+ * $ref: '#/components/schemas/FetchAndLockRequestPayload'
660
+ * example:
661
+ * workerId: string
662
+ * topicName: string | Array<string>
663
+ * maxTasks: 10
664
+ * longPollingTimeout: 2000
665
+ * lockDuration: 10000
666
+ * payloadFilter: string
667
+ * responses:
668
+ * 204:
669
+ * description: A list of locked ExternalTasks.
670
+ * content:
671
+ * application/json:
672
+ * schema:
673
+ * type: array
674
+ * items:
675
+ * $ref: '#/components/schemas/ExternalTask'
676
+ */
677
+ fetchAndLockExternalTasks: string;
678
+ /**
679
+ * @swagger
680
+ * /external_tasks/{externalTaskId}/extend_lock:
681
+ * put:
682
+ * description: Extends the lock duration of an ExternalTask by a given amount of time.
683
+ * tags: [ExternalTasks]
684
+ * parameters:
685
+ * - name: externalTaskId
686
+ * in: path
687
+ * description: The ID of the ExternalTask for which to extend the lock duration.
688
+ * required: true
689
+ * schema:
690
+ * type: string
691
+ * example: myExternalTask_12345678
692
+ * requestBody:
693
+ * content:
694
+ * application/json:
695
+ * required: true
696
+ * schema:
697
+ * $ref: '#/components/schemas/ExtendLockRequestPayload'
698
+ * responses:
699
+ * 204:
700
+ * description: Indicates the ExternalTask lock was successfully extended.
701
+ */
702
+ extendExternalTaskLock: string;
703
+ /**
704
+ * @swagger
705
+ * /external_tasks/{externalTaskId}/error:
706
+ * put:
707
+ * description: Finishes the given External Task with the given Error.
708
+ * tags: [ExternalTasks]
709
+ * parameters:
710
+ * - name: externalTaskId
711
+ * in: path
712
+ * description: The ID of the ExternalTask for which to finish with an Error.
713
+ * required: true
714
+ * schema:
715
+ * type: string
716
+ * example: myExternalTask_12345678
717
+ * requestBody:
718
+ * content:
719
+ * application/json:
720
+ * required: true
721
+ * schema:
722
+ * $ref: '#/components/schemas/HandleExternalTaskErrorRequestPayload'
723
+ * responses:
724
+ * 204:
725
+ * description: Indicates the ExternalTask was successfully finished with an Error.
726
+ */
727
+ finishExternalTaskWithError: string;
728
+ /**
729
+ * @swagger
730
+ * /external_tasks/{externalTaskId}/finish:
731
+ * put:
732
+ * description: Finishes the ExternalTask with the given ID.
733
+ * tags: [ExternalTasks]
734
+ * parameters:
735
+ * - name: externalTaskId
736
+ * in: path
737
+ * description: The ID of the ExternalTask to finish.
738
+ * required: true
739
+ * schema:
740
+ * type: string
741
+ * example: myExternalTask_12345678
742
+ * requestBody:
743
+ * content:
744
+ * application/json:
745
+ * required: true
746
+ * schema:
747
+ * $ref: '#/components/schemas/FinishExternalTaskRequestPayload'
748
+ * responses:
749
+ * 204:
750
+ * description: Indicates the ExternalTask was successfully finished.
751
+ */
752
+ finishExternalTask: string;
753
+ /**
754
+ * @swagger
755
+ * /process_definitions:
756
+ * post:
757
+ * description: Creates or updates a ProcessDefinition or a list of ProcessDefinitions.
758
+ * tags: [ProcessDefinitions]
759
+ * requestBody:
760
+ * content:
761
+ * application/json:
762
+ * required: true
763
+ * schema:
764
+ * $ref: '#/components/schemas/PersistProcessDefinitionsPayload'
765
+ * example:
766
+ * xml: string | Array<string>
767
+ * overrideExisting: true
768
+ * responses:
769
+ * 201:
770
+ * description: Indicates the ProcessDefinition(s) was/were successfully persisted.
771
+ */
772
+ persistProcessDefinitions: string;
773
+ /**
774
+ * @swagger
775
+ * /process_definitions:
776
+ * get:
777
+ * description: Gets all ProcessDefinitions the requesting user is allowed to see.
778
+ * tags: [ProcessDefinitions]
779
+ * parameters:
780
+ * - name: offset
781
+ * in: query
782
+ * description: The index of the first ProcessDefinition to include.
783
+ * required: false
784
+ * schema:
785
+ * type: number
786
+ * example: 0
787
+ * - name: limit
788
+ * in: query
789
+ * description: The maximum number of ProcessDefinitions to include.
790
+ * required: false
791
+ * schema:
792
+ * type: number
793
+ * example: 10
794
+ * responses:
795
+ * 200:
796
+ * description: A list of ProcessDefinitions.
797
+ * content:
798
+ * application/json:
799
+ * schema:
800
+ * $ref: '#/components/schemas/ProcessDefinitionList'
801
+ */
802
+ getProcessDefinitions: string;
803
+ /**
804
+ * @swagger
805
+ * /process_definitions/{processDefinitionId}:
806
+ * get:
807
+ * description: Gets a ProcessDefinition by its id.
808
+ * tags: [ProcessDefinitions]
809
+ * parameters:
810
+ * - name: processDefinitionId
811
+ * in: path
812
+ * description: The ID of the ProcessDefinition to retrieve.
813
+ * required: true
814
+ * schema:
815
+ * type: string
816
+ * example: myProcess_12345678
817
+ * responses:
818
+ * 200:
819
+ * description: A ProcessDefinitions.
820
+ * content:
821
+ * application/json:
822
+ * schema:
823
+ * $ref: '#/components/schemas/ProcessDefinition'
824
+ */
825
+ getProcessDefinitionById: string;
826
+ /**
827
+ * @swagger
828
+ * /process_definitions/{processDefinitionId}:
829
+ * delete:
830
+ * description: Deletes the ProcessDefinition with the given ID.
831
+ * tags: [ProcessDefinitions]
832
+ * parameters:
833
+ * - name: processDefinitionId
834
+ * in: path
835
+ * description: The ID of the ProcessDefinition to delete.
836
+ * required: true
837
+ * schema:
838
+ * type: string
839
+ * example: myProcess_12345678
840
+ * - name: delete_all_related_data
841
+ * in: query
842
+ * description: If set to true, all ProcessInstances and ProcessModels related to the ProcessDefinition will be deleted as well.
843
+ * required: false
844
+ * schema:
845
+ * type: boolean
846
+ * example: true
847
+ * responses:
848
+ * 204:
849
+ * description: Indicates the ProcessDefinition was successfully deleted.
850
+ */
851
+ deleteProcessDefinition: string;
852
+ /**
853
+ * @swagger
854
+ * /process_models:
855
+ * get:
856
+ * description: Gets all currently deployed Process Models.
857
+ * tags: [ProcessModels]
858
+ * responses:
859
+ * 200:
860
+ * content:
861
+ * application/json:
862
+ * schema:
863
+ * $ref: '#/components/schemas/ProcessModelList'
864
+ */
865
+ getAllProcessModels: string;
866
+ /**
867
+ * @swagger
868
+ * /process_models/{processModelId}/:
869
+ * get:
870
+ * description: Gets a deployed Process Model by its ID.
871
+ * tags: [ProcessModels]
872
+ * parameters:
873
+ * - name: processModelId
874
+ * in: path
875
+ * description: The ID of the ProcessModel to retrieve.
876
+ * required: true
877
+ * schema:
878
+ * type: string
879
+ * example: myProcess_12345678
880
+ * responses:
881
+ * 200:
882
+ * content:
883
+ * application/json:
884
+ * schema:
885
+ * $ref: '#/components/schemas/ProcessModel'
886
+ */
887
+ getProcessModelById: string;
888
+ /**
889
+ * @swagger
890
+ * /process_models/{processModelId}/process_definition:
891
+ * get:
892
+ * description: Gets a ProcessDefinition for a given ProcessModel.
893
+ * tags: [ProcessModels]
894
+ * parameters:
895
+ * - name: processModelId
896
+ * in: path
897
+ * description: The ID of the ProcessModel for which to retrieve the ProcessDefinition.
898
+ * required: true
899
+ * schema:
900
+ * type: string
901
+ * example: myProcess_12345678
902
+ * responses:
903
+ * 200:
904
+ * content:
905
+ * application/json:
906
+ * schema:
907
+ * $ref: '#/components/schemas/ProcessDefinition'
908
+ */
909
+ getProcessDefinitionForProcessModel: string;
910
+ /**
911
+ * @swagger
912
+ * /process_models/{processModelId}/start:
913
+ * post:
914
+ * description: Starts a new instance from the given set of parameters.
915
+ * tags: [ProcessModels]
916
+ * parameters:
917
+ * - name: processModelId
918
+ * in: path
919
+ * description: The ID of the ProcessModel for which to start a new instance.
920
+ * required: true
921
+ * schema:
922
+ * type: string
923
+ * example: myProcess_12345678
924
+ * requestBody:
925
+ * content:
926
+ * application/json:
927
+ * required: true
928
+ * schema:
929
+ * $ref: '#/components/schemas/ProcessStartRequest'
930
+ * responses:
931
+ * 200:
932
+ * content:
933
+ * application/json:
934
+ * schema:
935
+ * $ref: '#/components/schemas/ProcessStartResponse'
936
+ */
937
+ startProcessInstance: string;
938
+ /**
939
+ * @swagger
940
+ * /process_models/{processModelId}:
941
+ * delete:
942
+ * description: Deletes the ProcessDefinition that contains the Process Model with the given ID.
943
+ * tags: [ProcessModels]
944
+ * parameters:
945
+ * - name: processModelId
946
+ * in: path
947
+ * description: The ID of the ProcessModel for which to delete the ProcessDefinition.
948
+ * required: true
949
+ * schema:
950
+ * type: string
951
+ * example: myProcess_12345678
952
+ * - name: delete_all_related_data
953
+ * in: query
954
+ * description: If set to true, all ProcessInstances related to the ProcessDefinition will be deleted as well.
955
+ * required: false
956
+ * schema:
957
+ * type: boolean
958
+ * example: true
959
+ * responses:
960
+ * 204:
961
+ * description: Indicates the ProcessDefinition was successfully deleted.
962
+ */
963
+ deleteProcessDefinitionByProcessModelId: string;
964
+ /**
965
+ * @swagger
966
+ * /process_models/{processModelId}/enable:
967
+ * post:
968
+ * description: Enables the given Process Model.
969
+ * tags: [ProcessModels]
970
+ * parameters:
971
+ * - name: processModelId
972
+ * in: path
973
+ * description: The ID of the ProcessModel to enable.
974
+ * required: true
975
+ * schema:
976
+ * type: string
977
+ * example: myProcess_12345678
978
+ * responses:
979
+ * 204:
980
+ * description: Indicates the ProcessModel was successfully enabled.
981
+ */
982
+ enableProcessModel: string;
983
+ /**
984
+ * @swagger
985
+ * /process_models/{processModelId}/disable:
986
+ * post:
987
+ * description: Disables the given Process Model.
988
+ * tags: [ProcessModels]
989
+ * parameters:
990
+ * - name: processModelId
991
+ * in: path
992
+ * description: The ID of the ProcessModel to disable.
993
+ * required: true
994
+ * schema:
995
+ * type: string
996
+ * example: myProcess_12345678
997
+ * responses:
998
+ * 204:
999
+ * description: Indicates the ProcessModel was successfully disabled
1000
+ */
1001
+ disableProcessModel: string;
1002
+ /**
1003
+ * @swagger
1004
+ * /process_instances/query:
1005
+ * get:
1006
+ * description: Gets all ProcessInstances that match the given query.
1007
+ * tags: [ProcessInstances]
1008
+ * parameters:
1009
+ * - name: offset
1010
+ * in: query
1011
+ * description: The index of the first ProcessInstance to include in the result set.
1012
+ * required: false
1013
+ * schema:
1014
+ * type: number
1015
+ * example: 0
1016
+ * - name: limit
1017
+ * in: query
1018
+ * description: The maximum number of ProcessInstances to return.
1019
+ * required: false
1020
+ * schema:
1021
+ * type: number
1022
+ * example: 10
1023
+ * - name: correlationId
1024
+ * in: query
1025
+ * description: Filter by the CorrelationId of the ProcessInstances.
1026
+ * required: false
1027
+ * schema:
1028
+ * type: Array<string> | string | SearchQuery
1029
+ * oneOf:
1030
+ * - type: string
1031
+ * example: myCorrelationId
1032
+ * - type: Array<string>
1033
+ * example: ['myCorrelationId1', 'myCorrelationId2']
1034
+ * - $ref: '#/components/schemas/SearchQuery'
1035
+ * - name: processInstanceId
1036
+ * in: query
1037
+ * description: Filter by the ID of the ProcessInstances.
1038
+ * schema:
1039
+ * type: Array<string> | string | SearchQuery
1040
+ * oneOf:
1041
+ * - type: string
1042
+ * example: myProcessInstance_12345678
1043
+ * - type: Array<string>
1044
+ * example: ['myProcessInstance_12345678', 'myProcessInstance_87654321']
1045
+ * - $ref: '#/components/schemas/SearchQuery'
1046
+ * - name: processDefinitionId
1047
+ * in: query
1048
+ * description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
1049
+ * schema:
1050
+ * type: Array<string> | string | SearchQuery
1051
+ * oneOf:
1052
+ * - type: string
1053
+ * example: myProcess_12345678
1054
+ * - type: Array<string>
1055
+ * example: ['myProcess_12345678', 'myProcess_87654321']
1056
+ * - $ref: '#/components/schemas/SearchQuery'
1057
+ * - name: processModelId
1058
+ * in: query
1059
+ * description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
1060
+ * schema:
1061
+ * type: Array<string> | string | SearchQuery
1062
+ * oneOf:
1063
+ * - type: string
1064
+ * example: myProcessModel_12345678
1065
+ * - type: Array<string>
1066
+ * example: ['myProcessModel_12345678', 'myProcessModel_87654321']
1067
+ * - $ref: '#/components/schemas/SearchQuery'
1068
+ * - name: processModelName
1069
+ * in: query
1070
+ * description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
1071
+ * schema:
1072
+ * type: Array<string> | string | SearchQuery
1073
+ * oneOf:
1074
+ * - type: string
1075
+ * example: My Process Model
1076
+ * - type: Array<string>
1077
+ * example: ['My Process Model', 'My Other Process Model']
1078
+ * - $ref: '#/components/schemas/SearchQuery'
1079
+ * - name: processModelHash
1080
+ * in: query
1081
+ * description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
1082
+ * schema:
1083
+ * type: Array<string> | string | SearchQuery
1084
+ * oneOf:
1085
+ * - type: string
1086
+ * example: 12345678
1087
+ * - type: Array<string>
1088
+ * example: ['12345678', '87654321']
1089
+ * - $ref: '#/components/schemas/SearchQuery'
1090
+ * - name: ownerId
1091
+ * in: query
1092
+ * description: Filter by the ID of the User that owns the ProcessInstances.
1093
+ * schema:
1094
+ * type: Array<string> | string | SearchQuery
1095
+ * oneOf:
1096
+ * - type: string
1097
+ * example: 12345678
1098
+ * - type: Array<string>
1099
+ * example: ['12345678', '87654321']
1100
+ * - $ref: '#/components/schemas/SearchQuery'
1101
+ * - name: state
1102
+ * in: query
1103
+ * description: Filter by the state of the ProcessInstances.
1104
+ * schema:
1105
+ * type: Array<string> | string | SearchQuery
1106
+ * oneOf:
1107
+ * - type: string
1108
+ * example: running
1109
+ * - type: Array<string>
1110
+ * example: ['running', 'finished']
1111
+ * - $ref: '#/components/schemas/SearchQuery'
1112
+ * - name: parentProcessInstanceId
1113
+ * in: query
1114
+ * description: Filter by the ID of the parent ProcessInstance.
1115
+ * schema:
1116
+ * type: Array<string> | string | SearchQuery
1117
+ * oneOf:
1118
+ * - type: string
1119
+ * example: myParentProcessInstance_12345678
1120
+ * - type: Array<string>
1121
+ * example: ['myParentProcessInstance_12345678', 'myParentProcessInstance_87654321']
1122
+ * - $ref: '#/components/schemas/SearchQuery'
1123
+ * - name: terminatedByUserId
1124
+ * in: query
1125
+ * description: Filter by the ID of the User that terminated the ProcessInstances.
1126
+ * schema:
1127
+ * type: Array<string> | string | SearchQuery
1128
+ * oneOf:
1129
+ * - type: string
1130
+ * example: 12345678
1131
+ * - type: Array<string>
1132
+ * example: ['12345678', '87654321']
1133
+ * - $ref: '#/components/schemas/SearchQuery'
1134
+ * - name: createdBefore
1135
+ * in: query
1136
+ * description: The maximum created date of the ProcessInstances to include in the results.
1137
+ * schema:
1138
+ * type: string
1139
+ * example: 2021-01-01T00:00:00.000Z
1140
+ * - name: createdAt
1141
+ * in: query
1142
+ * description: The minimum created date of the ProcessInstances to include in the results.
1143
+ * schema:
1144
+ * type: Array<string> | string
1145
+ * oneOf:
1146
+ * - type: string
1147
+ * example: 2021-01-01T00:00:00.000Z
1148
+ * - type: array
1149
+ * items:
1150
+ * type: string
1151
+ * example: ['2021-01-01T00:00:00.000Z', '2021-01-02T00:00:00.000Z']
1152
+ * - name: createdAfter
1153
+ * in: query
1154
+ * description: The minimum created date of the ProcessInstances to include in the results.
1155
+ * schema:
1156
+ * type: string
1157
+ * example: 2021-01-01T00:00:00.000Z
1158
+ * - name: updatedBefore
1159
+ * in: query
1160
+ * description: The maximum updated date of the ProcessInstances to include in the results.
1161
+ * schema:
1162
+ * type: string
1163
+ * example: 2021-01-01T00:00:00.000Z
1164
+ * - name: updatedAt
1165
+ * in: query
1166
+ * description: The exact updated date of the ProcessInstances to include in the results.
1167
+ * schema:
1168
+ * type: Array<string> | string
1169
+ * oneOf:
1170
+ * - type: string
1171
+ * example: 2021-01-01T00:00:00.000Z
1172
+ * - type: array
1173
+ * items:
1174
+ * type: string
1175
+ * example: ['2021-01-01T00:00:00.000Z', '2021-01-02T00:00:00.000Z']
1176
+ * - name: updatedAfter
1177
+ * in: query
1178
+ * description: The minimum updated date of the ProcessInstances to include in the results.
1179
+ * schema:
1180
+ * type: string
1181
+ * example: 2021-01-01T00:00:00.000Z
1182
+ * - name: finishedBefore
1183
+ * in: query
1184
+ * description: The maximum finished date of the ProcessInstances to include in the results.
1185
+ * schema:
1186
+ * type: string
1187
+ * example: 2021-01-01T00:00:00.000Z
1188
+ * - name: finishedAt
1189
+ * in: query
1190
+ * description: The exact finished date of the ProcessInstances to include in the results.
1191
+ * schema:
1192
+ * type: Array<string> | string
1193
+ * oneOf:
1194
+ * - type: string
1195
+ * example: 2021-01-01T00:00:00.000Z
1196
+ * - type: array
1197
+ * items:
1198
+ * type: string
1199
+ * example: ['2021-01-01T00:00:00.000Z', '2021-01-02T00:00:00.000Z']
1200
+ * - name: finishedAfter
1201
+ * in: query
1202
+ * description: The minimum finished date of the ProcessInstances to include in the results.
1203
+ * schema:
1204
+ * type: string
1205
+ * example: 2021-01-01T00:00:00.000Z
1206
+ * - name: triggeredByFlowNodeInstance
1207
+ * in: query
1208
+ * description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
1209
+ * schema:
1210
+ * type: Array<string> | string | SearchQuery
1211
+ * oneOf:
1212
+ * - type: string
1213
+ * example: myFlowNodeInstance_12345678
1214
+ * - type: array
1215
+ * items:
1216
+ * type: string
1217
+ * example: ['myFlowNodeInstance_12345678', 'myFlowNodeInstance_87654321']
1218
+ * - $ref: '#/components/schemas/SearchQuery'
1219
+ * responses:
1220
+ * 200:
1221
+ * content:
1222
+ * application/json:
1223
+ * schema:
1224
+ * $ref: '#/components/schemas/ProcessInstanceList'
1225
+ */
1226
+ queryProcessInstances: string;
1227
+ /**
1228
+ * @swagger
1229
+ * /process_instances/{processInstanceId}/process_definition:
1230
+ * get:
1231
+ * description: Gets the ProcessDefinition for a given ProcessInstance.
1232
+ * tags: [ProcessInstances]
1233
+ * parameters:
1234
+ * - name: processInstanceId
1235
+ * in: path
1236
+ * description: The ID of the ProcessInstance for which the ProcessDefinition should be retrieved.
1237
+ * required: true
1238
+ * schema:
1239
+ * type: string
1240
+ * example: 12345678
1241
+ * responses:
1242
+ * 200:
1243
+ * content:
1244
+ * application/json:
1245
+ * schema:
1246
+ * $ref: '#/components/schemas/ProcessDefinition'
1247
+ */
1248
+ getProcessDefinitionForProcessInstance: string;
1249
+ /**
1250
+ * @swagger
1251
+ * /process_instances/{processInstanceId}/process_model:
1252
+ * get:
1253
+ * description: Gets the ProcessModel for a given ProcessInstance.
1254
+ * tags: [ProcessInstances]
1255
+ * parameters:
1256
+ * - name: processInstanceId
1257
+ * in: path
1258
+ * description: The ID of the ProcessInstance for which the ProcessModel should be retrieved.
1259
+ * required: true
1260
+ * schema:
1261
+ * type: string
1262
+ * example: 12345678
1263
+ * responses:
1264
+ * 200:
1265
+ * content:
1266
+ * application/json:
1267
+ * schema:
1268
+ * $ref: '#/components/schemas/ProcessModel'
1269
+ */
1270
+ getProcessModelForProcessInstance: string;
1271
+ /**
1272
+ * @swagger
1273
+ * /process_instances/{processInstanceId}/change_owner:
1274
+ * post:
1275
+ * description: Changes the owner of the ProcessInstance with the given ID.
1276
+ * tags: [ProcessInstances]
1277
+ * parameters:
1278
+ * - name: processInstanceId
1279
+ * in: path
1280
+ * description: The ID of the ProcessInstance for which the owner should be changed.
1281
+ * required: true
1282
+ * schema:
1283
+ * type: string
1284
+ * example: 12345678
1285
+ * requestBody:
1286
+ * content:
1287
+ * application/json:
1288
+ * required: true
1289
+ * schema:
1290
+ * type: object
1291
+ * properties:
1292
+ * newOwner:
1293
+ * description: The new owner of the ProcessInstance.
1294
+ * $ref: '#/components/schemas/Identity'
1295
+ * required: true
1296
+ * responses:
1297
+ * 204:
1298
+ * description: Indicates the ProcessInstance owner was changed successfully.
1299
+ */
1300
+ changeProcessInstanceOwner: string;
1301
+ /**
1302
+ * @swagger
1303
+ * /process_instances/{processInstanceId}/terminate:
1304
+ * put:
1305
+ * description: Terminates the ProcessInstance with the given ID.
1306
+ * tags: [ProcessInstances]
1307
+ * parameters:
1308
+ * - name: processInstanceId
1309
+ * in: path
1310
+ * description: The ID of the ProcessInstance to terminate.
1311
+ * required: true
1312
+ * schema:
1313
+ * type: string
1314
+ * example: 12345678
1315
+ * responses:
1316
+ * 204:
1317
+ * description: Indicates the ProcessInstance was terminated successfully.
1318
+ */
1319
+ terminateProcessInstances: string;
1320
+ /**
1321
+ * @swagger
1322
+ * /process_instances/{processInstanceId}/retry:
1323
+ * put:
1324
+ * description: Retries a failed or terminated Process Instance from the original point of failure.
1325
+ * tags: [ProcessInstances]
1326
+ * parameters:
1327
+ * - name: processInstanceId
1328
+ * in: path
1329
+ * description: The ID of the ProcessInstance to retry.
1330
+ * required: true
1331
+ * schema:
1332
+ * type: string
1333
+ * example: 12345678
1334
+ * - name: flow_node_instance_id
1335
+ * in: query
1336
+ * description: The ID of the FlowNodeInstance to retry from.
1337
+ * schema:
1338
+ * type: string
1339
+ * example: 12345678
1340
+ * requestBody:
1341
+ * content:
1342
+ * application/json:
1343
+ * required: false
1344
+ * schema:
1345
+ * type: object
1346
+ * properties:
1347
+ * newStartToken:
1348
+ * type: object
1349
+ * description: The new start token for the ProcessInstance.
1350
+ * required: false
1351
+ * responses:
1352
+ * 204:
1353
+ * description: Indicates the ProcessInstance was retried successfully.
1354
+ */
1355
+ retryProcessInstance: string;
1356
+ /**
1357
+ * @swagger
1358
+ * /process_instances:
1359
+ * delete:
1360
+ * description: Deletes the given Set of Process Instances. Multiple ProcessInstanceIds can be provided with ";" as separator.
1361
+ * tags: [ProcessInstances]
1362
+ * parameters:
1363
+ * - name: process_instance_ids
1364
+ * in: query
1365
+ * description: The IDs of the ProcessInstances to delete.
1366
+ * required: true
1367
+ * schema:
1368
+ * type: string | Array<string>
1369
+ * oneOf:
1370
+ * - type: string
1371
+ * example: 12345678
1372
+ * - type: Array<string>
1373
+ * example: [12345678, 87654321]
1374
+ * - name: delete_all_related_data
1375
+ * in: query
1376
+ * description: Flag to indicate whether all related data should be deleted as well.
1377
+ * required: false
1378
+ * schema:
1379
+ * type: boolean
1380
+ * example: true
1381
+ * responses:
1382
+ * 204:
1383
+ * description: Indicates the ProcessInstances were deleted successfully.
1384
+ */
1385
+ deleteProcessInstances: string;
1386
+ /**
1387
+ * @swagger
1388
+ * /notifications/long_polling/cronjob_created:
1389
+ * get:
1390
+ * description: Wait for a CronjobCreated notification and resolves with the notification's content.
1391
+ * tags: [Notifications]
1392
+ * responses:
1393
+ * 200:
1394
+ * content:
1395
+ * application/json:
1396
+ * schema:
1397
+ * $ref: '#/components/schemas/CronjobEventMessage'
1398
+ */
1399
+ onCronjobCreated: string;
1400
+ /**
1401
+ * @swagger
1402
+ * /notifications/long_polling/cronjob_executed:
1403
+ * get:
1404
+ * description: Wait for a CronjobExecuted notification and resolves with the notification's content.
1405
+ * tags: [Notifications]
1406
+ * responses:
1407
+ * 200:
1408
+ * content:
1409
+ * application/json:
1410
+ * schema:
1411
+ * $ref: '#/components/schemas/CronjobEventMessage'
1412
+ */
1413
+ onCronjobExecuted: string;
1414
+ /**
1415
+ * @swagger
1416
+ * /notifications/long_polling/cronjob_stopped:
1417
+ * get:
1418
+ * description: Wait for a CronjobStopped notification and resolves with the notification's content.
1419
+ * tags: [Notifications]
1420
+ * responses:
1421
+ * 200:
1422
+ * content:
1423
+ * application/json:
1424
+ * schema:
1425
+ * $ref: '#/components/schemas/CronjobEventMessage'
1426
+ */
1427
+ onCronjobStopped: string;
1428
+ /**
1429
+ * @swagger
1430
+ * /notifications/long_polling/cronjob_updated:
1431
+ * get:
1432
+ * description: Wait for a CronjobUpdated notification and resolves with the notification's content.
1433
+ * tags: [Notifications]
1434
+ * responses:
1435
+ * 200:
1436
+ * content:
1437
+ * application/json:
1438
+ * schema:
1439
+ * $ref: '#/components/schemas/CronjobEventMessage'
1440
+ */
1441
+ onCronjobUpdated: string;
1442
+ /**
1443
+ * @swagger
1444
+ * /notifications/long_polling/cronjob_removed:
1445
+ * get:
1446
+ * description: Wait for a CronjobRemoved notification and resolves with the notification's content.
1447
+ * tags: [Notifications]
1448
+ * responses:
1449
+ * 200:
1450
+ * content:
1451
+ * application/json:
1452
+ * schema:
1453
+ * $ref: '#/components/schemas/CronjobEventMessage'
1454
+ */
1455
+ onCronjobRemoved: string;
1456
+ /**
1457
+ * @swagger
1458
+ * /notifications/long_polling/cronjob_enabled_changed:
1459
+ * get:
1460
+ * description: Wait for a CronjobEnabledChanged notification and resolves with the notification's content.
1461
+ * tags: [Notifications]
1462
+ * responses:
1463
+ * 200:
1464
+ * content:
1465
+ * application/json:
1466
+ * schema:
1467
+ * $ref: '#/components/schemas/CronjobEnabledChangedMessage'
1468
+ */
1469
+ onCronjobEnabledChanged: string;
1470
+ /**
1471
+ * @swagger
1472
+ * /notifications/long_polling/process_deployed:
1473
+ * get:
1474
+ * description: Wait for a ProcessDeployed notification and resolves with the notification's content.
1475
+ * tags: [Notifications]
1476
+ * responses:
1477
+ * 200:
1478
+ * content:
1479
+ * application/json:
1480
+ * schema:
1481
+ * $ref: '#/components/schemas/ProcessDeploymentMessage'
1482
+ */
1483
+ onProcessDeployed: string;
1484
+ /**
1485
+ * @swagger
1486
+ * /notifications/long_polling/process_undeployed:
1487
+ * get:
1488
+ * description: Wait for a ProcessUndeployed notification and resolves with the notification's content.
1489
+ * tags: [Notifications]
1490
+ * responses:
1491
+ * 200:
1492
+ * content:
1493
+ * application/json:
1494
+ * schema:
1495
+ * $ref: '#/components/schemas/ProcessDeploymentMessage'
1496
+ */
1497
+ onProcessUndeployed: string;
1498
+ /**
1499
+ * @swagger
1500
+ * /notifications/long_polling/process_is_executable_changed:
1501
+ * get:
1502
+ * description: Wait for a ProcessIsExecutableChanged notification and resolves with the notification's content.
1503
+ * tags: [Notifications]
1504
+ * responses:
1505
+ * 200:
1506
+ * content:
1507
+ * application/json:
1508
+ * schema:
1509
+ * $ref: '#/components/schemas/ProcessIsExecutableChangedMessage'
1510
+ */
1511
+ onProcessIsExecutableChanged: string;
1512
+ /**
1513
+ * @swagger
1514
+ * /notifications/long_polling/process_starting:
1515
+ * get:
1516
+ * description: Wait for a ProcessStarting notification and resolves with the notification's content.
1517
+ * tags: [Notifications]
1518
+ * responses:
1519
+ * 200:
1520
+ * content:
1521
+ * application/json:
1522
+ * schema:
1523
+ * $ref: '#/components/schemas/EventMessage'
1524
+ */
1525
+ onProcessStarting: string;
1526
+ /**
1527
+ * @swagger
1528
+ * /notifications/long_polling/process_started:
1529
+ * get:
1530
+ * description: Wait for a ProcessStarted notification and resolves with the notification's content.
1531
+ * tags: [Notifications]
1532
+ * responses:
1533
+ * 200:
1534
+ * content:
1535
+ * application/json:
1536
+ * schema:
1537
+ * $ref: '#/components/schemas/EventMessage'
1538
+ */
1539
+ onProcessStarted: string;
1540
+ /**
1541
+ * @swagger
1542
+ * /notifications/long_polling/process_resumed:
1543
+ * get:
1544
+ * description: Wait for a ProcessResumed notification and resolves with the notification's content.
1545
+ * tags: [Notifications]
1546
+ * responses:
1547
+ * 200:
1548
+ * content:
1549
+ * application/json:
1550
+ * schema:
1551
+ * $ref: '#/components/schemas/EventMessage'
1552
+ */
1553
+ onProcessResumed: string;
1554
+ /**
1555
+ * @swagger
1556
+ * /notifications/long_polling/process_ended:
1557
+ * get:
1558
+ * description: Wait for a ProcessEnded notification and resolves with the notification's content.
1559
+ * tags: [Notifications]
1560
+ * responses:
1561
+ * 200:
1562
+ * content:
1563
+ * application/json:
1564
+ * schema:
1565
+ * $ref: '#/components/schemas/EventMessage'
1566
+ */
1567
+ onProcessEnded: string;
1568
+ /**
1569
+ * @swagger
1570
+ * /notifications/long_polling/process_owner_changed:
1571
+ * get:
1572
+ * description: Wait for a ProcessOwnerChanged notification and resolves with the notification's content.
1573
+ * tags: [Notifications]
1574
+ * responses:
1575
+ * 200:
1576
+ * content:
1577
+ * application/json:
1578
+ * schema:
1579
+ * $ref: '#/components/schemas/EventMessage'
1580
+ */
1581
+ onProcessOwnerChanged: string;
1582
+ /**
1583
+ * @swagger
1584
+ * /notifications/long_polling/process_terminated:
1585
+ * get:
1586
+ * description: Wait for a ProcessTerminated notification and resolves with the notification's content.
1587
+ * tags: [Notifications]
1588
+ * responses:
1589
+ * 200:
1590
+ * content:
1591
+ * application/json:
1592
+ * schema:
1593
+ * $ref: '#/components/schemas/EventMessage'
1594
+ */
1595
+ onProcessTerminated: string;
1596
+ /**
1597
+ * @swagger
1598
+ * /notifications/long_polling/process_error:
1599
+ * get:
1600
+ * description: Wait for a ProcessError notification and resolves with the notification's content.
1601
+ * tags: [Notifications]
1602
+ * responses:
1603
+ * 200:
1604
+ * content:
1605
+ * application/json:
1606
+ * schema:
1607
+ * $ref: '#/components/schemas/EventMessage'
1608
+ */
1609
+ onProcessError: string;
1610
+ /**
1611
+ * @swagger
1612
+ * /notifications/long_polling/process_instances_deleted:
1613
+ * get:
1614
+ * description: Wait for a ProcessInstancesDeleted notification and resolves with the notification's content.
1615
+ * tags: [Notifications]
1616
+ * responses:
1617
+ * 200:
1618
+ * content:
1619
+ * application/json:
1620
+ * schema:
1621
+ * $ref: '#/components/schemas/EventMessage'
1622
+ */
1623
+ onProcessInstancesDeleted: string;
1624
+ /**
1625
+ * @swagger
1626
+ * /notifications/long_polling/external_task_created:
1627
+ * get:
1628
+ * description: Wait for an ExternalTaskCreated notification and resolves with the notification's content.
1629
+ * tags: [Notifications]
1630
+ * responses:
1631
+ * 200:
1632
+ * content:
1633
+ * application/json:
1634
+ * schema:
1635
+ * $ref: '#/components/schemas/ExternalTaskCreatedMessage'
1636
+ */
1637
+ onExternalTaskCreated: string;
1638
+ /**
1639
+ * @swagger
1640
+ * /notifications/long_polling/external_task_locked:
1641
+ * get:
1642
+ * description: Wait for a ExternalTaskLocked notification and resolves with the notification's content.
1643
+ * tags: [Notifications]
1644
+ * responses:
1645
+ * 200:
1646
+ * content:
1647
+ * application/json:
1648
+ * schema:
1649
+ * $ref: '#/components/schemas/ExternalTaskLockedMessage'
1650
+ */
1651
+ onExternalTaskLocked: string;
1652
+ /**
1653
+ * @swagger
1654
+ * /notifications/long_polling/external_task_unlocked:
1655
+ * get:
1656
+ * description: Wait for a ExternalTaskUnlocked notification and resolves with the notification's content.
1657
+ * tags: [Notifications]
1658
+ * responses:
1659
+ * 200:
1660
+ * content:
1661
+ * application/json:
1662
+ * schema:
1663
+ * $ref: '#/components/schemas/ExternalTaskUnlockedMessage'
1664
+ */
1665
+ onExternalTaskUnlocked: string;
1666
+ /**
1667
+ * @swagger
1668
+ * /notifications/long_polling/external_task_expired:
1669
+ * get:
1670
+ * description: Wait for a ExternalTaskExpired notification and resolves with the notification's content.
1671
+ * tags: [Notifications]
1672
+ * responses:
1673
+ * 200:
1674
+ * content:
1675
+ * application/json:
1676
+ * schema:
1677
+ * $ref: '#/components/schemas/ExternalTaskExpiredMessage'
1678
+ */
1679
+ onExternalTaskExpired: string;
1680
+ /**
1681
+ * @swagger
1682
+ * /notifications/long_polling/activity_reached:
1683
+ * get:
1684
+ * description: Wait for an ActivityReached notification and resolves with the notification's content.
1685
+ * tags: [Notifications]
1686
+ * responses:
1687
+ * 200:
1688
+ * content:
1689
+ * application/json:
1690
+ * schema:
1691
+ * $ref: '#/components/schemas/EventMessage'
1692
+ */
1693
+ onActivityReached: string;
1694
+ /**
1695
+ * @swagger
1696
+ * /notifications/long_polling/activity_finished:
1697
+ * get:
1698
+ * description: Wait for an ActivityFinished notification and resolves with the notification's content.
1699
+ * tags: [Notifications]
1700
+ * responses:
1701
+ * 200:
1702
+ * content:
1703
+ * application/json:
1704
+ * schema:
1705
+ * $ref: '#/components/schemas/EventMessage'
1706
+ */
1707
+ onActivityFinished: string;
1708
+ /**
1709
+ * @swagger
1710
+ * /notifications/long_polling/activity_canceled:
1711
+ * get:
1712
+ * description: Wait for an ActivityCanceled notification and resolves with the notification's content.
1713
+ * tags: [Notifications]
1714
+ * responses:
1715
+ * 200:
1716
+ * content:
1717
+ * application/json:
1718
+ * schema:
1719
+ * $ref: '#/components/schemas/EventMessage'
1720
+ */
1721
+ onActivityCanceled: string;
1722
+ /**
1723
+ * @swagger
1724
+ * /notifications/long_polling/empty_activity_waiting:
1725
+ * get:
1726
+ * deprecated: true
1727
+ * description: DEPRECATED - Use `GET /notifications/long_polling/untyped_task_waiting` instead.
1728
+ * tags: [Notifications]
1729
+ * responses:
1730
+ * 200:
1731
+ * content:
1732
+ * application/json:
1733
+ * schema:
1734
+ * $ref: '#/components/schemas/EventMessage'
1735
+ */
1736
+ onEmptyActivityWaiting: string;
1737
+ /**
1738
+ * @swagger
1739
+ * /notifications/long_polling/empty_activity_finished:
1740
+ * get:
1741
+ * deprecated: true
1742
+ * description: DEPRECATED - Use `GET /notifications/long_polling/untyped_task_finished` instead.
1743
+ * tags: [Notifications]
1744
+ * responses:
1745
+ * 200:
1746
+ * content:
1747
+ * application/json:
1748
+ * schema:
1749
+ * $ref: '#/components/schemas/EventMessage'
1750
+ */
1751
+ onEmptyActivityFinished: string;
1752
+ /**
1753
+ * @swagger
1754
+ * /notifications/long_polling/untyped_task_waiting:
1755
+ * get:
1756
+ * description: Wait for an UntypedTaskWaiting notification and resolves with the notification's content.
1757
+ * tags: [Notifications]
1758
+ * responses:
1759
+ * 200:
1760
+ * content:
1761
+ * application/json:
1762
+ * schema:
1763
+ * $ref: '#/components/schemas/EventMessage'
1764
+ */
1765
+ onUntypedTaskWaiting: string;
1766
+ /**
1767
+ * @swagger
1768
+ * /notifications/long_polling/untyped_task_finished:
1769
+ * get:
1770
+ * description: Wait for an UntypedTaskFinished notification and resolves with the notification's content.
1771
+ * tags: [Notifications]
1772
+ * responses:
1773
+ * 200:
1774
+ * content:
1775
+ * application/json:
1776
+ * schema:
1777
+ * $ref: '#/components/schemas/EventMessage'
1778
+ */
1779
+ onUntypedTaskFinished: string;
1780
+ /**
1781
+ * @swagger
1782
+ * /notifications/long_polling/manual_task_waiting:
1783
+ * get:
1784
+ * description: Wait for a ManualTaskWaiting notification and resolves with the notification's content.
1785
+ * tags: [Notifications]
1786
+ * responses:
1787
+ * 200:
1788
+ * content:
1789
+ * application/json:
1790
+ * schema:
1791
+ * $ref: '#/components/schemas/EventMessage'
1792
+ */
1793
+ onManualTaskWaiting: string;
1794
+ /**
1795
+ * @swagger
1796
+ * /notifications/long_polling/manual_task_finished:
1797
+ * get:
1798
+ * description: Wait for a ManualTaskFinied notification and resolves with the notification's content.
1799
+ * tags: [Notifications]
1800
+ * responses:
1801
+ * 200:
1802
+ * content:
1803
+ * application/json:
1804
+ * schema:
1805
+ * $ref: '#/components/schemas/EventMessage'
1806
+ */
1807
+ onManualTaskFinished: string;
1808
+ /**
1809
+ * @swagger
1810
+ * /notifications/long_polling/user_task_waiting:
1811
+ * get:
1812
+ * description: Wait for a UserTaskWaiting notification and resolves with the notification's content.
1813
+ * tags: [Notifications]
1814
+ * responses:
1815
+ * 200:
1816
+ * content:
1817
+ * application/json:
1818
+ * schema:
1819
+ * $ref: '#/components/schemas/EventMessage'
1820
+ */
1821
+ onUserTaskWaiting: string;
1822
+ /**
1823
+ * @swagger
1824
+ * /notifications/long_polling/user_task_finished:
1825
+ * get:
1826
+ * description: Wait for a UserTaskFinished notification and resolves with the notification's content.
1827
+ * tags: [Notifications]
1828
+ * responses:
1829
+ * 200:
1830
+ * content:
1831
+ * application/json:
1832
+ * schema:
1833
+ * $ref: '#/components/schemas/EventMessage'
1834
+ */
1835
+ onUserTaskFinished: string;
1836
+ /**
1837
+ * @swagger
1838
+ * /notifications/long_polling/user_task_reserved:
1839
+ * get:
1840
+ * description: Wait for a UserTaskReserved notification and resolves with the notification's content.
1841
+ * tags: [Notifications]
1842
+ * responses:
1843
+ * 200:
1844
+ * content:
1845
+ * application/json:
1846
+ * schema:
1847
+ * $ref: '#/components/schemas/EventMessage'
1848
+ */
1849
+ onUserTaskReserved: string;
1850
+ /**
1851
+ * @swagger
1852
+ * /notifications/long_polling/user_task_reservation_canceled:
1853
+ * get:
1854
+ * description: Wait for a UserTaskReservationCanceled notification and resolves with the notification's content.
1855
+ * tags: [Notifications]
1856
+ * responses:
1857
+ * 200:
1858
+ * content:
1859
+ * application/json:
1860
+ * schema:
1861
+ * $ref: '#/components/schemas/EventMessage'
1862
+ */
1863
+ onUserTaskReservationCanceled: string;
1864
+ /**
1865
+ * @swagger
1866
+ * /notifications/long_polling/boundary_event_triggered:
1867
+ * get:
1868
+ * description: Wait for a BoundaryEventTriggered notification and resolves with the notification's content.
1869
+ * tags: [Notifications]
1870
+ * responses:
1871
+ * 200:
1872
+ * content:
1873
+ * application/json:
1874
+ * schema:
1875
+ * $ref: '#/components/schemas/EventMessage'
1876
+ */
1877
+ onBoundaryEventTriggered: string;
1878
+ /**
1879
+ * @swagger
1880
+ * /notifications/long_polling/boundary_event_finished:
1881
+ * get:
1882
+ * description: Wait for a BoundaryEventFinished notification and resolves with the notification's content.
1883
+ * tags: [Notifications]
1884
+ * responses:
1885
+ * 200:
1886
+ * content:
1887
+ * application/json:
1888
+ * schema:
1889
+ * $ref: '#/components/schemas/EventMessage'
1890
+ */
1891
+ onBoundaryEventFinished: string;
1892
+ /**
1893
+ * @swagger
1894
+ * /notifications/long_polling/intermediate_throw_event_triggered:
1895
+ * get:
1896
+ * description: Wait for an IntermediateThrowEventTriggered notification and resolves with the notification's content.
1897
+ * tags: [Notifications]
1898
+ * responses:
1899
+ * 200:
1900
+ * content:
1901
+ * application/json:
1902
+ * schema:
1903
+ * $ref: '#/components/schemas/EventMessage'
1904
+ */
1905
+ onIntermediateThrowEventTriggered: string;
1906
+ /**
1907
+ * @swagger
1908
+ * /notifications/long_polling/intermediate_catch_event_reached:
1909
+ * get:
1910
+ * description: Wait for an IntermediateCatchEventReached notification and resolves with the notification's content.
1911
+ * tags: [Notifications]
1912
+ * responses:
1913
+ * 200:
1914
+ * content:
1915
+ * application/json:
1916
+ * schema:
1917
+ * $ref: '#/components/schemas/EventMessage'
1918
+ */
1919
+ onIntermediateCatchEventReached: string;
1920
+ /**
1921
+ * @swagger
1922
+ * /notifications/long_polling/intermediate_catch_event_finished:
1923
+ * get:
1924
+ * description: Wait for a IntermediateCatchEventFinished notification and resolves with the notification's content.
1925
+ * tags: [Notifications]
1926
+ * responses:
1927
+ * 200:
1928
+ * content:
1929
+ * application/json:
1930
+ * schema:
1931
+ * $ref: '#/components/schemas/EventMessage'
1932
+ */
1933
+ onIntermediateCatchEventFinished: string;
1934
+ /**
1935
+ * @swagger
1936
+ * /notifications/long_polling/message_triggered:
1937
+ * get:
1938
+ * description: Wait for an MessageTriggered notification and resolves with the notification's content.
1939
+ * tags: [Notifications]
1940
+ * responses:
1941
+ * 200:
1942
+ * content:
1943
+ * application/json:
1944
+ * schema:
1945
+ * $ref: '#/components/schemas/EventMessage'
1946
+ */
1947
+ onMessageTriggered: string;
1948
+ /**
1949
+ * @swagger
1950
+ * /notifications/long_polling/signal_triggered:
1951
+ * get:
1952
+ * description: Wait for an SignalTriggered notification and resolves with the notification's content.
1953
+ * tags: [Notifications]
1954
+ * responses:
1955
+ * 200:
1956
+ * content:
1957
+ * application/json:
1958
+ * schema:
1959
+ * $ref: '#/components/schemas/EventMessage'
1960
+ */
1961
+ onSignalTriggered: string;
1962
+ /**
1963
+ * @swagger
1964
+ * /notifications/long_polling/end_event_finished:
1965
+ * get:
1966
+ * description: Wait for an EndEventFinished notification and resolves with the notification's content.
1967
+ * tags: [Notifications]
1968
+ * responses:
1969
+ * 200:
1970
+ * content:
1971
+ * application/json:
1972
+ * schema:
1973
+ * $ref: '#/components/schemas/EventMessage'
1974
+ */
1975
+ onEndEventFinished: string;
1976
+ /**
1977
+ * @swagger
1978
+ * /notifications/long_polling/start_event_finished:
1979
+ * get:
1980
+ * description: Wait for an StartEventFinished notification and resolves with the notification's content.
1981
+ * tags: [Notifications]
1982
+ * responses:
1983
+ * 200:
1984
+ * content:
1985
+ * application/json:
1986
+ * schema:
1987
+ * $ref: '#/components/schemas/EventMessage'
1988
+ */
1989
+ onStartEventFinished: string;
1990
+ /**
1991
+ * @swagger
1992
+ * /notifications/long_polling/process_instance_metadata_changed:
1993
+ * get:
1994
+ * description: Wait for a ProcessInstanceMetadataChanged notification and resolves with the notification's content.
1995
+ * tags: [Notifications]
1996
+ * responses:
1997
+ * 200:
1998
+ * content:
1999
+ * application/json:
2000
+ * schema:
2001
+ * $ref: '#/components/schemas/MetadataChangedMessage'
2002
+ */
2003
+ onProcessInstanceMetadataChanged: string;
2004
+ /**
2005
+ * @swagger
2006
+ * /notifications/long_polling/correlation_metadata_changed:
2007
+ * get:
2008
+ * description: Wait for a CorrelationMetadataChanged notification and resolves with the notification's content.
2009
+ * tags: [Notifications]
2010
+ * responses:
2011
+ * 200:
2012
+ * content:
2013
+ * application/json:
2014
+ * schema:
2015
+ * $ref: '#/components/schemas/MetadataChangedMessage'
2016
+ */
2017
+ onCorrelationMetadataChanged: string;
2018
+ };
2019
+ baseRoute: string;
2020
+ };