@5minds/processcube_engine_sdk 5.0.0-feature-aefa75-lr6bt0qm → 5.0.0-feature-e555bf-lraphd9w

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