@5minds/node-red-contrib-processcube 1.5.5-feature-22f94f-m3eulbpf → 1.5.6-develop-51b402-m3iul3hf

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,4110 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "info": {
4
- "title": "5Minds Engine API",
5
- "version": "1.0",
6
- "description": "This is the swagger ui documentation of the 5Minds Engine API.",
7
- "license": {
8
- "name": "MIT"
9
- },
10
- "contact": {
11
- "name": "5Minds IT-Solutions GmbH & Co. KG"
12
- }
13
- },
14
- "components": {
15
- "securitySchemes": {
16
- "bearerAuth": {
17
- "type": "http",
18
- "in": "header",
19
- "scheme": "bearer",
20
- "description": "An Identity Token is required to make requests against the API.\nDummy token: ZHVtbXlfdG9rZW4="
21
- }
22
- },
23
- "schemas": {
24
- "ApplicationInfo": {
25
- "description": "Contains basic information about the running application.",
26
- "type": "object",
27
- "required": ["name", "packageName", "version", "authorityUrl", "allowAnonymousRootAccess", "loadedExtensions", "extraInfo"],
28
- "properties": {
29
- "name": {
30
- "type": "string",
31
- "description": "The name of the application."
32
- },
33
- "packageName": {
34
- "type": "string",
35
- "description": "The name of the package the application is running in."
36
- },
37
- "version": {
38
- "type": "string",
39
- "description": "The version of the application."
40
- },
41
- "authorityUrl": {
42
- "type": "string",
43
- "description": "The URL of the IdentityServer that is used for authentication."
44
- },
45
- "allowAnonymousRootAccess": {
46
- "type": "boolean",
47
- "description": "Flag indicating whether or not anonymous users are allowed to access the root route."
48
- },
49
- "loadedExtensions": {
50
- "type": "array",
51
- "description": "Contains the name and version of all loaded extensions.",
52
- "items": {
53
- "type": "object",
54
- "properties": {
55
- "name": {
56
- "type": "string",
57
- "description": "Name of the extension."
58
- },
59
- "version": {
60
- "type": "string",
61
- "description": "Version of the extension."
62
- }
63
- }
64
- }
65
- },
66
- "extraInfo": {
67
- "type": "object",
68
- "description": "Contains additional information about the application."
69
- }
70
- }
71
- },
72
- "CorrelationList": {
73
- "description": "A list of Correlations.",
74
- "type": "object",
75
- "required": ["correlations", "totalCount"],
76
- "properties": {
77
- "correlations": {
78
- "description": "The correlations",
79
- "type": "array",
80
- "items": {
81
- "$ref": "#/components/schemas/Correlation"
82
- }
83
- },
84
- "totalCount": {
85
- "description": "The total number of correlations",
86
- "type": "number"
87
- }
88
- }
89
- },
90
- "CorrelationMetadata": {
91
- "description": "Metadata for a correlation.",
92
- "type": "object",
93
- "additionalProperties": {
94
- "type": "string"
95
- }
96
- },
97
- "Correlation": {
98
- "description": "A Correlation.",
99
- "type": "object",
100
- "required": ["correlationId"],
101
- "properties": {
102
- "correlationId": {
103
- "description": "The id of the correlation.",
104
- "type": "string"
105
- },
106
- "metadata": {
107
- "description": "Metadata for the correlation.",
108
- "$ref": "#/components/schemas/CorrelationMetadata"
109
- },
110
- "processInstances": {
111
- "description": "The process instances that run in the context of this correlation.",
112
- "type": "array",
113
- "items": {
114
- "$ref": "#/components/schemas/ProcessInstance"
115
- }
116
- }
117
- }
118
- },
119
- "Cronjob": {
120
- "description": "Describes a cronjob.",
121
- "type": "object",
122
- "required": ["processDefinitionId", "processModelId", "startEventId", "enabled", "crontab"],
123
- "properties": {
124
- "processDefinitionId": {
125
- "type": "string",
126
- "description": "The ID of the ProcessDefinition that contains the cronjob."
127
- },
128
- "processModelId": {
129
- "type": "string",
130
- "description": "The ID of the ProcessModel that contains the cronjob."
131
- },
132
- "startEventId": {
133
- "type": "string",
134
- "description": "The ID of the StartEvent that contains the cronjob."
135
- },
136
- "enabled": {
137
- "type": "boolean",
138
- "description": "Flag indicating whether or not the cronjob is enabled."
139
- },
140
- "crontab": {
141
- "type": "string",
142
- "description": "The crontab that describs the cronjob."
143
- },
144
- "startedProcessInstances": {
145
- "type": "number",
146
- "description": "The number of ProcessInstances that have been started by this cronjob."
147
- },
148
- "lastStartedProcessInstance": {
149
- "type": "string",
150
- "description": "The ID of the last ProcessInstance that has been started by this cronjob."
151
- },
152
- "lastTriggerDate": {
153
- "type": "string",
154
- "description": "The date of the last time the cronjob was triggered."
155
- },
156
- "nextTriggerDate": {
157
- "type": "string",
158
- "description": "The date of the next time the cronjob will be triggered."
159
- }
160
- }
161
- },
162
- "DeployedCronjobList": {
163
- "description": "A list of all deployed cronjobs.",
164
- "type": "object",
165
- "required": ["cronjobs", "totalCount"],
166
- "properties": {
167
- "cronjobs": {
168
- "description": "The deployed cronjobs",
169
- "type": "array",
170
- "items": {
171
- "$ref": "#/components/schemas/Cronjob"
172
- }
173
- },
174
- "totalCount": {
175
- "description": "The total number of deployed cronjobs",
176
- "type": "number"
177
- }
178
- }
179
- },
180
- "DataObjectInstance": {
181
- "description": "Describes a data object instance.",
182
- "type": "object",
183
- "required": ["dataObjectId", "processDefinitionId", "processModelId", "processInstanceId", "flowNodeInstanceId", "value", "createdAt", "updatedAt"],
184
- "properties": {
185
- "dataObjectId": {
186
- "description": "The ID of the data object",
187
- "type": "string"
188
- },
189
- "processDefinitionId": {
190
- "description": "The ID of the process definition that contains the data object",
191
- "type": "string"
192
- },
193
- "processModelId": {
194
- "description": "The ID of the process model that contains the data object",
195
- "type": "string"
196
- },
197
- "processInstanceId": {
198
- "description": "The ID of the process instance that contains the data object",
199
- "type": "string"
200
- },
201
- "flowNodeInstanceId": {
202
- "description": "The ID of the FlowNodeInstance that contains the data object",
203
- "type": "string"
204
- },
205
- "value": {
206
- "description": "The value of the data object",
207
- "type": "object"
208
- },
209
- "createdAt": {
210
- "description": "The Date the data object instance was created",
211
- "type": "string"
212
- },
213
- "updatedAt": {
214
- "description": "The Date the data object instance was last updated",
215
- "type": "string"
216
- }
217
- }
218
- },
219
- "DataObjectInstanceList": {
220
- "description": "A list of data object instances.",
221
- "type": "object",
222
- "required": ["dataObjectInstances", "totalCount"],
223
- "properties": {
224
- "dataObjectInstances": {
225
- "description": "The data object instances",
226
- "type": "array",
227
- "items": {
228
- "$ref": "#/components/schemas/DataObjectInstance"
229
- }
230
- },
231
- "totalCount": {
232
- "description": "The total number of data object instances",
233
- "type": "number"
234
- }
235
- }
236
- },
237
- "ExternalTask": {
238
- "description": "Describes an ExternalTask that the Engine has delegated to an ExternalTask worker for processing.",
239
- "type": "object",
240
- "required": [
241
- "id",
242
- "workerId",
243
- "topic",
244
- "isSingleTry",
245
- "flowNodeInstanceId",
246
- "correlationId",
247
- "processDefinitionId",
248
- "processInstanceId",
249
- "ownerId",
250
- "payload",
251
- "lockExpirationTime",
252
- "state"
253
- ],
254
- "properties": {
255
- "id": {
256
- "description": "The ID of the ExternalTask.",
257
- "type": "string"
258
- },
259
- "workerId": {
260
- "description": "The ID of the worker that has most recently locked the ExternalTask for processing.",
261
- "type": "string"
262
- },
263
- "topic": {
264
- "description": "The topic of the ExternalTask.",
265
- "type": "string"
266
- },
267
- "isSingleTry": {
268
- "description": "A flag indicating whether or not the ExternalTask is a single try task.",
269
- "type": "boolean"
270
- },
271
- "flowNodeInstanceId": {
272
- "description": "The ID of the FlowNodeInstance that the ExternalTask belongs to.",
273
- "type": "string"
274
- },
275
- "correlationId": {
276
- "description": "The ID of the Correlation that the ExternalTask belongs to.",
277
- "type": "string"
278
- },
279
- "processDefinitionId": {
280
- "description": "The ID of the ProcessDefinition that contains the ExternalTask.",
281
- "type": "string"
282
- },
283
- "processModelId": {
284
- "description": "The ID of the ProcessModel that contains the ExternalTask.",
285
- "type": "string"
286
- },
287
- "processInstanceId": {
288
- "description": "The ID of the ProcessInstance the ExternalTask belongs to.",
289
- "type": "string"
290
- },
291
- "ownerId": {
292
- "description": "The ID of the user that owns the ExternalTask.",
293
- "type": "string"
294
- },
295
- "payload": {
296
- "description": "The payload containing all relevant data the worker needs to execute the ExternalTask.",
297
- "type": "object"
298
- },
299
- "lockExpirationTime": {
300
- "description": "The lock expiration time. On expiration, the task is released to be processed by other workers. If not set, the ExternalTask is not locked.",
301
- "type": "string"
302
- },
303
- "state": {
304
- "description": "The state of the ExternalTask.",
305
- "$ref": "#/components/schemas/ExternalTaskState"
306
- },
307
- "finishedAt": {
308
- "description": "The date when the ExternalTask was finished.",
309
- "type": "string"
310
- },
311
- "result": {
312
- "description": "The result of the ExternalTask.",
313
- "type": "object"
314
- },
315
- "error": {
316
- "description": "The error that occurred during processing of the ExternalTask (if any).",
317
- "type": "object"
318
- },
319
- "createdAt": {
320
- "description": "The date when the ExternalTask was created.",
321
- "type": "string"
322
- }
323
- }
324
- },
325
- "ExternalTaskState": {
326
- "description": "Describes the state of an ExternalTask.",
327
- "type": "string",
328
- "enum": ["pending", "finished", "expired"]
329
- },
330
- "ExternalTaskError": {
331
- "description": "Describes an error that occured while processing an External Task.",
332
- "type": "object",
333
- "required": ["errorCode"],
334
- "properties": {
335
- "errorCode": {
336
- "type": "string",
337
- "description": "The error code of the error."
338
- },
339
- "errorMessage": {
340
- "type": "string",
341
- "description": "The error message of the error."
342
- },
343
- "errorDetails": {
344
- "type": "object",
345
- "description": "Additional information about the error."
346
- }
347
- }
348
- },
349
- "ExternalTaskReusableError": {
350
- "description": "A formatted error object representing an ExternalTask error.",
351
- "type": "object",
352
- "required": ["code"],
353
- "properties": {
354
- "code": {
355
- "description": "The error code of the error.",
356
- "oneOf": [
357
- {
358
- "type": "number"
359
- },
360
- {
361
- "type": "string"
362
- }
363
- ]
364
- },
365
- "name": {
366
- "description": "The name of the error.",
367
- "type": "string"
368
- },
369
- "message": {
370
- "description": "The error message of the error.",
371
- "type": "string"
372
- },
373
- "additionalInformation": {
374
- "description": "Additional information about the error.",
375
- "type": "object"
376
- }
377
- }
378
- },
379
- "ExtendLockRequestPayload": {
380
- "description": "Describes the payload that must be send with a extendLock HTTP POST request.",
381
- "type": "object",
382
- "required": ["workerId", "additionalDuration"],
383
- "properties": {
384
- "workerId": {
385
- "description": "The ID of the worker that wants to extend the lock.",
386
- "type": "string"
387
- },
388
- "additionalDuration": {
389
- "description": "The additional duration in milliseconds that the lock should be extended.",
390
- "type": "number"
391
- }
392
- }
393
- },
394
- "FetchAndLockRequestPayload": {
395
- "description": "Describes the payload that must be send with a fetchAndLock HTTP POST request.",
396
- "type": "object",
397
- "required": ["workerId", "topicName", "maxTasks", "longPollingTimeout", "lockDuration", "payloadFilter"],
398
- "properties": {
399
- "workerId": {
400
- "description": "The ID of the worker that wants to fetch and lock tasks.",
401
- "type": "string"
402
- },
403
- "topicName": {
404
- "description": "The topic of the tasks to fetch and lock.",
405
- "oneOf": [
406
- {
407
- "type": "string"
408
- },
409
- {
410
- "type": "array",
411
- "items": {
412
- "type": "string"
413
- }
414
- }
415
- ]
416
- },
417
- "maxTasks": {
418
- "description": "The maximum number of tasks to fetch and lock.",
419
- "type": "number"
420
- },
421
- "longPollingTimeout": {
422
- "description": "The timeout for the long polling request.",
423
- "type": "number"
424
- },
425
- "lockDuration": {
426
- "description": "The duration for which the tasks should be locked.",
427
- "type": "number"
428
- },
429
- "payloadFilter": {
430
- "description": "A filter for the payload of the tasks.",
431
- "type": "string"
432
- }
433
- }
434
- },
435
- "FinishExternalTaskRequestPayload": {
436
- "description": "Describes the payload that must be send with a finishExternalTask HTTP POST request.",
437
- "type": "object",
438
- "required": ["workerId", "result"],
439
- "properties": {
440
- "workerId": {
441
- "description": "The ID of the worker that wants to finish the task.",
442
- "type": "string"
443
- },
444
- "result": {
445
- "description": "The result of the task.",
446
- "type": "object",
447
- "example": {
448
- "foo": "bar"
449
- }
450
- }
451
- }
452
- },
453
- "HandleExternalTaskErrorRequestPayload": {
454
- "description": "Describes the payload that must be send with a handleExternalTaskError HTTP POST request.",
455
- "type": "object",
456
- "required": ["workerId", "bpmnError"],
457
- "properties": {
458
- "workerId": {
459
- "description": "The ID of the worker that wants to handle the BPMN error.",
460
- "type": "string"
461
- },
462
- "error": {
463
- "description": "The error to handle.",
464
- "$ref": "#/components/schemas/ExternalTaskError"
465
- }
466
- }
467
- },
468
- "FlowNodeInstanceList": {
469
- "description": "A list of FlowNodeInstances.",
470
- "type": "object",
471
- "required": ["flowNodeInstances", "totalCount"],
472
- "properties": {
473
- "flowNodeInstances": {
474
- "description": "The FlowNodeInstances.",
475
- "type": "array",
476
- "items": {
477
- "$ref": "#/components/schemas/FlowNodeInstance"
478
- }
479
- },
480
- "totalCount": {
481
- "description": "The total number of FlowNodeInstances.",
482
- "type": "number"
483
- }
484
- }
485
- },
486
- "FlowNodeInstance": {
487
- "description": "A FlowNodeInstance.",
488
- "type": "object",
489
- "required": [
490
- "flowNodeInstanceId",
491
- "flowNodeId",
492
- "flowNodeType",
493
- "state",
494
- "processDefinitionId",
495
- "processModelId",
496
- "processInstanceId",
497
- "correlationId",
498
- "startToken",
499
- "ownerId"
500
- ],
501
- "properties": {
502
- "flowNodeInstanceId": {
503
- "description": "The ID of the FlowNodeInstance",
504
- "type": "string"
505
- },
506
- "flowNodeId": {
507
- "description": "The ID of the FlowNode",
508
- "type": "string"
509
- },
510
- "flowNodeName": {
511
- "description": "The name of the FlowNode",
512
- "type": "string"
513
- },
514
- "flowNodeLane": {
515
- "description": "The name of the FlowNode's lane that contains this FlowNodeInstance",
516
- "type": "string"
517
- },
518
- "flowNodeType": {
519
- "description": "The BPMN type of the FlowNode",
520
- "$ref": "#/components/schemas/BpmnType"
521
- },
522
- "eventType": {
523
- "description": "The type of the Event, if this FlowNodeInstance is an Event",
524
- "$ref": "#/components/schemas/EventType"
525
- },
526
- "previousFlowNodeInstanceId": {
527
- "description": "The ID of the FlowNodeInstance that was executed before this one",
528
- "type": "string"
529
- },
530
- "parentProcessInstanceId": {
531
- "description": "The ID of the parent ProcessInstance, if this FlowNodeInstance within is a sub process",
532
- "type": "string"
533
- },
534
- "state": {
535
- "description": "The state of the FlowNodeInstance",
536
- "$ref": "#/components/schemas/FlowNodeInstanceState"
537
- },
538
- "processDefinitionId": {
539
- "description": "The ID of the ProcessDefinition that contains this FlowNodeInstance",
540
- "type": "string"
541
- },
542
- "processModelId": {
543
- "description": "The ID of the ProcessModel that contains this FlowNodeInstance",
544
- "type": "string"
545
- },
546
- "processInstanceId": {
547
- "description": "The ID of the ProcessInstance that contains this FlowNodeInstance",
548
- "type": "string"
549
- },
550
- "correlationId": {
551
- "description": "The ID of the Correlation that contains this FlowNodeInstance",
552
- "type": "string"
553
- },
554
- "startToken": {
555
- "description": "The token with which the Flow Node Instance started",
556
- "type": "Record<string, any>"
557
- },
558
- "endToken": {
559
- "description": "The token with which the Flow Node Instance finished",
560
- "type": "Record<string, any>"
561
- },
562
- "ownerId": {
563
- "description": "The ID of the user that owns this FlowNodeInstance",
564
- "type": "string"
565
- },
566
- "error": {
567
- "description": "The error that occured during execution of the FlowNodeInstance (if any)",
568
- "type": "object"
569
- },
570
- "startedAt": {
571
- "description": "The date when the FlowNodeInstance was started",
572
- "type": "string"
573
- },
574
- "finishedAt": {
575
- "description": "The date when the FlowNodeInstance was finished",
576
- "type": "string"
577
- },
578
- "triggeredByFlowNodeInstance": {
579
- "description": "The FlowNodeInstance that triggered this FlowNodeInstance (if any)",
580
- "$ref": "#/components/schemas/FlowNodeInstance"
581
- }
582
- }
583
- },
584
- "FlowNodeInstanceState": {
585
- "description": "The state of a FlowNodeInstance.",
586
- "type": "string",
587
- "enum": ["running", "suspended", "finished", "terminated", "error", "canceled"]
588
- },
589
- "Identity": {
590
- "description": "Contains information about an identity.",
591
- "type": "object",
592
- "required": ["token", "userId"],
593
- "properties": {
594
- "token": {
595
- "description": "The ID of the user to which this identiy belongs.",
596
- "type": "string"
597
- },
598
- "userId": {
599
- "description": "The ID of the auth token's owner.",
600
- "type": "string"
601
- }
602
- }
603
- },
604
- "ProcessDefinition": {
605
- "description": "A ProcessDefinition.",
606
- "type": "object",
607
- "required": ["processDefinitionId", "xml", "hash", "processModels", "deployedAt", "deployedByUserId"],
608
- "properties": {
609
- "processDefinitionId": {
610
- "description": "The ID of the ProcessDefinition.",
611
- "type": "string"
612
- },
613
- "xml": {
614
- "description": "The XML of the ProcessDefinition.",
615
- "type": "string"
616
- },
617
- "hash": {
618
- "description": "The hash of the ProcessDefinition.",
619
- "type": "string"
620
- },
621
- "processModels": {
622
- "description": "The ProcessModels contained in the ProcessDefinition.",
623
- "type": "array",
624
- "items": {
625
- "$ref": "#/components/schemas/ProcessModel"
626
- }
627
- },
628
- "deployedAt": {
629
- "description": "The date when the ProcessDefinition was deployed.",
630
- "type": "string"
631
- },
632
- "deployedByUserId": {
633
- "description": "The ID of the user who deployed the ProcessDefinition.",
634
- "type": "string"
635
- }
636
- }
637
- },
638
- "ProcessModel": {
639
- "description": "A ProcessModel.",
640
- "type": "object",
641
- "required": ["processDefinitionId", "processModelId", "isExecutable", "startEvents", "endEvents", "flowNodes"],
642
- "properties": {
643
- "processDefinitionId": {
644
- "description": "The ID of the ProcessDefinition that contains the ProcessModel.",
645
- "type": "string"
646
- },
647
- "processModelId": {
648
- "description": "The ID of the ProcessModel.",
649
- "type": "string"
650
- },
651
- "processModelName": {
652
- "description": "The name of the ProcessModel.",
653
- "type": "string"
654
- },
655
- "version": {
656
- "description": "The version of the ProcessModel.",
657
- "type": "string"
658
- },
659
- "isExecutable": {
660
- "description": "A flag indicating whether the ProcessModel can be started.",
661
- "type": "boolean"
662
- },
663
- "startEvents": {
664
- "description": "The StartEvents contained in the ProcessModel.",
665
- "type": "array",
666
- "items": {
667
- "$ref": "#/components/schemas/StartEventViewModel"
668
- }
669
- },
670
- "endEvents": {
671
- "description": "The EndEvents contained in the ProcessModel.",
672
- "type": "array",
673
- "items": {
674
- "$ref": "#/components/schemas/EndEventViewModel"
675
- }
676
- },
677
- "flowNodes": {
678
- "description": "The FlowNodes contained in the ProcessModel.",
679
- "type": "array",
680
- "items": {
681
- "$ref": "#/components/schemas/FlowNodeViewModel"
682
- }
683
- }
684
- }
685
- },
686
- "ProcessDefinitionList": {
687
- "description": "A list of ProcessDefinitions.",
688
- "type": "object",
689
- "required": ["processDefinitions", "totalCount"],
690
- "properties": {
691
- "processDefinitions": {
692
- "description": "The ProcessDefinitions.",
693
- "type": "array",
694
- "items": {
695
- "$ref": "#/components/schemas/ProcessDefinition"
696
- }
697
- },
698
- "totalCount": {
699
- "description": "The total number of ProcessDefinitions.",
700
- "type": "number"
701
- }
702
- }
703
- },
704
- "ProcessModelList": {
705
- "description": "A list of ProcessModels.",
706
- "type": "object",
707
- "required": ["processModels", "totalCount"],
708
- "properties": {
709
- "processModels": {
710
- "description": "The ProcessModels.",
711
- "type": "array",
712
- "items": {
713
- "$ref": "#/components/schemas/ProcessModel"
714
- }
715
- },
716
- "totalCount": {
717
- "description": "The total number of ProcessModels.",
718
- "type": "number"
719
- }
720
- }
721
- },
722
- "PersistProcessDefinitionsPayload": {
723
- "description": "The payload for persisting process definitions.",
724
- "type": "object",
725
- "required": ["xml"],
726
- "properties": {
727
- "xml": {
728
- "description": "The xml of the process definition(s) to persist.",
729
- "oneOf": [
730
- {
731
- "type": "string"
732
- },
733
- {
734
- "type": "array",
735
- "items": {
736
- "type": "string"
737
- }
738
- }
739
- ],
740
- "example": "string | string[]"
741
- },
742
- "overwriteExisting": {
743
- "description": "A flag indicating whether existing process definitions should be overwritten.",
744
- "type": "boolean"
745
- }
746
- }
747
- },
748
- "ProcessInstanceList": {
749
- "description": "A list of ProcessInstances.",
750
- "type": "object",
751
- "required": ["processInstances", "totalCount"],
752
- "properties": {
753
- "processInstances": {
754
- "description": "The process instances",
755
- "type": "array",
756
- "items": {
757
- "$ref": "#/components/schemas/ProcessInstance"
758
- }
759
- },
760
- "totalCount": {
761
- "description": "The total number of process instances",
762
- "type": "number"
763
- }
764
- }
765
- },
766
- "ProcessInstance": {
767
- "description": "A ProcessInstance.",
768
- "type": "object",
769
- "required": ["correlationId", "processInstanceId", "processDefinitionId", "processModelId", "hash", "state", "error", "ownerId", "startedByRootAccessToken"],
770
- "properties": {
771
- "correlationId": {
772
- "description": "The id of the correlation in whichs context the process instance runs.",
773
- "type": "string"
774
- },
775
- "processInstanceId": {
776
- "description": "The id of the process instance.",
777
- "type": "string"
778
- },
779
- "processDefinitionId": {
780
- "description": "The id of the process definition which the process instance belongs to.",
781
- "type": "string"
782
- },
783
- "processModelId": {
784
- "description": "The id of the executed process model.",
785
- "type": "string"
786
- },
787
- "processModelName": {
788
- "description": "The name of the executed process model.",
789
- "type": "string"
790
- },
791
- "processModelVersion": {
792
- "description": "The version of the executed process model.",
793
- "type": "string"
794
- },
795
- "parentProcessInstanceId": {
796
- "description": "The id of the parent process instance, if this process instance is a sub process.",
797
- "type": "string"
798
- },
799
- "hash": {
800
- "description": "The hash of the used process model.",
801
- "type": "string"
802
- },
803
- "xml": {
804
- "description": "The xml of the used process model.",
805
- "type": "string"
806
- },
807
- "state": {
808
- "description": "The state of the process instance.",
809
- "$ref": "#/components/schemas/ProcessInstanceState"
810
- },
811
- "error": {
812
- "description": "The error that occured during execution of the process instance (if any).",
813
- "type": "object"
814
- },
815
- "ownerId": {
816
- "description": "The id of the user who started the process instance.",
817
- "type": "string"
818
- },
819
- "startedByRootAccessToken": {
820
- "description": "A flag indicating whether or not the process instance was started using a root access token.",
821
- "type": "boolean"
822
- },
823
- "createdAt": {
824
- "description": "The date when the process instance was started.",
825
- "type": "string"
826
- },
827
- "finishedAt": {
828
- "description": "The date when the process instance was finished.",
829
- "type": "string"
830
- },
831
- "restartedAt": {
832
- "description": "The date when the process instance was restarted (if any).",
833
- "type": "string"
834
- },
835
- "terminatedByUserId": {
836
- "description": "The id of the user who terminated the process instance (if any).",
837
- "type": "string"
838
- },
839
- "durationInMilliseconds": {
840
- "description": "The duration of the process instance in milliseconds.",
841
- "type": "number"
842
- },
843
- "startEventId": {
844
- "description": "The id of the start event that started the process instance.",
845
- "type": "string"
846
- },
847
- "startEventType": {
848
- "description": "The type of the start event that started the process instance.",
849
- "$ref": "#/components/schemas/EventType"
850
- },
851
- "startToken": {
852
- "description": "The token that was used to start the process instance",
853
- "type": "object"
854
- },
855
- "endEventId": {
856
- "description": "The id of the end event that ended the process instance (if ended).",
857
- "type": "string"
858
- },
859
- "endEventType": {
860
- "description": "The type of the end event that ended the process instance (if ended).",
861
- "$ref": "#/components/schemas/EventType"
862
- },
863
- "endToken": {
864
- "description": "The token that reached the end event (if ended).",
865
- "type": "object"
866
- },
867
- "metadata": {
868
- "description": "The metadata of the process instance.",
869
- "$ref": "#/components/schemas/ProcessInstanceMetadata"
870
- },
871
- "correlation": {
872
- "description": "The correlation in whichs context the process instance runs.",
873
- "$ref": "#/components/schemas/Correlation"
874
- },
875
- "triggeredByFlowNodeInstance": {
876
- "description": "The FlowNodeInstance that triggered the process instance (if any).",
877
- "$ref": "#/components/schemas/FlowNodeInstance"
878
- }
879
- }
880
- },
881
- "ProcessInstanceState": {
882
- "description": "The state of a ProcessInstance.",
883
- "type": "string",
884
- "enum": ["running", "finished", "error", "terminated"]
885
- },
886
- "ProcessInstanceMetadata": {
887
- "description": "Metadata for a ProcessInstance.",
888
- "type": "object"
889
- },
890
- "SearchQuery": {
891
- "description": "The query to use for a search.",
892
- "type": "object",
893
- "required": ["operator", "searchParams"],
894
- "properties": {
895
- "operator": {
896
- "description": "The operator to use for the search (or / and).",
897
- "type": "string"
898
- },
899
- "searchParams": {
900
- "description": "The search parameters to use for the search.",
901
- "oneOf": [
902
- {
903
- "type": "array",
904
- "items": {
905
- "type": "string"
906
- }
907
- },
908
- {
909
- "type": "array",
910
- "items": {
911
- "$ref": "#/components/schemas/SearchQuery"
912
- }
913
- },
914
- {
915
- "type": "array",
916
- "items": {
917
- "$ref": "#/components/schemas/SearchParams"
918
- }
919
- }
920
- ]
921
- }
922
- }
923
- },
924
- "SearchParams": {
925
- "description": "The parameters to use for a search.",
926
- "type": "object",
927
- "required": ["searchString"],
928
- "properties": {
929
- "searchString": {
930
- "description": "The string to search for.",
931
- "type": "string"
932
- },
933
- "caseSensitive": {
934
- "description": "A flag to indicate, whether the search should be case sensitive.",
935
- "type": "boolean"
936
- },
937
- "partialMatch": {
938
- "description": "A flag to indicate, whether the search should be a partial match.",
939
- "type": "boolean"
940
- }
941
- }
942
- },
943
- "StartCallbackType": {
944
- "description": "The type of callback to use for a ProcessInstance start.",
945
- "type": "integer",
946
- "oneOf": [
947
- {
948
- "title": "CallbackOnProcessInstanceCreated",
949
- "const": 1,
950
- "description": "The Engine will resolve immediately after the ProcessInstance was started."
951
- },
952
- {
953
- "title": "CallbackOnProcessInstanceFinished",
954
- "const": 2,
955
- "description": "The Engine will resolve after the first EndEvent was reached."
956
- },
957
- {
958
- "title": "CallbackOnEndEventReached",
959
- "const": 3,
960
- "description": "The Engine will resolve after a specific EndEvent was reached."
961
- }
962
- ]
963
- },
964
- "ProcessStartOptions": {
965
- "description": "The options to use for starting a ProcessInstance.",
966
- "type": "object",
967
- "required": ["processModelId"],
968
- "properties": {
969
- "processModelId": {
970
- "description": "The ID of the ProcessModel to start.",
971
- "type": "string"
972
- },
973
- "startEventId": {
974
- "description": "The ID of a StartEvent at which the ProcessInstance should start.",
975
- "type": "string"
976
- },
977
- "correlationId": {
978
- "description": "A correlation ID to use for the ProcessInstance.",
979
- "type": "string"
980
- },
981
- "initialToken": {
982
- "description": "The token to use for an initial ProcessToken.",
983
- "type": "object"
984
- }
985
- }
986
- },
987
- "ProcessStartRequest": {
988
- "description": "The request object to use for starting a ProcessInstance.",
989
- "allOf": [
990
- {
991
- "$ref": "#/components/schemas/ProcessStartOptions"
992
- },
993
- {
994
- "type": "object",
995
- "properties": {
996
- "returnOn": {
997
- "description": "Determines when the Engine will resolve, after a new request for starting a ProcessInstance was made.\nNote: If \"CallbackOnEndEventReached\" is selected, \"endEventId\" is no longer optional!\n",
998
- "$ref": "#/components/schemas/StartCallbackType"
999
- },
1000
- "endEventId": {
1001
- "description": "The ID of an EndEvent that should be awaited. Must be provided, of \"returnOn\" is set to \"CallbackOnEndEventReached\".",
1002
- "type": "string"
1003
- }
1004
- }
1005
- }
1006
- ]
1007
- },
1008
- "ProcessStartResponse": {
1009
- "description": "Contains a response from the Engine, which will be send after a ProcessInstance was started.\nDepending on the type of start callback used, this will also contain information about the reached EndEvent.\n",
1010
- "type": "object",
1011
- "required": ["processInstanceId", "correlationId"],
1012
- "properties": {
1013
- "processInstanceId": {
1014
- "description": "The ID of the ProcessInstance.",
1015
- "type": "string"
1016
- },
1017
- "correlationId": {
1018
- "description": "The ID of the Correlation in which the started ProcessInstance runs.",
1019
- "type": "string"
1020
- },
1021
- "endEventId": {
1022
- "description": "If the Engine is set to wait for the ProcessInstance to finish, this will contain the ID of the EndEvent with which ProcessInstance was finished.",
1023
- "type": "string"
1024
- },
1025
- "tokenPayload": {
1026
- "description": "If the Engine is set to wait for the ProcessInstance to finish, this will contain the final result with which ProcessInstance was finished.",
1027
- "type": "object"
1028
- }
1029
- }
1030
- },
1031
- "EventMessage": {
1032
- "description": "The base type for definining event messages.",
1033
- "type": "object",
1034
- "required": ["correlationId", "processDefinitionId", "processModelId", "processInstanceId", "ownerId", "currentToken"],
1035
- "properties": {
1036
- "correlationId": {
1037
- "description": "The ID of the correlation that the event belongs to.",
1038
- "type": "string"
1039
- },
1040
- "processDefinitionId": {
1041
- "description": "The ID of the ProcessDefinition that the event belongs to.",
1042
- "type": "string"
1043
- },
1044
- "processModelId": {
1045
- "description": "The ID of the ProcessModel that the event belongs to.",
1046
- "type": "string"
1047
- },
1048
- "processModelName": {
1049
- "description": "The name of the ProcessModel that the event belongs to.",
1050
- "type": "string"
1051
- },
1052
- "processModelVersion": {
1053
- "description": "The version of the ProcessModel that the event belongs to.",
1054
- "type": "string"
1055
- },
1056
- "processInstanceId": {
1057
- "description": "The ID of the ProcessInstance that the event belongs to.",
1058
- "type": "string"
1059
- },
1060
- "parentProcessInstanceId": {
1061
- "description": "The ID of the parent ProcessInstance (if event occured in a sub process)",
1062
- "type": "string"
1063
- },
1064
- "flowNodeId": {
1065
- "description": "The ID of the FlowNode that the event belongs to.",
1066
- "type": "string"
1067
- },
1068
- "flowNodeName": {
1069
- "description": "The name of the FlowNode that the event belongs to.",
1070
- "type": "string"
1071
- },
1072
- "flowNodeType": {
1073
- "description": "The BPMN type of the FlowNode that the event belongs to.",
1074
- "$ref": "#/components/schemas/BpmnType"
1075
- },
1076
- "flowNodeInstanceId": {
1077
- "description": "The ID of the FlowNodeInstance that the event belongs to.",
1078
- "type": "string"
1079
- },
1080
- "ownerId": {
1081
- "description": "The ID of the user that owns the ProcessInstance that the event belongs to.",
1082
- "type": "string"
1083
- },
1084
- "previousFlowNodeInstanceId": {
1085
- "description": "The ID of the FlowNodeInstance that was executed before.",
1086
- "type": "string"
1087
- },
1088
- "currentToken": {
1089
- "description": "The current token of the ProcessInstance.",
1090
- "type": "object"
1091
- },
1092
- "eventType": {
1093
- "description": "The type of the event.",
1094
- "$ref": "#/components/schemas/EventType"
1095
- },
1096
- "eventName": {
1097
- "description": "The name of the event.",
1098
- "type": "string"
1099
- },
1100
- "customCorrelationId": {
1101
- "description": "Process Instances triggered by this Message will use the following Correlation ID.",
1102
- "type": "string"
1103
- }
1104
- }
1105
- },
1106
- "CronjobEnabledChangedMessage": {
1107
- "description": "Message that is sent whenever a Cronjob was enabled or disabled.",
1108
- "type": "object",
1109
- "required": ["processModelId", "flowNodeId", "enabled"],
1110
- "properties": {
1111
- "processModelId": {
1112
- "description": "Contains the ID of the Process Model whose executable state was changed.",
1113
- "type": "string"
1114
- },
1115
- "flowNodeId": {
1116
- "description": "Contains the ID of the Cycle Start Event.",
1117
- "type": "string"
1118
- },
1119
- "enabled": {
1120
- "description": "The new enabled-state.",
1121
- "type": "boolean"
1122
- }
1123
- }
1124
- },
1125
- "CronjobEvent": {
1126
- "description": "Describes a single Cronjob. Used as payload for the CronjobEventMessage.",
1127
- "type": "object",
1128
- "required": ["startEventId", "processModelId", "cronjob"],
1129
- "properties": {
1130
- "startEventId": {
1131
- "description": "The ID of the StartEvent that contains the cronjob.",
1132
- "type": "string"
1133
- },
1134
- "processModelId": {
1135
- "description": "The ID of the ProcessModel that contains the cronjob.",
1136
- "type": "string"
1137
- },
1138
- "cronjob": {
1139
- "description": "The crontab that describs the cronjob.",
1140
- "type": "string"
1141
- }
1142
- }
1143
- },
1144
- "CronjobEventMessage": {
1145
- "description": "A message that is sent when a cronjob related event was triggered.",
1146
- "type": "object",
1147
- "required": ["processDefinitionId", "cronjobs"],
1148
- "properties": {
1149
- "processDefinitionId": {
1150
- "description": "The ID of the ProcessDefinition that contains the cronjob.",
1151
- "type": "string"
1152
- },
1153
- "cronjobs": {
1154
- "description": "The cronjobs that were triggered.",
1155
- "type": "array",
1156
- "items": {
1157
- "$ref": "#/components/schemas/CronjobEvent"
1158
- }
1159
- }
1160
- }
1161
- },
1162
- "ExternalTaskCreatedMessage": {
1163
- "description": "Message that is sent whenever an ExternalTask encountered an error.",
1164
- "allOf": [
1165
- {
1166
- "$ref": "#/components/schemas/EventMessage"
1167
- },
1168
- {
1169
- "type": "object",
1170
- "required": ["externalTaskId", "topic", "isSingleTry"],
1171
- "properties": {
1172
- "externalTaskId": {
1173
- "description": "The ID of the ExternalTask.",
1174
- "type": "string"
1175
- },
1176
- "topic": {
1177
- "description": "The topic of the ExternalTask.",
1178
- "type": "string"
1179
- },
1180
- "isSingleTry": {
1181
- "description": "Flag indicating whether the ExternalTask is a SingleTry ExternalTask.",
1182
- "type": "boolean"
1183
- }
1184
- }
1185
- }
1186
- ]
1187
- },
1188
- "ExternalTaskLockedMessage": {
1189
- "description": "Message that is sent whenever an ExternalTask was locked by a worker.",
1190
- "allOf": [
1191
- {
1192
- "$ref": "#/components/schemas/ExternalTaskCreatedMessage"
1193
- },
1194
- {
1195
- "type": "object",
1196
- "required": ["workerId", "lockExpirationTime"],
1197
- "properties": {
1198
- "workerId": {
1199
- "description": "The ID of the worker that locked the ExternalTask.",
1200
- "type": "string"
1201
- },
1202
- "lockExpirationTime": {
1203
- "description": "The time when the lock expires.",
1204
- "type": "string"
1205
- }
1206
- }
1207
- }
1208
- ]
1209
- },
1210
- "ExternalTaskUnlockedMessage": {
1211
- "description": "Message that is sent whenever an ExternalTask lock expires.",
1212
- "allOf": [
1213
- {
1214
- "$ref": "#/components/schemas/ExternalTaskCreatedMessage"
1215
- },
1216
- {
1217
- "type": "object",
1218
- "required": ["externalTaskId", "topic"],
1219
- "properties": {
1220
- "externalTaskId": {
1221
- "description": "The ID of the ExternalTask.",
1222
- "type": "string"
1223
- },
1224
- "topic": {
1225
- "description": "The topic of the ExternalTask.",
1226
- "type": "string"
1227
- }
1228
- }
1229
- }
1230
- ]
1231
- },
1232
- "ExternalTaskExpiredMessage": {
1233
- "description": "Message that is sent whenever an ExternalTask expires.",
1234
- "allOf": [
1235
- {
1236
- "$ref": "#/components/schemas/ExternalTaskCreatedMessage"
1237
- },
1238
- {
1239
- "type": "object",
1240
- "required": ["externalTaskId", "topic"],
1241
- "properties": {
1242
- "externalTaskId": {
1243
- "description": "The ID of the ExternalTask.",
1244
- "type": "string"
1245
- },
1246
- "topic": {
1247
- "description": "The topic of the ExternalTask.",
1248
- "type": "string"
1249
- }
1250
- }
1251
- }
1252
- ]
1253
- },
1254
- "ExternalTaskErrorMessage": {
1255
- "description": "Message that is sent whenever an ExternalTask encountered an error.",
1256
- "allOf": [
1257
- {
1258
- "$ref": "#/components/schemas/ExternalTaskCreatedMessage"
1259
- },
1260
- {
1261
- "type": "object",
1262
- "required": ["error"],
1263
- "properties": {
1264
- "error": {
1265
- "description": "The error that occurred.",
1266
- "$ref": "#/components/schemas/ExternalTaskReusableError"
1267
- }
1268
- }
1269
- }
1270
- ]
1271
- },
1272
- "ExternalTaskSuccessMessage": {
1273
- "description": "Message that is sent whenever an ExternalTask encountered an error.",
1274
- "allOf": [
1275
- {
1276
- "$ref": "#/components/schemas/ExternalTaskCreatedMessage"
1277
- },
1278
- {
1279
- "type": "object",
1280
- "required": ["result"],
1281
- "properties": {
1282
- "result": {
1283
- "description": "The result of the ExternalTask.",
1284
- "type": "object"
1285
- }
1286
- }
1287
- }
1288
- ]
1289
- },
1290
- "MetadataChangedMessage": {
1291
- "description": "Message that is sent whenever the metadata of a Correlation or Process Instance was changed by a Flow Node Instance.",
1292
- "allOf": [
1293
- {
1294
- "$ref": "#/components/schemas/EventMessage"
1295
- },
1296
- {
1297
- "type": "object",
1298
- "properties": {
1299
- "changedMetadata": {
1300
- "description": "The changed metadata.",
1301
- "type": "object",
1302
- "additionalProperties": {
1303
- "type": "string"
1304
- }
1305
- }
1306
- }
1307
- }
1308
- ]
1309
- },
1310
- "ProcessDeploymentMessage": {
1311
- "description": "Message that is sent whenever a Process was deployed or undeployed.",
1312
- "type": "object",
1313
- "required": ["processDefinitionId"],
1314
- "properties": {
1315
- "processDefinitionId": {
1316
- "description": "The ID or the list of IDs of the deployed/undeployed process(es).",
1317
- "oneOf": [
1318
- {
1319
- "type": "string"
1320
- },
1321
- {
1322
- "type": "array",
1323
- "items": {
1324
- "type": "string"
1325
- }
1326
- }
1327
- ]
1328
- }
1329
- }
1330
- },
1331
- "ProcessIsExecutableChangedMessage": {
1332
- "description": "The message that is sent whenever a Process was flagged as executable or not executable.",
1333
- "type": "object",
1334
- "required": ["processModelId", "isExecutable"],
1335
- "properties": {
1336
- "processModelId": {
1337
- "description": "Contains the ID of the Process Model whose executable state was changed.",
1338
- "type": "string"
1339
- },
1340
- "isExecutable": {
1341
- "description": "Contains the new state of the isExecutable flag.",
1342
- "type": "boolean"
1343
- }
1344
- }
1345
- },
1346
- "BpmnType": {
1347
- "description": "The type of a BPMN element.",
1348
- "type": "string",
1349
- "enum": [
1350
- "bpmn:Task",
1351
- "bpmn:BusinessRuleTask",
1352
- "bpmn:UserTask",
1353
- "bpmn:ExclusiveGateway",
1354
- "bpmn:ParallelGateway",
1355
- "bpmn:ServiceTask",
1356
- "bpmn:StartEvent",
1357
- "bpmn:EndEvent",
1358
- "bpmn:IntermediateCatchEvent",
1359
- "bpmn:IntermediateThrowEvent",
1360
- "bpmn:ScriptTask",
1361
- "bpmn:BoundaryEvent",
1362
- "bpmn:CallActivity",
1363
- "bpmn:SubProcess",
1364
- "bpmn:ManualTask",
1365
- "bpmn:ComplexGateway",
1366
- "bpmn:InclusiveGateway",
1367
- "bpmn:EventBasedGateway",
1368
- "bpmn:SendTask",
1369
- "bpmn:ReceiveTask"
1370
- ]
1371
- },
1372
- "EventType": {
1373
- "description": "The type of an event.",
1374
- "type": "string",
1375
- "enum": ["conditionalEvent", "errorEvent", "escalationEvent", "linkEvent", "messageEvent", "signalEvent", "terminateEvent", "timerEvent"]
1376
- },
1377
- "BaseElementViewModel": {
1378
- "description": "A BaseElement.",
1379
- "type": "object",
1380
- "required": ["id", "customProperties", "processModelId"],
1381
- "properties": {
1382
- "id": {
1383
- "type": "string",
1384
- "description": "The ID of the BaseElement."
1385
- },
1386
- "customProperties": {
1387
- "type": "object",
1388
- "description": "The custom properties of the BaseElement.",
1389
- "additionalProperties": {
1390
- "type": "string"
1391
- }
1392
- },
1393
- "documentation": {
1394
- "type": "array",
1395
- "description": "The documentation of the BaseElement.",
1396
- "items": {
1397
- "type": "string"
1398
- }
1399
- },
1400
- "processModelId": {
1401
- "type": "string",
1402
- "description": "The ID of the ProcessModel that contains the BaseElement."
1403
- },
1404
- "processModelName": {
1405
- "type": "string",
1406
- "description": "The name of the ProcessModel that contains the BaseElement."
1407
- },
1408
- "processModelVersion": {
1409
- "type": "string",
1410
- "description": "The version of the ProcessModel that contains the BaseElement."
1411
- }
1412
- }
1413
- },
1414
- "EndEventViewModel": {
1415
- "description": "An EndEvent.",
1416
- "allOf": [
1417
- {
1418
- "$ref": "#/components/schemas/EventViewModel"
1419
- },
1420
- {
1421
- "type": "object",
1422
- "properties": {
1423
- "errorName": {
1424
- "description": "The name of the error.",
1425
- "type": "string"
1426
- },
1427
- "errorCode": {
1428
- "description": "The code of the error.",
1429
- "type": "string"
1430
- },
1431
- "errorMessage": {
1432
- "description": "The message of the error.",
1433
- "type": "string"
1434
- }
1435
- }
1436
- }
1437
- ]
1438
- },
1439
- "EventViewModel": {
1440
- "description": "An Event.",
1441
- "allOf": [
1442
- {
1443
- "$ref": "#/components/schemas/FlowNodeViewModel"
1444
- }
1445
- ]
1446
- },
1447
- "StartEventViewModel": {
1448
- "description": "A StartEvent.",
1449
- "allOf": [
1450
- {
1451
- "$ref": "#/components/schemas/EventViewModel"
1452
- },
1453
- {
1454
- "type": "object",
1455
- "properties": {
1456
- "timerType": {
1457
- "description": "The type of the timer.",
1458
- "type": "string"
1459
- },
1460
- "timerValue": {
1461
- "description": "The value of the timer.",
1462
- "type": "string"
1463
- }
1464
- }
1465
- }
1466
- ]
1467
- },
1468
- "FlowNodeViewModel": {
1469
- "description": "A FlowNode.",
1470
- "allOf": [
1471
- {
1472
- "$ref": "#/components/schemas/BaseElementViewModel"
1473
- },
1474
- {
1475
- "type": "object",
1476
- "properties": {
1477
- "name": {
1478
- "description": "The name of the FlowNode.",
1479
- "type": "string"
1480
- },
1481
- "flowNodeType": {
1482
- "description": "The type of the FlowNode.",
1483
- "$ref": "#/components/schemas/BpmnType"
1484
- }
1485
- }
1486
- }
1487
- ]
1488
- },
1489
- "MessageChannel": {
1490
- "description": "The desired message channel of a message.",
1491
- "type": "string"
1492
- }
1493
- }
1494
- },
1495
- "servers": [
1496
- {
1497
- "description": "current",
1498
- "url": "/atlas_engine/api/v1"
1499
- }
1500
- ],
1501
- "security": [
1502
- {
1503
- "bearerAuth": []
1504
- }
1505
- ],
1506
- "paths": {
1507
- "/info": {
1508
- "get": {
1509
- "description": "Gets some basic info about the host application.",
1510
- "tags": ["ApplicationInfo"],
1511
- "responses": {
1512
- "200": {
1513
- "description": "Returns some basic info about the host application.",
1514
- "content": {
1515
- "application/json": {
1516
- "schema": {
1517
- "$ref": "#/components/schemas/ApplicationInfo"
1518
- }
1519
- }
1520
- }
1521
- }
1522
- }
1523
- }
1524
- },
1525
- "/authority": {
1526
- "get": {
1527
- "description": "Gets the address of the authority that the host application uses for claim checks.",
1528
- "tags": ["ApplicationInfo"],
1529
- "responses": {
1530
- "200": {
1531
- "description": "Returns the address of the authority.",
1532
- "content": {
1533
- "application/json": {
1534
- "schema": {
1535
- "type": "string",
1536
- "example": "http://localhost:5000"
1537
- }
1538
- }
1539
- }
1540
- }
1541
- }
1542
- }
1543
- },
1544
- "/correlations": {
1545
- "get": {
1546
- "description": "Gets all Correlations.",
1547
- "tags": ["Correlations"],
1548
- "parameters": [
1549
- {
1550
- "name": "limit",
1551
- "in": "query",
1552
- "description": "The maximum amount of Correlations to be returned.",
1553
- "required": false,
1554
- "schema": {
1555
- "type": "number",
1556
- "example": 10
1557
- }
1558
- },
1559
- {
1560
- "name": "offset",
1561
- "in": "query",
1562
- "description": "The index of the first Correlation to be returned.",
1563
- "required": false,
1564
- "schema": {
1565
- "type": "number",
1566
- "example": 5
1567
- }
1568
- }
1569
- ],
1570
- "responses": {
1571
- "200": {
1572
- "description": "Returns all Correlations.",
1573
- "content": {
1574
- "application/json": {
1575
- "schema": {
1576
- "$ref": "#/components/schemas/CorrelationList"
1577
- }
1578
- }
1579
- }
1580
- }
1581
- }
1582
- }
1583
- },
1584
- "/correlations/{correlation_id}": {
1585
- "get": {
1586
- "description": "Gets a Correlation by its ID.",
1587
- "tags": ["Correlations"],
1588
- "parameters": [
1589
- {
1590
- "name": "correlation_id",
1591
- "in": "path",
1592
- "description": "The ID of the Correlation to retrieve.",
1593
- "required": true,
1594
- "schema": {
1595
- "type": "string",
1596
- "example": 123
1597
- }
1598
- }
1599
- ],
1600
- "responses": {
1601
- "200": {
1602
- "description": "Returns the Correlation with the given ID.",
1603
- "content": {
1604
- "application/json": {
1605
- "schema": {
1606
- "$ref": "#/components/schemas/Correlation"
1607
- }
1608
- }
1609
- }
1610
- }
1611
- }
1612
- }
1613
- },
1614
- "/cronjobs/process_models/{processModelId}/flow_node/{flowNodeId}/enable": {
1615
- "post": {
1616
- "description": "Enables the given Cronjob for the given ProcessModel.",
1617
- "tags": ["Cronjobs"],
1618
- "parameters": [
1619
- {
1620
- "name": "processModelId",
1621
- "in": "path",
1622
- "description": "The ID of the ProcessModel for which to enable the Cronjob.",
1623
- "required": true,
1624
- "schema": {
1625
- "type": "string",
1626
- "example": "myProcessModel_12345678"
1627
- }
1628
- },
1629
- {
1630
- "name": "flowNodeId",
1631
- "in": "path",
1632
- "description": "The ID of the FlowNode for which to enable the Cronjob.",
1633
- "required": true,
1634
- "schema": {
1635
- "type": "string",
1636
- "example": "myFlowNode_12345678"
1637
- }
1638
- }
1639
- ],
1640
- "responses": {
1641
- "204": {
1642
- "description": "The Cronjob was successfully enabled."
1643
- }
1644
- }
1645
- }
1646
- },
1647
- "/cronjobs/process_models/{processModelId}/flow_node/{flowNodeId}/disable": {
1648
- "post": {
1649
- "description": "Disables the given Cronjob for the given ProcessModel.",
1650
- "tags": ["Cronjobs"],
1651
- "parameters": [
1652
- {
1653
- "name": "processModelId",
1654
- "in": "path",
1655
- "description": "The ID of the ProcessModel for which to disable the Cronjob.",
1656
- "required": true,
1657
- "schema": {
1658
- "type": "string",
1659
- "example": "myProcessModel_12345678"
1660
- }
1661
- },
1662
- {
1663
- "name": "flowNodeId",
1664
- "in": "path",
1665
- "description": "The ID of the FlowNode for which to disable the Cronjob.",
1666
- "required": true,
1667
- "schema": {
1668
- "type": "string",
1669
- "example": "myFlowNode_12345678"
1670
- }
1671
- }
1672
- ],
1673
- "responses": {
1674
- "204": {
1675
- "description": "The Cronjob was successfully disabled."
1676
- }
1677
- }
1678
- }
1679
- },
1680
- "/data_object_instances/query": {
1681
- "get": {
1682
- "description": "Gets the DataObjectInstances that match the given query.",
1683
- "tags": ["DataObjectInstances"],
1684
- "parameters": [
1685
- {
1686
- "name": "limit",
1687
- "in": "query",
1688
- "description": "The maximum amount of DataObjectInstances to be returned.",
1689
- "schema": {
1690
- "type": "number",
1691
- "example": 100
1692
- }
1693
- },
1694
- {
1695
- "name": "offset",
1696
- "in": "query",
1697
- "description": "The index of the first DataObjectInstance to be returned.",
1698
- "schema": {
1699
- "type": "number",
1700
- "example": 5
1701
- }
1702
- },
1703
- {
1704
- "name": "dataObjectId",
1705
- "in": "query",
1706
- "description": "The ID of the DataObject for which to retrieve DataObjectInstances.",
1707
- "schema": {
1708
- "type": "string",
1709
- "example": "myDataObject_12345678"
1710
- }
1711
- },
1712
- {
1713
- "name": "processDefinitionId",
1714
- "in": "query",
1715
- "description": "The ID of the ProcessDefinition for which to retrieve DataObjectInstances.",
1716
- "schema": {
1717
- "type": "string",
1718
- "example": "myProcessDefinition_12345678"
1719
- }
1720
- },
1721
- {
1722
- "name": "processModelId",
1723
- "in": "query",
1724
- "description": "The ID of the ProcessModel for which to retrieve DataObjectInstances.",
1725
- "schema": {
1726
- "type": "string",
1727
- "example": "myProcessModel_12345678"
1728
- }
1729
- },
1730
- {
1731
- "name": "processInstanceId",
1732
- "in": "query",
1733
- "description": "The ID of the ProcessInstance for which to retrieve DataObjectInstances.",
1734
- "schema": {
1735
- "type": "string",
1736
- "example": "myProcessInstance_12345678"
1737
- }
1738
- },
1739
- {
1740
- "name": "flowNodeInstanceId",
1741
- "in": "query",
1742
- "description": "The ID of the FlowNodeInstance for which to retrieve DataObjectInstances.",
1743
- "schema": {
1744
- "type": "string",
1745
- "example": "myFlowNodeInstance_12345678"
1746
- }
1747
- },
1748
- {
1749
- "name": "createdAt",
1750
- "in": "query",
1751
- "description": "The createdAt date for which to retrieve DataObjectInstances.",
1752
- "schema": {
1753
- "type": "string",
1754
- "example": "2020-01-01T00:00:00.000Z"
1755
- }
1756
- }
1757
- ],
1758
- "responses": {
1759
- "200": {
1760
- "description": "Returns a list of DataObjectInstances.",
1761
- "content": {
1762
- "application/json": {
1763
- "schema": {
1764
- "$ref": "#/components/schemas/DataObjectInstanceList"
1765
- }
1766
- }
1767
- }
1768
- }
1769
- }
1770
- }
1771
- },
1772
- "/flow_node_instances": {
1773
- "get": {
1774
- "description": "Gets all FlowNodeInstances that match the given query.",
1775
- "tags": ["FlowNodeInstances"],
1776
- "parameters": [
1777
- {
1778
- "name": "limit",
1779
- "in": "query",
1780
- "description": "The maximum amount of FlowNodeInstances to be returned.",
1781
- "schema": {
1782
- "type": "number",
1783
- "example": 100
1784
- }
1785
- },
1786
- {
1787
- "name": "offset",
1788
- "in": "query",
1789
- "description": "The index of the first FlowNodeInstance to be returned.",
1790
- "schema": {
1791
- "type": "number",
1792
- "example": 5
1793
- }
1794
- },
1795
- {
1796
- "name": "flowNodeInstanceId",
1797
- "in": "query",
1798
- "description": "The ID of the FlowNodeInstance to be returned.",
1799
- "schema": {
1800
- "type": "string",
1801
- "example": "myFlowNodeInstance_12345678"
1802
- }
1803
- },
1804
- {
1805
- "name": "flowNodeId",
1806
- "in": "query",
1807
- "description": "The ID of the FlowNode for which to retrieve FlowNodeInstances.",
1808
- "schema": {
1809
- "type": "string",
1810
- "example": "myFlowNode_12345678"
1811
- }
1812
- },
1813
- {
1814
- "name": "flowNodeName",
1815
- "in": "query",
1816
- "description": "The name of the FlowNode for which to retrieve FlowNodeInstances.",
1817
- "schema": {
1818
- "type": "string",
1819
- "example": "myFlowNode"
1820
- }
1821
- },
1822
- {
1823
- "name": "flowNodeLane",
1824
- "in": "query",
1825
- "description": "The name of the Lane for which to retrieve FlowNodeInstances.",
1826
- "schema": {
1827
- "type": "string",
1828
- "example": "myLane"
1829
- }
1830
- },
1831
- {
1832
- "name": "flowNodeType",
1833
- "in": "query",
1834
- "description": "The type of the FlowNode for which to retrieve FlowNodeInstances.",
1835
- "schema": {
1836
- "type": "string",
1837
- "example": "bpmn:BoundaryEvent"
1838
- }
1839
- },
1840
- {
1841
- "name": "eventType",
1842
- "in": "query",
1843
- "description": "The event type of the FlowNodeInstance to be returned.",
1844
- "schema": {
1845
- "type": "string",
1846
- "example": "messageEvent"
1847
- }
1848
- },
1849
- {
1850
- "name": "correlationId",
1851
- "in": "query",
1852
- "description": "The correlationId of the FlowNodeInstance to be returned.",
1853
- "schema": {
1854
- "type": "string",
1855
- "example": "myCorrelationId_12345678"
1856
- }
1857
- },
1858
- {
1859
- "name": "processDefinitionId",
1860
- "in": "query",
1861
- "description": "The ID of the ProcessDefinition for which to retrieve FlowNodeInstances.",
1862
- "schema": {
1863
- "type": "string",
1864
- "example": "myProcessDefinition_12345678"
1865
- }
1866
- },
1867
- {
1868
- "name": "processModelId",
1869
- "in": "query",
1870
- "description": "The ID of the ProcessModel for which to retrieve FlowNodeInstances.",
1871
- "schema": {
1872
- "type": "string",
1873
- "example": "myProcessModel_12345678"
1874
- }
1875
- },
1876
- {
1877
- "name": "processInstanceId",
1878
- "in": "query",
1879
- "description": "The ID of the ProcessInstance for which to retrieve FlowNodeInstances.",
1880
- "schema": {
1881
- "type": "string",
1882
- "example": "myProcessInstance_12345678"
1883
- }
1884
- },
1885
- {
1886
- "name": "ownerId",
1887
- "in": "query",
1888
- "description": "The ID of the FlowNodeInstance owner for which to retrieve FlowNodeInstances.",
1889
- "schema": {
1890
- "type": "string",
1891
- "example": "myOwner_12345678"
1892
- }
1893
- },
1894
- {
1895
- "name": "state",
1896
- "in": "query",
1897
- "description": "The state of the FlowNodeInstance to be returned.",
1898
- "schema": {
1899
- "type": "string",
1900
- "example": "running"
1901
- }
1902
- },
1903
- {
1904
- "name": "previousFlowNodeInstanceId",
1905
- "in": "query",
1906
- "description": "The ID of the previous FlowNodeInstance for which to retrieve FlowNodeInstances.",
1907
- "schema": {
1908
- "type": "string",
1909
- "example": "myPreviousFlowNodeInstance_12345678"
1910
- }
1911
- },
1912
- {
1913
- "name": "parentProcessInstanceId",
1914
- "in": "query",
1915
- "description": "The ID of the parent ProcessInstance for which to retrieve FlowNodeInstances.",
1916
- "schema": {
1917
- "type": "string",
1918
- "example": "myParentProcessInstance_12345678"
1919
- }
1920
- },
1921
- {
1922
- "name": "createdAt",
1923
- "in": "query",
1924
- "description": "The createdAt date for which to retrieve FlowNodeInstances.",
1925
- "schema": {
1926
- "type": "string",
1927
- "example": "2020-01-01T00:00:00.000Z"
1928
- }
1929
- },
1930
- {
1931
- "name": "updatedAt",
1932
- "in": "query",
1933
- "description": "The updatedAt date for which to retrieve FlowNodeInstances.",
1934
- "schema": {
1935
- "type": "string",
1936
- "example": "2020-01-01T00:00:00.000Z"
1937
- }
1938
- },
1939
- {
1940
- "name": "triggeredByFlowNodeInstance",
1941
- "in": "query",
1942
- "description": "The ID of the FlowNodeInstance that triggered the FlowNodeInstance to be returned.",
1943
- "schema": {
1944
- "type": "Array<string> | string | SearchQuery",
1945
- "oneOf": [
1946
- {
1947
- "type": "Array<string>",
1948
- "example": ["myTriggeredFlowNodeInstance_12345678", "myTriggeredFlowNodeInstance_87654321"]
1949
- },
1950
- {
1951
- "type": "string",
1952
- "example": "myTriggeredFlowNodeInstance_12345678"
1953
- },
1954
- {
1955
- "$ref": "#/components/schemas/SearchQuery"
1956
- }
1957
- ]
1958
- }
1959
- }
1960
- ],
1961
- "responses": {
1962
- "200": {
1963
- "description": "Returns a list of FlowNodeInstances.",
1964
- "content": {
1965
- "application/json": {
1966
- "schema": {
1967
- "$ref": "#/components/schemas/FlowNodeInstanceList"
1968
- }
1969
- }
1970
- }
1971
- }
1972
- }
1973
- }
1974
- },
1975
- "/messages/{eventName}/trigger": {
1976
- "post": {
1977
- "description": "Triggers a MessageEvent by its name.",
1978
- "tags": ["Events"],
1979
- "parameters": [
1980
- {
1981
- "name": "eventName",
1982
- "in": "path",
1983
- "description": "The name of the MessageEvent to be triggered.",
1984
- "required": true,
1985
- "schema": {
1986
- "type": "string",
1987
- "example": "myMessageEvent"
1988
- }
1989
- },
1990
- {
1991
- "name": "processInstanceId",
1992
- "in": "query",
1993
- "description": "The ID of the ProcessInstance for which to trigger the MessageEvent.",
1994
- "required": false,
1995
- "schema": {
1996
- "type": "string",
1997
- "example": "myProcessInstance_12345678"
1998
- }
1999
- }
2000
- ],
2001
- "requestBody": {
2002
- "content": {
2003
- "application/json": {
2004
- "required": false,
2005
- "schema": {
2006
- "type": "object",
2007
- "properties": {
2008
- "payload": {
2009
- "type": "string",
2010
- "description": "The payload to be sent with the MessageEvent.",
2011
- "required": false,
2012
- "example": "myPayload"
2013
- }
2014
- }
2015
- }
2016
- }
2017
- }
2018
- },
2019
- "responses": {
2020
- "204": {
2021
- "description": "Indicates the MessageEvent was successfully triggered."
2022
- }
2023
- }
2024
- }
2025
- },
2026
- "/signals/{eventName}/trigger": {
2027
- "post": {
2028
- "description": "Triggers a SignalEvent by its name.",
2029
- "tags": ["Events"],
2030
- "parameters": [
2031
- {
2032
- "name": "eventName",
2033
- "in": "path",
2034
- "description": "The name of the SignalEvent to be triggered.",
2035
- "required": true,
2036
- "schema": {
2037
- "type": "string",
2038
- "example": "mySignalEvent"
2039
- }
2040
- },
2041
- {
2042
- "name": "process_instance_id",
2043
- "in": "query",
2044
- "description": "The ID of the ProcessInstance for which to trigger the SignalEvent.",
2045
- "required": false,
2046
- "schema": {
2047
- "type": "string",
2048
- "example": "myProcessInstance_12345678"
2049
- }
2050
- }
2051
- ],
2052
- "responses": {
2053
- "204": {
2054
- "description": "Indicates the SignalEvent was successfully triggered."
2055
- }
2056
- }
2057
- }
2058
- },
2059
- "/empty_activities/{emptyActivityInstanceId}/finish": {
2060
- "put": {
2061
- "deprecated": true,
2062
- "description": "DEPRECATED - Use `PUT /untyped_tasks/:untyped_task_instance_id/finish` instead.",
2063
- "tags": ["UntypedTasks"],
2064
- "parameters": [
2065
- {
2066
- "name": "emptyActivityInstanceId",
2067
- "in": "path",
2068
- "description": "The ID of the EmptyActivityInstance to be finished.",
2069
- "required": true,
2070
- "schema": {
2071
- "type": "string",
2072
- "example": "myEmptyActivityInstance_12345678"
2073
- }
2074
- }
2075
- ],
2076
- "responses": {
2077
- "204": {
2078
- "description": "Indicates the EmptyActivityInstance was successfully finished."
2079
- }
2080
- }
2081
- }
2082
- },
2083
- "/untyped_tasks/{untypedTaskInstanceId}/finish": {
2084
- "put": {
2085
- "description": "Finishes a specific UntypedTask by its UntypedTaskInstanceId.",
2086
- "tags": ["UntypedTasks"],
2087
- "parameters": [
2088
- {
2089
- "name": "untypedTaskInstanceId",
2090
- "in": "path",
2091
- "description": "The ID of the UntypedTaskInstance to be finished.",
2092
- "required": true,
2093
- "schema": {
2094
- "type": "string",
2095
- "example": "myUntypedTaskInstance_12345678"
2096
- }
2097
- }
2098
- ],
2099
- "responses": {
2100
- "204": {
2101
- "description": "Indicates the UntypedTaskInstance was successfully finished."
2102
- }
2103
- }
2104
- }
2105
- },
2106
- "/manual_tasks/{manualTaskInstanceId}/finish": {
2107
- "put": {
2108
- "description": "Finishes a specific ManualTask by its ManualTaskInstanceId.",
2109
- "tags": ["ManualTasks"],
2110
- "parameters": [
2111
- {
2112
- "name": "manualTaskInstanceId",
2113
- "in": "path",
2114
- "description": "The ID of the ManualTaskInstance to be finished.",
2115
- "required": true,
2116
- "schema": {
2117
- "type": "string",
2118
- "example": "myManualTaskInstance_12345678"
2119
- }
2120
- }
2121
- ],
2122
- "responses": {
2123
- "204": {
2124
- "description": "Indicates the ManualTaskInstance was successfully finished."
2125
- }
2126
- }
2127
- }
2128
- },
2129
- "/user_tasks/{userTaskInstanceId}/finish": {
2130
- "put": {
2131
- "description": "Finishes a specific UserTask by its UserTaskInstanceId.",
2132
- "tags": ["UserTasks"],
2133
- "parameters": [
2134
- {
2135
- "name": "userTaskInstanceId",
2136
- "in": "path",
2137
- "description": "The ID of the UserTaskInstance to be finished.",
2138
- "required": true,
2139
- "schema": {
2140
- "type": "string",
2141
- "example": "myUserTaskInstance_12345678"
2142
- }
2143
- }
2144
- ],
2145
- "requestBody": {
2146
- "content": {
2147
- "application/json": {
2148
- "required": false,
2149
- "schema": {
2150
- "type": "object"
2151
- }
2152
- }
2153
- }
2154
- },
2155
- "responses": {
2156
- "204": {
2157
- "description": "Indicates the UserTaskInstance was successfully finished."
2158
- }
2159
- }
2160
- }
2161
- },
2162
- "/user_tasks/{userTaskInstanceId}/reserve": {
2163
- "put": {
2164
- "description": "Reserves a UserTask for a specific User.",
2165
- "tags": ["UserTasks"],
2166
- "parameters": [
2167
- {
2168
- "name": "userTaskInstanceId",
2169
- "in": "path",
2170
- "description": "The ID of the UserTaskInstance to be reserved.",
2171
- "required": true,
2172
- "schema": {
2173
- "type": "string",
2174
- "example": "myUserTaskInstance_12345678"
2175
- }
2176
- }
2177
- ],
2178
- "requestBody": {
2179
- "content": {
2180
- "application/json": {
2181
- "required": true,
2182
- "schema": {
2183
- "type": "object",
2184
- "properties": {
2185
- "actualOwnerId": {
2186
- "type": "string",
2187
- "description": "The ID of the User who reserves the UserTask.",
2188
- "required": true,
2189
- "example": "myUser_12345678"
2190
- }
2191
- }
2192
- }
2193
- }
2194
- }
2195
- },
2196
- "responses": {
2197
- "204": {
2198
- "description": "Indicates the UserTaskInstance was successfully reserved."
2199
- }
2200
- }
2201
- }
2202
- },
2203
- "/user_tasks/{userTaskInstanceId}/cancel-reservation": {
2204
- "delete": {
2205
- "description": "Cancels the reservation of the given UserTask instance.",
2206
- "tags": ["UserTasks"],
2207
- "parameters": [
2208
- {
2209
- "name": "userTaskInstanceId",
2210
- "in": "path",
2211
- "description": "The ID of the UserTaskInstance for which to cancel the reservation.",
2212
- "required": true,
2213
- "schema": {
2214
- "type": "string",
2215
- "example": "myUserTaskInstance_12345678"
2216
- }
2217
- }
2218
- ],
2219
- "responses": {
2220
- "204": {
2221
- "description": "Indicates the UserTaskInstance reservation was successfully canceled."
2222
- }
2223
- }
2224
- }
2225
- },
2226
- "/external_tasks/deployed_topics": {
2227
- "get": {
2228
- "description": "Fetches a list of all ExternalTask topics from all deployed Process Models.",
2229
- "tags": ["ExternalTasks"],
2230
- "responses": {
2231
- "200": {
2232
- "description": "A list of all ExternalTask topics from all deployed Process Models.",
2233
- "content": {
2234
- "application/json": {
2235
- "schema": {
2236
- "description": "A list of all ExternalTask topics from all deployed Process Models.",
2237
- "type": "array",
2238
- "items": {
2239
- "type": "string"
2240
- },
2241
- "example": ["myTopic", "myOtherTopic", "myThirdTopic", "myFourthTopic"]
2242
- }
2243
- }
2244
- }
2245
- }
2246
- }
2247
- }
2248
- },
2249
- "/external_tasks/fetch_and_lock": {
2250
- "post": {
2251
- "description": "Fetches the tasks available for an ExternalTaskWorker and locks them for a defined time.",
2252
- "tags": ["ExternalTasks"],
2253
- "requestBody": {
2254
- "content": {
2255
- "application/json": {
2256
- "required": true,
2257
- "schema": {
2258
- "$ref": "#/components/schemas/FetchAndLockRequestPayload"
2259
- }
2260
- }
2261
- },
2262
- "example": {
2263
- "workerId": "string",
2264
- "topicName": "string | Array<string>",
2265
- "maxTasks": 10,
2266
- "longPollingTimeout": 2000,
2267
- "lockDuration": 10000,
2268
- "payloadFilter": "string"
2269
- }
2270
- },
2271
- "responses": {
2272
- "204": {
2273
- "description": "A list of locked ExternalTasks.",
2274
- "content": {
2275
- "application/json": {
2276
- "schema": {
2277
- "type": "array",
2278
- "items": {
2279
- "$ref": "#/components/schemas/ExternalTask"
2280
- }
2281
- }
2282
- }
2283
- }
2284
- }
2285
- }
2286
- }
2287
- },
2288
- "/external_tasks/{externalTaskId}/extend_lock": {
2289
- "put": {
2290
- "description": "Extends the lock duration of an ExternalTask by a given amount of time.",
2291
- "tags": ["ExternalTasks"],
2292
- "parameters": [
2293
- {
2294
- "name": "externalTaskId",
2295
- "in": "path",
2296
- "description": "The ID of the ExternalTask for which to extend the lock duration.",
2297
- "required": true,
2298
- "schema": {
2299
- "type": "string",
2300
- "example": "myExternalTask_12345678"
2301
- }
2302
- }
2303
- ],
2304
- "requestBody": {
2305
- "content": {
2306
- "application/json": {
2307
- "required": true,
2308
- "schema": {
2309
- "$ref": "#/components/schemas/ExtendLockRequestPayload"
2310
- }
2311
- }
2312
- }
2313
- },
2314
- "responses": {
2315
- "204": {
2316
- "description": "Indicates the ExternalTask lock was successfully extended."
2317
- }
2318
- }
2319
- }
2320
- },
2321
- "/external_tasks/{externalTaskId}/error": {
2322
- "put": {
2323
- "description": "Finishes the given External Task with the given Error.",
2324
- "tags": ["ExternalTasks"],
2325
- "parameters": [
2326
- {
2327
- "name": "externalTaskId",
2328
- "in": "path",
2329
- "description": "The ID of the ExternalTask for which to finish with an Error.",
2330
- "required": true,
2331
- "schema": {
2332
- "type": "string",
2333
- "example": "myExternalTask_12345678"
2334
- }
2335
- }
2336
- ],
2337
- "requestBody": {
2338
- "content": {
2339
- "application/json": {
2340
- "required": true,
2341
- "schema": {
2342
- "$ref": "#/components/schemas/HandleExternalTaskErrorRequestPayload"
2343
- }
2344
- }
2345
- }
2346
- },
2347
- "responses": {
2348
- "204": {
2349
- "description": "Indicates the ExternalTask was successfully finished with an Error."
2350
- }
2351
- }
2352
- }
2353
- },
2354
- "/external_tasks/{externalTaskId}/finish": {
2355
- "put": {
2356
- "description": "Finishes the ExternalTask with the given ID.",
2357
- "tags": ["ExternalTasks"],
2358
- "parameters": [
2359
- {
2360
- "name": "externalTaskId",
2361
- "in": "path",
2362
- "description": "The ID of the ExternalTask to finish.",
2363
- "required": true,
2364
- "schema": {
2365
- "type": "string",
2366
- "example": "myExternalTask_12345678"
2367
- }
2368
- }
2369
- ],
2370
- "requestBody": {
2371
- "content": {
2372
- "application/json": {
2373
- "required": true,
2374
- "schema": {
2375
- "$ref": "#/components/schemas/FinishExternalTaskRequestPayload"
2376
- }
2377
- }
2378
- }
2379
- },
2380
- "responses": {
2381
- "204": {
2382
- "description": "Indicates the ExternalTask was successfully finished."
2383
- }
2384
- }
2385
- }
2386
- },
2387
- "/process_definitions": {
2388
- "post": {
2389
- "description": "Creates or updates a ProcessDefinition or a list of ProcessDefinitions.",
2390
- "tags": ["ProcessDefinitions"],
2391
- "requestBody": {
2392
- "content": {
2393
- "application/json": {
2394
- "required": true,
2395
- "schema": {
2396
- "$ref": "#/components/schemas/PersistProcessDefinitionsPayload"
2397
- }
2398
- }
2399
- },
2400
- "example": {
2401
- "xml": "string | Array<string>",
2402
- "overrideExisting": true
2403
- }
2404
- },
2405
- "responses": {
2406
- "201": {
2407
- "description": "Indicates the ProcessDefinition(s) was/were successfully persisted."
2408
- }
2409
- }
2410
- },
2411
- "get": {
2412
- "description": "Gets all ProcessDefinitions the requesting user is allowed to see.",
2413
- "tags": ["ProcessDefinitions"],
2414
- "parameters": [
2415
- {
2416
- "name": "offset",
2417
- "in": "query",
2418
- "description": "The index of the first ProcessDefinition to include.",
2419
- "required": false,
2420
- "schema": {
2421
- "type": "number",
2422
- "example": 0
2423
- }
2424
- },
2425
- {
2426
- "name": "limit",
2427
- "in": "query",
2428
- "description": "The maximum number of ProcessDefinitions to include.",
2429
- "required": false,
2430
- "schema": {
2431
- "type": "number",
2432
- "example": 10
2433
- }
2434
- }
2435
- ],
2436
- "responses": {
2437
- "200": {
2438
- "description": "A list of ProcessDefinitions.",
2439
- "content": {
2440
- "application/json": {
2441
- "schema": {
2442
- "$ref": "#/components/schemas/ProcessDefinitionList"
2443
- }
2444
- }
2445
- }
2446
- }
2447
- }
2448
- }
2449
- },
2450
- "/process_definitions/{processDefinitionId}": {
2451
- "get": {
2452
- "description": "Gets a ProcessDefinition by its id.",
2453
- "tags": ["ProcessDefinitions"],
2454
- "parameters": [
2455
- {
2456
- "name": "processDefinitionId",
2457
- "in": "path",
2458
- "description": "The ID of the ProcessDefinition to retrieve.",
2459
- "required": true,
2460
- "schema": {
2461
- "type": "string",
2462
- "example": "myProcess_12345678"
2463
- }
2464
- }
2465
- ],
2466
- "responses": {
2467
- "200": {
2468
- "description": "A ProcessDefinitions.",
2469
- "content": {
2470
- "application/json": {
2471
- "schema": {
2472
- "$ref": "#/components/schemas/ProcessDefinition"
2473
- }
2474
- }
2475
- }
2476
- }
2477
- }
2478
- },
2479
- "delete": {
2480
- "description": "Deletes the ProcessDefinition with the given ID.",
2481
- "tags": ["ProcessDefinitions"],
2482
- "parameters": [
2483
- {
2484
- "name": "processDefinitionId",
2485
- "in": "path",
2486
- "description": "The ID of the ProcessDefinition to delete.",
2487
- "required": true,
2488
- "schema": {
2489
- "type": "string",
2490
- "example": "myProcess_12345678"
2491
- }
2492
- },
2493
- {
2494
- "name": "delete_all_related_data",
2495
- "in": "query",
2496
- "description": "If set to true, all ProcessInstances and ProcessModels related to the ProcessDefinition will be deleted as well.",
2497
- "required": false,
2498
- "schema": {
2499
- "type": "boolean",
2500
- "example": true
2501
- }
2502
- }
2503
- ],
2504
- "responses": {
2505
- "204": {
2506
- "description": "Indicates the ProcessDefinition was successfully deleted."
2507
- }
2508
- }
2509
- }
2510
- },
2511
- "/process_models": {
2512
- "get": {
2513
- "description": "Gets all currently deployed Process Models.",
2514
- "tags": ["ProcessModels"],
2515
- "responses": {
2516
- "200": {
2517
- "content": {
2518
- "application/json": {
2519
- "schema": {
2520
- "$ref": "#/components/schemas/ProcessModelList"
2521
- }
2522
- }
2523
- }
2524
- }
2525
- }
2526
- }
2527
- },
2528
- "/process_models/{processModelId}/": {
2529
- "get": {
2530
- "description": "Gets a deployed Process Model by its ID.",
2531
- "tags": ["ProcessModels"],
2532
- "parameters": [
2533
- {
2534
- "name": "processModelId",
2535
- "in": "path",
2536
- "description": "The ID of the ProcessModel to retrieve.",
2537
- "required": true,
2538
- "schema": {
2539
- "type": "string",
2540
- "example": "myProcess_12345678"
2541
- }
2542
- }
2543
- ],
2544
- "responses": {
2545
- "200": {
2546
- "content": {
2547
- "application/json": {
2548
- "schema": {
2549
- "$ref": "#/components/schemas/ProcessModel"
2550
- }
2551
- }
2552
- }
2553
- }
2554
- }
2555
- }
2556
- },
2557
- "/process_models/{processModelId}/process_definition": {
2558
- "get": {
2559
- "description": "Gets a ProcessDefinition for a given ProcessModel.",
2560
- "tags": ["ProcessModels"],
2561
- "parameters": [
2562
- {
2563
- "name": "processModelId",
2564
- "in": "path",
2565
- "description": "The ID of the ProcessModel for which to retrieve the ProcessDefinition.",
2566
- "required": true,
2567
- "schema": {
2568
- "type": "string",
2569
- "example": "myProcess_12345678"
2570
- }
2571
- }
2572
- ],
2573
- "responses": {
2574
- "200": {
2575
- "content": {
2576
- "application/json": {
2577
- "schema": {
2578
- "$ref": "#/components/schemas/ProcessDefinition"
2579
- }
2580
- }
2581
- }
2582
- }
2583
- }
2584
- }
2585
- },
2586
- "/process_models/{processModelId}/start": {
2587
- "post": {
2588
- "description": "Starts a new instance from the given set of parameters.",
2589
- "tags": ["ProcessModels"],
2590
- "parameters": [
2591
- {
2592
- "name": "processModelId",
2593
- "in": "path",
2594
- "description": "The ID of the ProcessModel for which to start a new instance.",
2595
- "required": true,
2596
- "schema": {
2597
- "type": "string",
2598
- "example": "myProcess_12345678"
2599
- }
2600
- }
2601
- ],
2602
- "requestBody": {
2603
- "content": {
2604
- "application/json": {
2605
- "required": true,
2606
- "schema": {
2607
- "$ref": "#/components/schemas/ProcessStartRequest"
2608
- }
2609
- }
2610
- }
2611
- },
2612
- "responses": {
2613
- "200": {
2614
- "content": {
2615
- "application/json": {
2616
- "schema": {
2617
- "$ref": "#/components/schemas/ProcessStartResponse"
2618
- }
2619
- }
2620
- }
2621
- }
2622
- }
2623
- }
2624
- },
2625
- "/process_models/{processModelId}": {
2626
- "delete": {
2627
- "description": "Deletes the ProcessDefinition that contains the Process Model with the given ID.",
2628
- "tags": ["ProcessModels"],
2629
- "parameters": [
2630
- {
2631
- "name": "processModelId",
2632
- "in": "path",
2633
- "description": "The ID of the ProcessModel for which to delete the ProcessDefinition.",
2634
- "required": true,
2635
- "schema": {
2636
- "type": "string",
2637
- "example": "myProcess_12345678"
2638
- }
2639
- },
2640
- {
2641
- "name": "delete_all_related_data",
2642
- "in": "query",
2643
- "description": "If set to true, all ProcessInstances related to the ProcessDefinition will be deleted as well.",
2644
- "required": false,
2645
- "schema": {
2646
- "type": "boolean",
2647
- "example": true
2648
- }
2649
- }
2650
- ],
2651
- "responses": {
2652
- "204": {
2653
- "description": "Indicates the ProcessDefinition was successfully deleted."
2654
- }
2655
- }
2656
- }
2657
- },
2658
- "/process_models/{processModelId}/enable": {
2659
- "post": {
2660
- "description": "Enables the given Process Model.",
2661
- "tags": ["ProcessModels"],
2662
- "parameters": [
2663
- {
2664
- "name": "processModelId",
2665
- "in": "path",
2666
- "description": "The ID of the ProcessModel to enable.",
2667
- "required": true,
2668
- "schema": {
2669
- "type": "string",
2670
- "example": "myProcess_12345678"
2671
- }
2672
- }
2673
- ],
2674
- "responses": {
2675
- "204": {
2676
- "description": "Indicates the ProcessModel was successfully enabled."
2677
- }
2678
- }
2679
- }
2680
- },
2681
- "/process_models/{processModelId}/disable": {
2682
- "post": {
2683
- "description": "Disables the given Process Model.",
2684
- "tags": ["ProcessModels"],
2685
- "parameters": [
2686
- {
2687
- "name": "processModelId",
2688
- "in": "path",
2689
- "description": "The ID of the ProcessModel to disable.",
2690
- "required": true,
2691
- "schema": {
2692
- "type": "string",
2693
- "example": "myProcess_12345678"
2694
- }
2695
- }
2696
- ],
2697
- "responses": {
2698
- "204": {
2699
- "description": "Indicates the ProcessModel was successfully disabled"
2700
- }
2701
- }
2702
- }
2703
- },
2704
- "/process_instances/query": {
2705
- "get": {
2706
- "description": "Gets all ProcessInstances that match the given query.",
2707
- "tags": ["ProcessInstances"],
2708
- "parameters": [
2709
- {
2710
- "name": "offset",
2711
- "in": "query",
2712
- "description": "The index of the first ProcessInstance to include in the result set.",
2713
- "required": false,
2714
- "schema": {
2715
- "type": "number",
2716
- "example": 0
2717
- }
2718
- },
2719
- {
2720
- "name": "limit",
2721
- "in": "query",
2722
- "description": "The maximum number of ProcessInstances to return.",
2723
- "required": false,
2724
- "schema": {
2725
- "type": "number",
2726
- "example": 10
2727
- }
2728
- },
2729
- {
2730
- "name": "correlationId",
2731
- "in": "query",
2732
- "description": "Filter by the CorrelationId of the ProcessInstances.",
2733
- "required": false,
2734
- "schema": {
2735
- "type": "Array<string> | string | SearchQuery",
2736
- "oneOf": [
2737
- {
2738
- "type": "string",
2739
- "example": "myCorrelationId"
2740
- },
2741
- {
2742
- "type": "Array<string>",
2743
- "example": ["myCorrelationId1", "myCorrelationId2"]
2744
- },
2745
- {
2746
- "$ref": "#/components/schemas/SearchQuery"
2747
- }
2748
- ]
2749
- }
2750
- },
2751
- {
2752
- "name": "processInstanceId",
2753
- "in": "query",
2754
- "description": "Filter by the ID of the ProcessInstances.",
2755
- "schema": {
2756
- "type": "Array<string> | string | SearchQuery",
2757
- "oneOf": [
2758
- {
2759
- "type": "string",
2760
- "example": "myProcessInstance_12345678"
2761
- },
2762
- {
2763
- "type": "Array<string>",
2764
- "example": ["myProcessInstance_12345678", "myProcessInstance_87654321"]
2765
- },
2766
- {
2767
- "$ref": "#/components/schemas/SearchQuery"
2768
- }
2769
- ]
2770
- }
2771
- },
2772
- {
2773
- "name": "processDefinitionId",
2774
- "in": "query",
2775
- "description": "Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.",
2776
- "schema": {
2777
- "type": "Array<string> | string | SearchQuery",
2778
- "oneOf": [
2779
- {
2780
- "type": "string",
2781
- "example": "myProcess_12345678"
2782
- },
2783
- {
2784
- "type": "Array<string>",
2785
- "example": ["myProcess_12345678", "myProcess_87654321"]
2786
- },
2787
- {
2788
- "$ref": "#/components/schemas/SearchQuery"
2789
- }
2790
- ]
2791
- }
2792
- },
2793
- {
2794
- "name": "processModelId",
2795
- "in": "query",
2796
- "description": "Filter by the ID of the ProcessModel that the ProcessInstances belong to.",
2797
- "schema": {
2798
- "type": "Array<string> | string | SearchQuery",
2799
- "oneOf": [
2800
- {
2801
- "type": "string",
2802
- "example": "myProcessModel_12345678"
2803
- },
2804
- {
2805
- "type": "Array<string>",
2806
- "example": ["myProcessModel_12345678", "myProcessModel_87654321"]
2807
- },
2808
- {
2809
- "$ref": "#/components/schemas/SearchQuery"
2810
- }
2811
- ]
2812
- }
2813
- },
2814
- {
2815
- "name": "processModelName",
2816
- "in": "query",
2817
- "description": "Filter by the name of the ProcessModel that the ProcessInstances belong to.",
2818
- "schema": {
2819
- "type": "Array<string> | string | SearchQuery",
2820
- "oneOf": [
2821
- {
2822
- "type": "string",
2823
- "example": "My Process Model"
2824
- },
2825
- {
2826
- "type": "Array<string>",
2827
- "example": ["My Process Model", "My Other Process Model"]
2828
- },
2829
- {
2830
- "$ref": "#/components/schemas/SearchQuery"
2831
- }
2832
- ]
2833
- }
2834
- },
2835
- {
2836
- "name": "processModelHash",
2837
- "in": "query",
2838
- "description": "Filter by the hash of the ProcessModel that the ProcessInstances belong to.",
2839
- "schema": {
2840
- "type": "Array<string> | string | SearchQuery",
2841
- "oneOf": [
2842
- {
2843
- "type": "string",
2844
- "example": 12345678
2845
- },
2846
- {
2847
- "type": "Array<string>",
2848
- "example": ["12345678", "87654321"]
2849
- },
2850
- {
2851
- "$ref": "#/components/schemas/SearchQuery"
2852
- }
2853
- ]
2854
- }
2855
- },
2856
- {
2857
- "name": "ownerId",
2858
- "in": "query",
2859
- "description": "Filter by the ID of the User that owns the ProcessInstances.",
2860
- "schema": {
2861
- "type": "Array<string> | string | SearchQuery",
2862
- "oneOf": [
2863
- {
2864
- "type": "string",
2865
- "example": 12345678
2866
- },
2867
- {
2868
- "type": "Array<string>",
2869
- "example": ["12345678", "87654321"]
2870
- },
2871
- {
2872
- "$ref": "#/components/schemas/SearchQuery"
2873
- }
2874
- ]
2875
- }
2876
- },
2877
- {
2878
- "name": "state",
2879
- "in": "query",
2880
- "description": "Filter by the state of the ProcessInstances.",
2881
- "schema": {
2882
- "type": "Array<string> | string | SearchQuery",
2883
- "oneOf": [
2884
- {
2885
- "type": "string",
2886
- "example": "running"
2887
- },
2888
- {
2889
- "type": "Array<string>",
2890
- "example": ["running", "finished"]
2891
- },
2892
- {
2893
- "$ref": "#/components/schemas/SearchQuery"
2894
- }
2895
- ]
2896
- }
2897
- },
2898
- {
2899
- "name": "parentProcessInstanceId",
2900
- "in": "query",
2901
- "description": "Filter by the ID of the parent ProcessInstance.",
2902
- "schema": {
2903
- "type": "Array<string> | string | SearchQuery",
2904
- "oneOf": [
2905
- {
2906
- "type": "string",
2907
- "example": "myParentProcessInstance_12345678"
2908
- },
2909
- {
2910
- "type": "Array<string>",
2911
- "example": ["myParentProcessInstance_12345678", "myParentProcessInstance_87654321"]
2912
- },
2913
- {
2914
- "$ref": "#/components/schemas/SearchQuery"
2915
- }
2916
- ]
2917
- }
2918
- },
2919
- {
2920
- "name": "terminatedByUserId",
2921
- "in": "query",
2922
- "description": "Filter by the ID of the User that terminated the ProcessInstances.",
2923
- "schema": {
2924
- "type": "Array<string> | string | SearchQuery",
2925
- "oneOf": [
2926
- {
2927
- "type": "string",
2928
- "example": 12345678
2929
- },
2930
- {
2931
- "type": "Array<string>",
2932
- "example": ["12345678", "87654321"]
2933
- },
2934
- {
2935
- "$ref": "#/components/schemas/SearchQuery"
2936
- }
2937
- ]
2938
- }
2939
- },
2940
- {
2941
- "name": "createdBefore",
2942
- "in": "query",
2943
- "description": "The maximum created date of the ProcessInstances to include in the results.",
2944
- "schema": {
2945
- "type": "string",
2946
- "example": "2021-01-01T00:00:00.000Z"
2947
- }
2948
- },
2949
- {
2950
- "name": "createdAt",
2951
- "in": "query",
2952
- "description": "The minimum created date of the ProcessInstances to include in the results.",
2953
- "schema": {
2954
- "type": "Array<string> | string",
2955
- "oneOf": [
2956
- {
2957
- "type": "string",
2958
- "example": "2021-01-01T00:00:00.000Z"
2959
- },
2960
- {
2961
- "type": "array",
2962
- "items": {
2963
- "type": "string"
2964
- },
2965
- "example": ["2021-01-01T00:00:00.000Z", "2021-01-02T00:00:00.000Z"]
2966
- }
2967
- ]
2968
- }
2969
- },
2970
- {
2971
- "name": "createdAfter",
2972
- "in": "query",
2973
- "description": "The minimum created date of the ProcessInstances to include in the results.",
2974
- "schema": {
2975
- "type": "string",
2976
- "example": "2021-01-01T00:00:00.000Z"
2977
- }
2978
- },
2979
- {
2980
- "name": "updatedBefore",
2981
- "in": "query",
2982
- "description": "The maximum updated date of the ProcessInstances to include in the results.",
2983
- "schema": {
2984
- "type": "string",
2985
- "example": "2021-01-01T00:00:00.000Z"
2986
- }
2987
- },
2988
- {
2989
- "name": "updatedAt",
2990
- "in": "query",
2991
- "description": "The exact updated date of the ProcessInstances to include in the results.",
2992
- "schema": {
2993
- "type": "Array<string> | string",
2994
- "oneOf": [
2995
- {
2996
- "type": "string",
2997
- "example": "2021-01-01T00:00:00.000Z"
2998
- },
2999
- {
3000
- "type": "array",
3001
- "items": {
3002
- "type": "string"
3003
- },
3004
- "example": ["2021-01-01T00:00:00.000Z", "2021-01-02T00:00:00.000Z"]
3005
- }
3006
- ]
3007
- }
3008
- },
3009
- {
3010
- "name": "updatedAfter",
3011
- "in": "query",
3012
- "description": "The minimum updated date of the ProcessInstances to include in the results.",
3013
- "schema": {
3014
- "type": "string",
3015
- "example": "2021-01-01T00:00:00.000Z"
3016
- }
3017
- },
3018
- {
3019
- "name": "finishedBefore",
3020
- "in": "query",
3021
- "description": "The maximum finished date of the ProcessInstances to include in the results.",
3022
- "schema": {
3023
- "type": "string",
3024
- "example": "2021-01-01T00:00:00.000Z"
3025
- }
3026
- },
3027
- {
3028
- "name": "finishedAt",
3029
- "in": "query",
3030
- "description": "The exact finished date of the ProcessInstances to include in the results.",
3031
- "schema": {
3032
- "type": "Array<string> | string",
3033
- "oneOf": [
3034
- {
3035
- "type": "string",
3036
- "example": "2021-01-01T00:00:00.000Z"
3037
- },
3038
- {
3039
- "type": "array",
3040
- "items": {
3041
- "type": "string"
3042
- },
3043
- "example": ["2021-01-01T00:00:00.000Z", "2021-01-02T00:00:00.000Z"]
3044
- }
3045
- ]
3046
- }
3047
- },
3048
- {
3049
- "name": "finishedAfter",
3050
- "in": "query",
3051
- "description": "The minimum finished date of the ProcessInstances to include in the results.",
3052
- "schema": {
3053
- "type": "string",
3054
- "example": "2021-01-01T00:00:00.000Z"
3055
- }
3056
- },
3057
- {
3058
- "name": "triggeredByFlowNodeInstance",
3059
- "in": "query",
3060
- "description": "Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.",
3061
- "schema": {
3062
- "type": "Array<string> | string | SearchQuery",
3063
- "oneOf": [
3064
- {
3065
- "type": "string",
3066
- "example": "myFlowNodeInstance_12345678"
3067
- },
3068
- {
3069
- "type": "array",
3070
- "items": {
3071
- "type": "string"
3072
- },
3073
- "example": ["myFlowNodeInstance_12345678", "myFlowNodeInstance_87654321"]
3074
- },
3075
- {
3076
- "$ref": "#/components/schemas/SearchQuery"
3077
- }
3078
- ]
3079
- }
3080
- }
3081
- ],
3082
- "responses": {
3083
- "200": {
3084
- "content": {
3085
- "application/json": {
3086
- "schema": {
3087
- "$ref": "#/components/schemas/ProcessInstanceList"
3088
- }
3089
- }
3090
- }
3091
- }
3092
- }
3093
- }
3094
- },
3095
- "/process_instances/{processInstanceId}/process_definition": {
3096
- "get": {
3097
- "description": "Gets the ProcessDefinition for a given ProcessInstance.",
3098
- "tags": ["ProcessInstances"],
3099
- "parameters": [
3100
- {
3101
- "name": "processInstanceId",
3102
- "in": "path",
3103
- "description": "The ID of the ProcessInstance for which the ProcessDefinition should be retrieved.",
3104
- "required": true,
3105
- "schema": {
3106
- "type": "string",
3107
- "example": 12345678
3108
- }
3109
- }
3110
- ],
3111
- "responses": {
3112
- "200": {
3113
- "content": {
3114
- "application/json": {
3115
- "schema": {
3116
- "$ref": "#/components/schemas/ProcessDefinition"
3117
- }
3118
- }
3119
- }
3120
- }
3121
- }
3122
- }
3123
- },
3124
- "/process_instances/{processInstanceId}/process_model": {
3125
- "get": {
3126
- "description": "Gets the ProcessModel for a given ProcessInstance.",
3127
- "tags": ["ProcessInstances"],
3128
- "parameters": [
3129
- {
3130
- "name": "processInstanceId",
3131
- "in": "path",
3132
- "description": "The ID of the ProcessInstance for which the ProcessModel should be retrieved.",
3133
- "required": true,
3134
- "schema": {
3135
- "type": "string",
3136
- "example": 12345678
3137
- }
3138
- }
3139
- ],
3140
- "responses": {
3141
- "200": {
3142
- "content": {
3143
- "application/json": {
3144
- "schema": {
3145
- "$ref": "#/components/schemas/ProcessModel"
3146
- }
3147
- }
3148
- }
3149
- }
3150
- }
3151
- }
3152
- },
3153
- "/process_instances/{processInstanceId}/change_owner": {
3154
- "post": {
3155
- "description": "Changes the owner of the ProcessInstance with the given ID.",
3156
- "tags": ["ProcessInstances"],
3157
- "parameters": [
3158
- {
3159
- "name": "processInstanceId",
3160
- "in": "path",
3161
- "description": "The ID of the ProcessInstance for which the owner should be changed.",
3162
- "required": true,
3163
- "schema": {
3164
- "type": "string",
3165
- "example": 12345678
3166
- }
3167
- }
3168
- ],
3169
- "requestBody": {
3170
- "content": {
3171
- "application/json": {
3172
- "required": true,
3173
- "schema": {
3174
- "type": "object",
3175
- "properties": {
3176
- "newOwner": {
3177
- "description": "The new owner of the ProcessInstance.",
3178
- "$ref": "#/components/schemas/Identity",
3179
- "required": true
3180
- }
3181
- }
3182
- }
3183
- }
3184
- }
3185
- },
3186
- "responses": {
3187
- "204": {
3188
- "description": "Indicates the ProcessInstance owner was changed successfully."
3189
- }
3190
- }
3191
- }
3192
- },
3193
- "/process_instances/{processInstanceId}/terminate": {
3194
- "put": {
3195
- "description": "Terminates the ProcessInstance with the given ID.",
3196
- "tags": ["ProcessInstances"],
3197
- "parameters": [
3198
- {
3199
- "name": "processInstanceId",
3200
- "in": "path",
3201
- "description": "The ID of the ProcessInstance to terminate.",
3202
- "required": true,
3203
- "schema": {
3204
- "type": "string",
3205
- "example": 12345678
3206
- }
3207
- }
3208
- ],
3209
- "responses": {
3210
- "204": {
3211
- "description": "Indicates the ProcessInstance was terminated successfully."
3212
- }
3213
- }
3214
- }
3215
- },
3216
- "/process_instances/{processInstanceId}/retry": {
3217
- "put": {
3218
- "description": "Retries a failed or terminated Process Instance from the original point of failure.",
3219
- "tags": ["ProcessInstances"],
3220
- "parameters": [
3221
- {
3222
- "name": "processInstanceId",
3223
- "in": "path",
3224
- "description": "The ID of the ProcessInstance to retry.",
3225
- "required": true,
3226
- "schema": {
3227
- "type": "string",
3228
- "example": 12345678
3229
- }
3230
- },
3231
- {
3232
- "name": "flow_node_instance_id",
3233
- "in": "query",
3234
- "description": "The ID of the FlowNodeInstance to retry from.",
3235
- "schema": {
3236
- "type": "string",
3237
- "example": 12345678
3238
- }
3239
- }
3240
- ],
3241
- "requestBody": {
3242
- "content": {
3243
- "application/json": {
3244
- "required": false,
3245
- "schema": {
3246
- "type": "object",
3247
- "properties": {
3248
- "newStartToken": {
3249
- "type": "object",
3250
- "description": "The new start token for the ProcessInstance.",
3251
- "required": false
3252
- }
3253
- }
3254
- }
3255
- }
3256
- }
3257
- },
3258
- "responses": {
3259
- "204": {
3260
- "description": "Indicates the ProcessInstance was retried successfully."
3261
- }
3262
- }
3263
- }
3264
- },
3265
- "/process_instances": {
3266
- "delete": {
3267
- "description": "Deletes the given Set of Process Instances. Multiple ProcessInstanceIds can be provided with \";\" as separator.",
3268
- "tags": ["ProcessInstances"],
3269
- "parameters": [
3270
- {
3271
- "name": "process_instance_ids",
3272
- "in": "query",
3273
- "description": "The IDs of the ProcessInstances to delete.",
3274
- "required": true,
3275
- "schema": {
3276
- "type": "string | Array<string>",
3277
- "oneOf": [
3278
- {
3279
- "type": "string",
3280
- "example": 12345678
3281
- },
3282
- {
3283
- "type": "Array<string>",
3284
- "example": [12345678, 87654321]
3285
- }
3286
- ]
3287
- }
3288
- },
3289
- {
3290
- "name": "delete_all_related_data",
3291
- "in": "query",
3292
- "description": "Flag to indicate whether all related data should be deleted as well.",
3293
- "required": false,
3294
- "schema": {
3295
- "type": "boolean",
3296
- "example": true
3297
- }
3298
- }
3299
- ],
3300
- "responses": {
3301
- "204": {
3302
- "description": "Indicates the ProcessInstances were deleted successfully."
3303
- }
3304
- }
3305
- }
3306
- },
3307
- "/notifications/long_polling/cronjob_created": {
3308
- "get": {
3309
- "description": "Wait for a CronjobCreated notification and resolves with the notification's content.",
3310
- "tags": ["Notifications"],
3311
- "responses": {
3312
- "200": {
3313
- "content": {
3314
- "application/json": {
3315
- "schema": {
3316
- "$ref": "#/components/schemas/CronjobEventMessage"
3317
- }
3318
- }
3319
- }
3320
- }
3321
- }
3322
- }
3323
- },
3324
- "/notifications/long_polling/cronjob_executed": {
3325
- "get": {
3326
- "description": "Wait for a CronjobExecuted notification and resolves with the notification's content.",
3327
- "tags": ["Notifications"],
3328
- "responses": {
3329
- "200": {
3330
- "content": {
3331
- "application/json": {
3332
- "schema": {
3333
- "$ref": "#/components/schemas/CronjobEventMessage"
3334
- }
3335
- }
3336
- }
3337
- }
3338
- }
3339
- }
3340
- },
3341
- "/notifications/long_polling/cronjob_stopped": {
3342
- "get": {
3343
- "description": "Wait for a CronjobStopped notification and resolves with the notification's content.",
3344
- "tags": ["Notifications"],
3345
- "responses": {
3346
- "200": {
3347
- "content": {
3348
- "application/json": {
3349
- "schema": {
3350
- "$ref": "#/components/schemas/CronjobEventMessage"
3351
- }
3352
- }
3353
- }
3354
- }
3355
- }
3356
- }
3357
- },
3358
- "/notifications/long_polling/cronjob_updated": {
3359
- "get": {
3360
- "description": "Wait for a CronjobUpdated notification and resolves with the notification's content.",
3361
- "tags": ["Notifications"],
3362
- "responses": {
3363
- "200": {
3364
- "content": {
3365
- "application/json": {
3366
- "schema": {
3367
- "$ref": "#/components/schemas/CronjobEventMessage"
3368
- }
3369
- }
3370
- }
3371
- }
3372
- }
3373
- }
3374
- },
3375
- "/notifications/long_polling/cronjob_removed": {
3376
- "get": {
3377
- "description": "Wait for a CronjobRemoved notification and resolves with the notification's content.",
3378
- "tags": ["Notifications"],
3379
- "responses": {
3380
- "200": {
3381
- "content": {
3382
- "application/json": {
3383
- "schema": {
3384
- "$ref": "#/components/schemas/CronjobEventMessage"
3385
- }
3386
- }
3387
- }
3388
- }
3389
- }
3390
- }
3391
- },
3392
- "/notifications/long_polling/process_deployed": {
3393
- "get": {
3394
- "description": "Wait for a ProcessDeployed notification and resolves with the notification's content.",
3395
- "tags": ["Notifications"],
3396
- "responses": {
3397
- "200": {
3398
- "content": {
3399
- "application/json": {
3400
- "schema": {
3401
- "$ref": "#/components/schemas/ProcessDeploymentMessage"
3402
- }
3403
- }
3404
- }
3405
- }
3406
- }
3407
- }
3408
- },
3409
- "/notifications/long_polling/process_is_executable_changed": {
3410
- "get": {
3411
- "description": "Wait for a ProcessIsExecutableChanged notification and resolves with the notification's content.",
3412
- "tags": ["Notifications"],
3413
- "responses": {
3414
- "200": {
3415
- "content": {
3416
- "application/json": {
3417
- "schema": {
3418
- "$ref": "#/components/schemas/ProcessIsExecutableChangedMessage"
3419
- }
3420
- }
3421
- }
3422
- }
3423
- }
3424
- }
3425
- },
3426
- "/notifications/long_polling/cronjob_enabled_changed": {
3427
- "get": {
3428
- "description": "Wait for a CronjobEnabledChanged notification and resolves with the notification's content.",
3429
- "tags": ["Notifications"],
3430
- "responses": {
3431
- "200": {
3432
- "content": {
3433
- "application/json": {
3434
- "schema": {
3435
- "$ref": "#/components/schemas/CronjobEnabledChangedMessage"
3436
- }
3437
- }
3438
- }
3439
- }
3440
- }
3441
- }
3442
- },
3443
- "/notifications/long_polling/process_undeployed": {
3444
- "get": {
3445
- "description": "Wait for a ProcessUndeployed notification and resolves with the notification's content.",
3446
- "tags": ["Notifications"],
3447
- "responses": {
3448
- "200": {
3449
- "content": {
3450
- "application/json": {
3451
- "schema": {
3452
- "$ref": "#/components/schemas/ProcessDeploymentMessage"
3453
- }
3454
- }
3455
- }
3456
- }
3457
- }
3458
- }
3459
- },
3460
- "/notifications/long_polling/process_starting": {
3461
- "get": {
3462
- "description": "Wait for a ProcessStarting notification and resolves with the notification's content.",
3463
- "tags": ["Notifications"],
3464
- "responses": {
3465
- "200": {
3466
- "content": {
3467
- "application/json": {
3468
- "schema": {
3469
- "$ref": "#/components/schemas/EventMessage"
3470
- }
3471
- }
3472
- }
3473
- }
3474
- }
3475
- }
3476
- },
3477
- "/notifications/long_polling/process_started": {
3478
- "get": {
3479
- "description": "Wait for a ProcessStarted notification and resolves with the notification's content.",
3480
- "tags": ["Notifications"],
3481
- "responses": {
3482
- "200": {
3483
- "content": {
3484
- "application/json": {
3485
- "schema": {
3486
- "$ref": "#/components/schemas/EventMessage"
3487
- }
3488
- }
3489
- }
3490
- }
3491
- }
3492
- }
3493
- },
3494
- "/notifications/long_polling/process_resumed": {
3495
- "get": {
3496
- "description": "Wait for a ProcessResumed notification and resolves with the notification's content.",
3497
- "tags": ["Notifications"],
3498
- "responses": {
3499
- "200": {
3500
- "content": {
3501
- "application/json": {
3502
- "schema": {
3503
- "$ref": "#/components/schemas/EventMessage"
3504
- }
3505
- }
3506
- }
3507
- }
3508
- }
3509
- }
3510
- },
3511
- "/notifications/long_polling/process_ended": {
3512
- "get": {
3513
- "description": "Wait for a ProcessEnded notification and resolves with the notification's content.",
3514
- "tags": ["Notifications"],
3515
- "responses": {
3516
- "200": {
3517
- "content": {
3518
- "application/json": {
3519
- "schema": {
3520
- "$ref": "#/components/schemas/EventMessage"
3521
- }
3522
- }
3523
- }
3524
- }
3525
- }
3526
- }
3527
- },
3528
- "/notifications/long_polling/process_owner_changed": {
3529
- "get": {
3530
- "description": "Wait for a ProcessOwnerChanged notification and resolves with the notification's content.",
3531
- "tags": ["Notifications"],
3532
- "responses": {
3533
- "200": {
3534
- "content": {
3535
- "application/json": {
3536
- "schema": {
3537
- "$ref": "#/components/schemas/EventMessage"
3538
- }
3539
- }
3540
- }
3541
- }
3542
- }
3543
- }
3544
- },
3545
- "/notifications/long_polling/process_terminated": {
3546
- "get": {
3547
- "description": "Wait for a ProcessTerminated notification and resolves with the notification's content.",
3548
- "tags": ["Notifications"],
3549
- "responses": {
3550
- "200": {
3551
- "content": {
3552
- "application/json": {
3553
- "schema": {
3554
- "$ref": "#/components/schemas/EventMessage"
3555
- }
3556
- }
3557
- }
3558
- }
3559
- }
3560
- }
3561
- },
3562
- "/notifications/long_polling/process_error": {
3563
- "get": {
3564
- "description": "Wait for a ProcessError notification and resolves with the notification's content.",
3565
- "tags": ["Notifications"],
3566
- "responses": {
3567
- "200": {
3568
- "content": {
3569
- "application/json": {
3570
- "schema": {
3571
- "$ref": "#/components/schemas/EventMessage"
3572
- }
3573
- }
3574
- }
3575
- }
3576
- }
3577
- }
3578
- },
3579
- "/notifications/long_polling/process_instances_deleted": {
3580
- "get": {
3581
- "description": "Wait for a ProcessInstancesDeleted notification and resolves with the notification's content.",
3582
- "tags": ["Notifications"],
3583
- "responses": {
3584
- "200": {
3585
- "content": {
3586
- "application/json": {
3587
- "schema": {
3588
- "$ref": "#/components/schemas/EventMessage"
3589
- }
3590
- }
3591
- }
3592
- }
3593
- }
3594
- }
3595
- },
3596
- "/notifications/long_polling/external_task_created": {
3597
- "get": {
3598
- "description": "Wait for an ExternalTaskCreated notification and resolves with the notification's content.",
3599
- "tags": ["Notifications"],
3600
- "responses": {
3601
- "200": {
3602
- "content": {
3603
- "application/json": {
3604
- "schema": {
3605
- "$ref": "#/components/schemas/ExternalTaskCreatedMessage"
3606
- }
3607
- }
3608
- }
3609
- }
3610
- }
3611
- }
3612
- },
3613
- "/notifications/long_polling/external_task_locked": {
3614
- "get": {
3615
- "description": "Wait for a ExternalTaskLocked notification and resolves with the notification's content.",
3616
- "tags": ["Notifications"],
3617
- "responses": {
3618
- "200": {
3619
- "content": {
3620
- "application/json": {
3621
- "schema": {
3622
- "$ref": "#/components/schemas/ExternalTaskLockedMessage"
3623
- }
3624
- }
3625
- }
3626
- }
3627
- }
3628
- }
3629
- },
3630
- "/notifications/long_polling/external_task_unlocked": {
3631
- "get": {
3632
- "description": "Wait for a ExternalTaskUnlocked notification and resolves with the notification's content.",
3633
- "tags": ["Notifications"],
3634
- "responses": {
3635
- "200": {
3636
- "content": {
3637
- "application/json": {
3638
- "schema": {
3639
- "$ref": "#/components/schemas/ExternalTaskUnlockedMessage"
3640
- }
3641
- }
3642
- }
3643
- }
3644
- }
3645
- }
3646
- },
3647
- "/notifications/long_polling/external_task_expired": {
3648
- "get": {
3649
- "description": "Wait for a ExternalTaskExpired notification and resolves with the notification's content.",
3650
- "tags": ["Notifications"],
3651
- "responses": {
3652
- "200": {
3653
- "content": {
3654
- "application/json": {
3655
- "schema": {
3656
- "$ref": "#/components/schemas/ExternalTaskExpiredMessage"
3657
- }
3658
- }
3659
- }
3660
- }
3661
- }
3662
- }
3663
- },
3664
- "/notifications/long_polling/activity_reached": {
3665
- "get": {
3666
- "description": "Wait for an ActivityReached notification and resolves with the notification's content.",
3667
- "tags": ["Notifications"],
3668
- "responses": {
3669
- "200": {
3670
- "content": {
3671
- "application/json": {
3672
- "schema": {
3673
- "$ref": "#/components/schemas/EventMessage"
3674
- }
3675
- }
3676
- }
3677
- }
3678
- }
3679
- }
3680
- },
3681
- "/notifications/long_polling/activity_finished": {
3682
- "get": {
3683
- "description": "Wait for an ActivityFinished notification and resolves with the notification's content.",
3684
- "tags": ["Notifications"],
3685
- "responses": {
3686
- "200": {
3687
- "content": {
3688
- "application/json": {
3689
- "schema": {
3690
- "$ref": "#/components/schemas/EventMessage"
3691
- }
3692
- }
3693
- }
3694
- }
3695
- }
3696
- }
3697
- },
3698
- "/notifications/long_polling/activity_canceled": {
3699
- "get": {
3700
- "description": "Wait for an ActivityCanceled notification and resolves with the notification's content.",
3701
- "tags": ["Notifications"],
3702
- "responses": {
3703
- "200": {
3704
- "content": {
3705
- "application/json": {
3706
- "schema": {
3707
- "$ref": "#/components/schemas/EventMessage"
3708
- }
3709
- }
3710
- }
3711
- }
3712
- }
3713
- }
3714
- },
3715
- "/notifications/long_polling/empty_activity_waiting": {
3716
- "get": {
3717
- "deprecated": true,
3718
- "description": "DEPRECATED - Use `GET /notifications/long_polling/untyped_task_waiting` instead.",
3719
- "tags": ["Notifications"],
3720
- "responses": {
3721
- "200": {
3722
- "content": {
3723
- "application/json": {
3724
- "schema": {
3725
- "$ref": "#/components/schemas/EventMessage"
3726
- }
3727
- }
3728
- }
3729
- }
3730
- }
3731
- }
3732
- },
3733
- "/notifications/long_polling/empty_activity_finished": {
3734
- "get": {
3735
- "deprecated": true,
3736
- "description": "DEPRECATED - Use `GET /notifications/long_polling/untyped_task_finished` instead.",
3737
- "tags": ["Notifications"],
3738
- "responses": {
3739
- "200": {
3740
- "content": {
3741
- "application/json": {
3742
- "schema": {
3743
- "$ref": "#/components/schemas/EventMessage"
3744
- }
3745
- }
3746
- }
3747
- }
3748
- }
3749
- }
3750
- },
3751
- "/notifications/long_polling/untyped_task_waiting": {
3752
- "get": {
3753
- "description": "Wait for an UntypedTaskWaiting notification and resolves with the notification's content.",
3754
- "tags": ["Notifications"],
3755
- "responses": {
3756
- "200": {
3757
- "content": {
3758
- "application/json": {
3759
- "schema": {
3760
- "$ref": "#/components/schemas/EventMessage"
3761
- }
3762
- }
3763
- }
3764
- }
3765
- }
3766
- }
3767
- },
3768
- "/notifications/long_polling/untyped_task_finished": {
3769
- "get": {
3770
- "description": "Wait for an UntypedTaskFinished notification and resolves with the notification's content.",
3771
- "tags": ["Notifications"],
3772
- "responses": {
3773
- "200": {
3774
- "content": {
3775
- "application/json": {
3776
- "schema": {
3777
- "$ref": "#/components/schemas/EventMessage"
3778
- }
3779
- }
3780
- }
3781
- }
3782
- }
3783
- }
3784
- },
3785
- "/notifications/long_polling/manual_task_waiting": {
3786
- "get": {
3787
- "description": "Wait for a ManualTaskWaiting notification and resolves with the notification's content.",
3788
- "tags": ["Notifications"],
3789
- "responses": {
3790
- "200": {
3791
- "content": {
3792
- "application/json": {
3793
- "schema": {
3794
- "$ref": "#/components/schemas/EventMessage"
3795
- }
3796
- }
3797
- }
3798
- }
3799
- }
3800
- }
3801
- },
3802
- "/notifications/long_polling/manual_task_finished": {
3803
- "get": {
3804
- "description": "Wait for a ManualTaskFinied notification and resolves with the notification's content.",
3805
- "tags": ["Notifications"],
3806
- "responses": {
3807
- "200": {
3808
- "content": {
3809
- "application/json": {
3810
- "schema": {
3811
- "$ref": "#/components/schemas/EventMessage"
3812
- }
3813
- }
3814
- }
3815
- }
3816
- }
3817
- }
3818
- },
3819
- "/notifications/long_polling/user_task_waiting": {
3820
- "get": {
3821
- "description": "Wait for a UserTaskWaiting notification and resolves with the notification's content.",
3822
- "tags": ["Notifications"],
3823
- "responses": {
3824
- "200": {
3825
- "content": {
3826
- "application/json": {
3827
- "schema": {
3828
- "$ref": "#/components/schemas/EventMessage"
3829
- }
3830
- }
3831
- }
3832
- }
3833
- }
3834
- }
3835
- },
3836
- "/notifications/long_polling/user_task_finished": {
3837
- "get": {
3838
- "description": "Wait for a UserTaskFinished notification and resolves with the notification's content.",
3839
- "tags": ["Notifications"],
3840
- "responses": {
3841
- "200": {
3842
- "content": {
3843
- "application/json": {
3844
- "schema": {
3845
- "$ref": "#/components/schemas/EventMessage"
3846
- }
3847
- }
3848
- }
3849
- }
3850
- }
3851
- }
3852
- },
3853
- "/notifications/long_polling/user_task_reserved": {
3854
- "get": {
3855
- "description": "Wait for a UserTaskReserved notification and resolves with the notification's content.",
3856
- "tags": ["Notifications"],
3857
- "responses": {
3858
- "200": {
3859
- "content": {
3860
- "application/json": {
3861
- "schema": {
3862
- "$ref": "#/components/schemas/EventMessage"
3863
- }
3864
- }
3865
- }
3866
- }
3867
- }
3868
- }
3869
- },
3870
- "/notifications/long_polling/user_task_reservation_canceled": {
3871
- "get": {
3872
- "description": "Wait for a UserTaskReservationCanceled notification and resolves with the notification's content.",
3873
- "tags": ["Notifications"],
3874
- "responses": {
3875
- "200": {
3876
- "content": {
3877
- "application/json": {
3878
- "schema": {
3879
- "$ref": "#/components/schemas/EventMessage"
3880
- }
3881
- }
3882
- }
3883
- }
3884
- }
3885
- }
3886
- },
3887
- "/notifications/long_polling/boundary_event_waiting": {
3888
- "get": {
3889
- "description": "Wait for a BoundaryEventWaiting notification and resolves with the notification's content.",
3890
- "tags": ["Notifications"],
3891
- "responses": {
3892
- "200": {
3893
- "content": {
3894
- "application/json": {
3895
- "schema": {
3896
- "$ref": "#/components/schemas/EventMessage"
3897
- }
3898
- }
3899
- }
3900
- }
3901
- }
3902
- }
3903
- },
3904
- "/notifications/long_polling/boundary_event_triggered": {
3905
- "get": {
3906
- "description": "Wait for a BoundaryEventTriggered notification and resolves with the notification's content.",
3907
- "tags": ["Notifications"],
3908
- "responses": {
3909
- "200": {
3910
- "content": {
3911
- "application/json": {
3912
- "schema": {
3913
- "$ref": "#/components/schemas/EventMessage"
3914
- }
3915
- }
3916
- }
3917
- }
3918
- }
3919
- }
3920
- },
3921
- "/notifications/long_polling/boundary_event_finished": {
3922
- "get": {
3923
- "description": "Wait for a BoundaryEventFinished notification and resolves with the notification's content.",
3924
- "tags": ["Notifications"],
3925
- "responses": {
3926
- "200": {
3927
- "content": {
3928
- "application/json": {
3929
- "schema": {
3930
- "$ref": "#/components/schemas/EventMessage"
3931
- }
3932
- }
3933
- }
3934
- }
3935
- }
3936
- }
3937
- },
3938
- "/notifications/long_polling/intermediate_throw_event_triggered": {
3939
- "get": {
3940
- "description": "Wait for an IntermediateThrowEventTriggered notification and resolves with the notification's content.",
3941
- "tags": ["Notifications"],
3942
- "responses": {
3943
- "200": {
3944
- "content": {
3945
- "application/json": {
3946
- "schema": {
3947
- "$ref": "#/components/schemas/EventMessage"
3948
- }
3949
- }
3950
- }
3951
- }
3952
- }
3953
- }
3954
- },
3955
- "/notifications/long_polling/intermediate_catch_event_reached": {
3956
- "get": {
3957
- "description": "Wait for an IntermediateCatchEventReached notification and resolves with the notification's content.",
3958
- "tags": ["Notifications"],
3959
- "responses": {
3960
- "200": {
3961
- "content": {
3962
- "application/json": {
3963
- "schema": {
3964
- "$ref": "#/components/schemas/EventMessage"
3965
- }
3966
- }
3967
- }
3968
- }
3969
- }
3970
- }
3971
- },
3972
- "/notifications/long_polling/intermediate_catch_event_finished": {
3973
- "get": {
3974
- "description": "Wait for a IntermediateCatchEventFinished notification and resolves with the notification's content.",
3975
- "tags": ["Notifications"],
3976
- "responses": {
3977
- "200": {
3978
- "content": {
3979
- "application/json": {
3980
- "schema": {
3981
- "$ref": "#/components/schemas/EventMessage"
3982
- }
3983
- }
3984
- }
3985
- }
3986
- }
3987
- }
3988
- },
3989
- "/notifications/long_polling/flow_node_event_retry_sending": {
3990
- "get": {
3991
- "description": "Wait for a FlowNodeEventRetrySending notification and resolves with the notification's content.",
3992
- "tags": ["Notifications"],
3993
- "responses": {
3994
- "200": {
3995
- "content": {
3996
- "application/json": {
3997
- "schema": {
3998
- "$ref": "#/components/schemas/EventMessage"
3999
- }
4000
- }
4001
- }
4002
- }
4003
- }
4004
- }
4005
- },
4006
- "/notifications/long_polling/message_triggered": {
4007
- "get": {
4008
- "description": "Wait for an MessageTriggered notification and resolves with the notification's content.",
4009
- "tags": ["Notifications"],
4010
- "responses": {
4011
- "200": {
4012
- "content": {
4013
- "application/json": {
4014
- "schema": {
4015
- "$ref": "#/components/schemas/EventMessage"
4016
- }
4017
- }
4018
- }
4019
- }
4020
- }
4021
- }
4022
- },
4023
- "/notifications/long_polling/signal_triggered": {
4024
- "get": {
4025
- "description": "Wait for an SignalTriggered notification and resolves with the notification's content.",
4026
- "tags": ["Notifications"],
4027
- "responses": {
4028
- "200": {
4029
- "content": {
4030
- "application/json": {
4031
- "schema": {
4032
- "$ref": "#/components/schemas/EventMessage"
4033
- }
4034
- }
4035
- }
4036
- }
4037
- }
4038
- }
4039
- },
4040
- "/notifications/long_polling/end_event_finished": {
4041
- "get": {
4042
- "description": "Wait for an EndEventFinished notification and resolves with the notification's content.",
4043
- "tags": ["Notifications"],
4044
- "responses": {
4045
- "200": {
4046
- "content": {
4047
- "application/json": {
4048
- "schema": {
4049
- "$ref": "#/components/schemas/EventMessage"
4050
- }
4051
- }
4052
- }
4053
- }
4054
- }
4055
- }
4056
- },
4057
- "/notifications/long_polling/start_event_finished": {
4058
- "get": {
4059
- "description": "Wait for an StartEventFinished notification and resolves with the notification's content.",
4060
- "tags": ["Notifications"],
4061
- "responses": {
4062
- "200": {
4063
- "content": {
4064
- "application/json": {
4065
- "schema": {
4066
- "$ref": "#/components/schemas/EventMessage"
4067
- }
4068
- }
4069
- }
4070
- }
4071
- }
4072
- }
4073
- },
4074
- "/notifications/long_polling/process_instance_metadata_changed": {
4075
- "get": {
4076
- "description": "Wait for a ProcessInstanceMetadataChanged notification and resolves with the notification's content.",
4077
- "tags": ["Notifications"],
4078
- "responses": {
4079
- "200": {
4080
- "content": {
4081
- "application/json": {
4082
- "schema": {
4083
- "$ref": "#/components/schemas/MetadataChangedMessage"
4084
- }
4085
- }
4086
- }
4087
- }
4088
- }
4089
- }
4090
- },
4091
- "/notifications/long_polling/correlation_metadata_changed": {
4092
- "get": {
4093
- "description": "Wait for a CorrelationMetadataChanged notification and resolves with the notification's content.",
4094
- "tags": ["Notifications"],
4095
- "responses": {
4096
- "200": {
4097
- "content": {
4098
- "application/json": {
4099
- "schema": {
4100
- "$ref": "#/components/schemas/MetadataChangedMessage"
4101
- }
4102
- }
4103
- }
4104
- }
4105
- }
4106
- }
4107
- }
4108
- },
4109
- "tags": []
4110
- }