@planqk/planqk-api-sdk 1.3.6 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.fossa.yml +1 -0
- package/.gitlab-ci.yml +21 -14
- package/.releaserc.json +2 -1
- package/dist/sdk/Client.d.ts +8 -0
- package/dist/sdk/Client.js +12 -2
- package/dist/sdk/api/resources/dataPools/client/Client.d.ts +4 -1
- package/dist/sdk/api/resources/dataPools/client/Client.js +57 -39
- package/dist/sdk/api/resources/dataPools/client/requests/AddDataPoolFileRequest.d.ts +1 -1
- package/dist/sdk/api/resources/dataPools/client/requests/CreateDataPoolRequest.d.ts +1 -0
- package/dist/sdk/api/resources/dataPools/client/requests/UpdateDataPoolRequest.d.ts +3 -0
- package/dist/sdk/api/resources/index.d.ts +3 -0
- package/dist/sdk/api/resources/index.js +4 -1
- package/dist/sdk/api/resources/serviceExecutions/client/Client.d.ts +90 -0
- package/dist/sdk/api/resources/serviceExecutions/client/Client.js +271 -0
- package/dist/sdk/api/resources/serviceExecutions/client/index.d.ts +1 -0
- package/dist/sdk/api/resources/serviceExecutions/index.d.ts +1 -0
- package/dist/sdk/api/resources/serviceExecutions/index.js +17 -0
- package/dist/sdk/api/resources/serviceJobs/client/Client.d.ts +138 -0
- package/dist/sdk/api/resources/serviceJobs/client/Client.js +489 -0
- package/dist/sdk/api/resources/serviceJobs/client/index.d.ts +2 -0
- package/dist/sdk/api/resources/serviceJobs/client/index.js +17 -0
- package/dist/sdk/api/resources/serviceJobs/client/requests/CreateServiceJobRequest.d.ts +15 -0
- package/dist/sdk/api/resources/serviceJobs/client/requests/CreateServiceJobRequest.js +5 -0
- package/dist/sdk/api/resources/serviceJobs/client/requests/index.d.ts +1 -0
- package/dist/sdk/api/resources/serviceJobs/client/requests/index.js +2 -0
- package/dist/sdk/api/resources/serviceJobs/index.d.ts +1 -0
- package/dist/sdk/api/resources/serviceJobs/index.js +17 -0
- package/dist/sdk/api/types/ActivityInstance.d.ts +20 -0
- package/dist/sdk/api/types/ActivityInstance.js +14 -0
- package/dist/sdk/api/types/DataPoolDto.d.ts +5 -0
- package/dist/sdk/api/types/DataPoolFileDto.d.ts +7 -0
- package/dist/sdk/api/types/LogEntry.d.ts +24 -0
- package/dist/sdk/api/types/LogEntry.js +16 -0
- package/dist/sdk/api/types/MetricDataPoint.d.ts +12 -0
- package/dist/sdk/api/types/MetricDataPoint.js +5 -0
- package/dist/sdk/api/types/ServiceExecutionDto.d.ts +21 -0
- package/dist/sdk/api/types/ServiceExecutionDto.js +17 -0
- package/dist/sdk/api/types/ServiceExecutionLogs.d.ts +5 -0
- package/dist/sdk/api/types/ServiceExecutionLogs.js +5 -0
- package/dist/sdk/api/types/ServiceExecutionMetrics.d.ts +23 -0
- package/dist/sdk/api/types/ServiceExecutionMetrics.js +5 -0
- package/dist/sdk/api/types/ServiceJobDto.d.ts +46 -0
- package/dist/sdk/api/types/ServiceJobDto.js +22 -0
- package/dist/sdk/api/types/VariableInstance.d.ts +9 -0
- package/dist/sdk/api/types/VariableInstance.js +5 -0
- package/dist/sdk/api/types/WorkflowInstance.d.ts +23 -0
- package/dist/sdk/api/types/WorkflowInstance.js +17 -0
- package/dist/sdk/api/types/WorkflowServiceExecutionDto.d.ts +8 -0
- package/dist/sdk/api/types/WorkflowServiceExecutionDto.js +5 -0
- package/dist/sdk/api/types/index.d.ts +10 -0
- package/dist/sdk/api/types/index.js +10 -0
- package/dist/sdk/core/exports.d.ts +1 -0
- package/dist/sdk/core/exports.js +17 -0
- package/dist/sdk/core/fetcher/Fetcher.d.ts +1 -1
- package/dist/sdk/core/fetcher/Fetcher.js +2 -2
- package/dist/sdk/core/fetcher/index.d.ts +5 -5
- package/dist/sdk/core/fetcher/index.js +5 -5
- package/dist/sdk/core/file/exports.d.ts +1 -0
- package/dist/sdk/core/file/exports.js +2 -0
- package/dist/sdk/core/file/file.d.ts +5 -0
- package/dist/sdk/core/file/file.js +185 -0
- package/dist/sdk/core/file/index.d.ts +2 -0
- package/dist/sdk/core/file/index.js +18 -0
- package/dist/sdk/core/file/types.d.ts +66 -0
- package/dist/sdk/core/file/types.js +2 -0
- package/dist/sdk/core/form-data-utils/FormDataWrapper.js +12 -3
- package/dist/sdk/core/index.d.ts +1 -1
- package/dist/sdk/core/index.js +2 -2
- package/dist/sdk/core/url/join.js +23 -3
- package/dist/sdk/exports.d.ts +1 -0
- package/dist/sdk/exports.js +17 -0
- package/dist/sdk/index.d.ts +1 -0
- package/dist/sdk/index.js +4 -0
- package/fern/fern.config.json +1 -1
- package/fern/generators.yml +9 -3
- package/fern/openapi/openapi.json +950 -54
- package/package.json +1 -1
- package/planqk/api/_version.py +1 -1
- package/pyproject.toml +1 -1
- package/requirements.txt +319 -0
- package/scripts/update-version.sh +2 -0
- package/src/index.test.ts +11 -0
- package/src/sdk/Client.ts +14 -0
- package/src/sdk/api/resources/dataPools/client/Client.ts +95 -75
- package/src/sdk/api/resources/dataPools/client/requests/AddDataPoolFileRequest.ts +1 -1
- package/src/sdk/api/resources/dataPools/client/requests/CreateDataPoolRequest.ts +1 -0
- package/src/sdk/api/resources/dataPools/client/requests/UpdateDataPoolRequest.ts +3 -0
- package/src/sdk/api/resources/index.ts +3 -0
- package/src/sdk/api/resources/serviceExecutions/client/Client.ts +323 -0
- package/src/sdk/api/resources/serviceExecutions/client/index.ts +1 -0
- package/src/sdk/api/resources/serviceExecutions/index.ts +1 -0
- package/src/sdk/api/resources/serviceJobs/client/Client.ts +581 -0
- package/src/sdk/api/resources/serviceJobs/client/index.ts +2 -0
- package/src/sdk/api/resources/serviceJobs/client/requests/CreateServiceJobRequest.ts +16 -0
- package/src/sdk/api/resources/serviceJobs/client/requests/index.ts +1 -0
- package/src/sdk/api/resources/serviceJobs/index.ts +1 -0
- package/src/sdk/api/types/ActivityInstance.ts +22 -0
- package/src/sdk/api/types/DataPoolDto.ts +5 -0
- package/src/sdk/api/types/DataPoolFileDto.ts +7 -0
- package/src/sdk/api/types/LogEntry.ts +26 -0
- package/src/sdk/api/types/MetricDataPoint.ts +13 -0
- package/src/sdk/api/types/ServiceExecutionDto.ts +23 -0
- package/src/sdk/api/types/ServiceExecutionLogs.ts +7 -0
- package/src/sdk/api/types/ServiceExecutionMetrics.ts +25 -0
- package/src/sdk/api/types/ServiceJobDto.ts +48 -0
- package/src/sdk/api/types/VariableInstance.ts +10 -0
- package/src/sdk/api/types/WorkflowInstance.ts +26 -0
- package/src/sdk/api/types/WorkflowServiceExecutionDto.ts +10 -0
- package/src/sdk/api/types/index.ts +10 -0
- package/src/sdk/core/exports.ts +1 -0
- package/src/sdk/core/fetcher/Fetcher.ts +3 -3
- package/src/sdk/core/fetcher/index.ts +5 -5
- package/src/sdk/core/file/exports.ts +1 -0
- package/src/sdk/core/file/file.ts +186 -0
- package/src/sdk/core/file/index.ts +2 -0
- package/src/sdk/core/file/types.ts +81 -0
- package/src/sdk/core/form-data-utils/FormDataWrapper.ts +12 -3
- package/src/sdk/core/index.ts +1 -1
- package/src/sdk/core/url/join.ts +28 -3
- package/src/sdk/exports.ts +1 -0
- package/src/sdk/index.ts +1 -0
- package/uv.lock +245 -228
- package/dist/sdk/core/file.d.ts +0 -1
- package/planqk/__init__.py +0 -0
- package/src/sdk/core/file.ts +0 -11
- /package/dist/sdk/{core/file.js → api/resources/serviceExecutions/client/index.js} +0 -0
|
@@ -13,16 +13,77 @@
|
|
|
13
13
|
"servers": [
|
|
14
14
|
{
|
|
15
15
|
"url": "https://platform.planqk.de/qc-catalog",
|
|
16
|
-
"description": "
|
|
16
|
+
"description": "Platform API URL"
|
|
17
17
|
}
|
|
18
18
|
],
|
|
19
19
|
"tags": [
|
|
20
|
+
{
|
|
21
|
+
"name": "Service Jobs",
|
|
22
|
+
"description": "Run your created services in a job-based manner. Service jobs allow you to execute services with specific parameters and track their execution status, costs, logs, metrics, and results."
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "Service Executions",
|
|
26
|
+
"description": "Track status, costs, logs, metrics, and results of your service executions."
|
|
27
|
+
},
|
|
20
28
|
{
|
|
21
29
|
"name": "Data Pools",
|
|
22
30
|
"description": "Manage data pools, which are organized collections of files that serve as reusable data sources for services."
|
|
23
31
|
}
|
|
24
32
|
],
|
|
25
33
|
"paths": {
|
|
34
|
+
"/service-jobs/{id}/cancel": {
|
|
35
|
+
"put": {
|
|
36
|
+
"tags": [
|
|
37
|
+
"Service Jobs"
|
|
38
|
+
],
|
|
39
|
+
"description": "Cancel a specific service job (identified by its ID). Only service jobs that are pending or currently running can be cancelled.",
|
|
40
|
+
"operationId": "cancelServiceJob",
|
|
41
|
+
"parameters": [
|
|
42
|
+
{
|
|
43
|
+
"name": "id",
|
|
44
|
+
"in": "path",
|
|
45
|
+
"required": true,
|
|
46
|
+
"schema": {
|
|
47
|
+
"type": "string",
|
|
48
|
+
"format": "uuid"
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"name": "X-OrganizationId",
|
|
53
|
+
"in": "header",
|
|
54
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
55
|
+
"schema": {
|
|
56
|
+
"type": "string"
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
],
|
|
60
|
+
"responses": {
|
|
61
|
+
"201": {
|
|
62
|
+
"description": "Service job is cancelled"
|
|
63
|
+
},
|
|
64
|
+
"401": {
|
|
65
|
+
"description": "Unauthorized"
|
|
66
|
+
},
|
|
67
|
+
"403": {
|
|
68
|
+
"description": "Forbidden"
|
|
69
|
+
},
|
|
70
|
+
"404": {
|
|
71
|
+
"description": "Not Found"
|
|
72
|
+
},
|
|
73
|
+
"500": {
|
|
74
|
+
"description": "Internal Server Error"
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
"security": [
|
|
78
|
+
{
|
|
79
|
+
"oauth2": []
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"apiKey": []
|
|
83
|
+
}
|
|
84
|
+
]
|
|
85
|
+
}
|
|
86
|
+
},
|
|
26
87
|
"/datapools/{id}": {
|
|
27
88
|
"get": {
|
|
28
89
|
"tags": [
|
|
@@ -205,12 +266,128 @@
|
|
|
205
266
|
]
|
|
206
267
|
}
|
|
207
268
|
},
|
|
269
|
+
"/service-jobs": {
|
|
270
|
+
"get": {
|
|
271
|
+
"tags": [
|
|
272
|
+
"Service Jobs"
|
|
273
|
+
],
|
|
274
|
+
"description": "Get a list of all service jobs for the current user or organization.",
|
|
275
|
+
"operationId": "getServiceJobs",
|
|
276
|
+
"parameters": [
|
|
277
|
+
{
|
|
278
|
+
"name": "X-OrganizationId",
|
|
279
|
+
"in": "header",
|
|
280
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
281
|
+
"schema": {
|
|
282
|
+
"type": "string"
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
],
|
|
286
|
+
"responses": {
|
|
287
|
+
"200": {
|
|
288
|
+
"description": "List of service jobs",
|
|
289
|
+
"content": {
|
|
290
|
+
"application/json": {
|
|
291
|
+
"schema": {
|
|
292
|
+
"type": "array",
|
|
293
|
+
"items": {
|
|
294
|
+
"$ref": "#/components/schemas/ServiceJobDto"
|
|
295
|
+
}
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
},
|
|
300
|
+
"401": {
|
|
301
|
+
"description": "Unauthorized"
|
|
302
|
+
},
|
|
303
|
+
"403": {
|
|
304
|
+
"description": "Forbidden"
|
|
305
|
+
},
|
|
306
|
+
"404": {
|
|
307
|
+
"description": "Not Found"
|
|
308
|
+
},
|
|
309
|
+
"500": {
|
|
310
|
+
"description": "Internal Server Error"
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
"security": [
|
|
314
|
+
{
|
|
315
|
+
"oauth2": []
|
|
316
|
+
},
|
|
317
|
+
{
|
|
318
|
+
"apiKey": []
|
|
319
|
+
}
|
|
320
|
+
]
|
|
321
|
+
},
|
|
322
|
+
"post": {
|
|
323
|
+
"tags": [
|
|
324
|
+
"Service Jobs"
|
|
325
|
+
],
|
|
326
|
+
"description": "Create and start a new service job.",
|
|
327
|
+
"operationId": "createServiceJob",
|
|
328
|
+
"parameters": [
|
|
329
|
+
{
|
|
330
|
+
"name": "X-OrganizationId",
|
|
331
|
+
"in": "header",
|
|
332
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
333
|
+
"schema": {
|
|
334
|
+
"type": "string"
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
],
|
|
338
|
+
"requestBody": {
|
|
339
|
+
"content": {
|
|
340
|
+
"application/json": {
|
|
341
|
+
"schema": {
|
|
342
|
+
"$ref": "#/components/schemas/CreateServiceJobRequest"
|
|
343
|
+
}
|
|
344
|
+
}
|
|
345
|
+
},
|
|
346
|
+
"required": true
|
|
347
|
+
},
|
|
348
|
+
"responses": {
|
|
349
|
+
"201": {
|
|
350
|
+
"description": "Service job is created and scheduled to start",
|
|
351
|
+
"content": {
|
|
352
|
+
"application/json": {
|
|
353
|
+
"schema": {
|
|
354
|
+
"$ref": "#/components/schemas/ServiceJobDto"
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
},
|
|
359
|
+
"400": {
|
|
360
|
+
"description": "Bad Request"
|
|
361
|
+
},
|
|
362
|
+
"401": {
|
|
363
|
+
"description": "Unauthorized"
|
|
364
|
+
},
|
|
365
|
+
"403": {
|
|
366
|
+
"description": "Forbidden"
|
|
367
|
+
},
|
|
368
|
+
"404": {
|
|
369
|
+
"description": "Not Found"
|
|
370
|
+
},
|
|
371
|
+
"500": {
|
|
372
|
+
"description": "Internal Server Error"
|
|
373
|
+
}
|
|
374
|
+
},
|
|
375
|
+
"security": [
|
|
376
|
+
{
|
|
377
|
+
"oauth2": []
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"apiKey": []
|
|
381
|
+
}
|
|
382
|
+
]
|
|
383
|
+
}
|
|
384
|
+
},
|
|
208
385
|
"/datapools": {
|
|
209
386
|
"get": {
|
|
210
387
|
"tags": [
|
|
211
388
|
"Data Pools"
|
|
212
389
|
],
|
|
213
|
-
"description": "Get a list of all data pools for the current user.",
|
|
390
|
+
"description": "Get a list of all data pools for the current user or organization.",
|
|
214
391
|
"operationId": "getDataPools",
|
|
215
392
|
"parameters": [
|
|
216
393
|
{
|
|
@@ -471,13 +648,13 @@
|
|
|
471
648
|
]
|
|
472
649
|
}
|
|
473
650
|
},
|
|
474
|
-
"/
|
|
651
|
+
"/service-executions/v1/{id}": {
|
|
475
652
|
"get": {
|
|
476
653
|
"tags": [
|
|
477
|
-
"
|
|
654
|
+
"Service Executions"
|
|
478
655
|
],
|
|
479
|
-
"description": "Get
|
|
480
|
-
"operationId": "
|
|
656
|
+
"description": "Get a specific service execution (identified by its ID).",
|
|
657
|
+
"operationId": "getServiceExecution",
|
|
481
658
|
"parameters": [
|
|
482
659
|
{
|
|
483
660
|
"name": "id",
|
|
@@ -488,15 +665,6 @@
|
|
|
488
665
|
"format": "uuid"
|
|
489
666
|
}
|
|
490
667
|
},
|
|
491
|
-
{
|
|
492
|
-
"name": "fileId",
|
|
493
|
-
"in": "path",
|
|
494
|
-
"required": true,
|
|
495
|
-
"schema": {
|
|
496
|
-
"type": "string",
|
|
497
|
-
"format": "uuid"
|
|
498
|
-
}
|
|
499
|
-
},
|
|
500
668
|
{
|
|
501
669
|
"name": "X-OrganizationId",
|
|
502
670
|
"in": "header",
|
|
@@ -508,19 +676,23 @@
|
|
|
508
676
|
],
|
|
509
677
|
"responses": {
|
|
510
678
|
"200": {
|
|
511
|
-
"description": "
|
|
679
|
+
"description": "A service execution, either a managed or workflow service execution",
|
|
512
680
|
"content": {
|
|
513
|
-
"application/
|
|
681
|
+
"application/json": {
|
|
514
682
|
"schema": {
|
|
515
683
|
"type": "string",
|
|
516
|
-
"
|
|
684
|
+
"oneOf": [
|
|
685
|
+
{
|
|
686
|
+
"$ref": "#/components/schemas/ServiceExecutionDto"
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"$ref": "#/components/schemas/WorkflowServiceExecutionDto"
|
|
690
|
+
}
|
|
691
|
+
]
|
|
517
692
|
}
|
|
518
693
|
}
|
|
519
694
|
}
|
|
520
695
|
},
|
|
521
|
-
"304": {
|
|
522
|
-
"description": "Not Modified"
|
|
523
|
-
},
|
|
524
696
|
"401": {
|
|
525
697
|
"description": "Unauthorized"
|
|
526
698
|
},
|
|
@@ -543,12 +715,12 @@
|
|
|
543
715
|
}
|
|
544
716
|
]
|
|
545
717
|
},
|
|
546
|
-
"
|
|
718
|
+
"head": {
|
|
547
719
|
"tags": [
|
|
548
|
-
"
|
|
720
|
+
"Service Executions"
|
|
549
721
|
],
|
|
550
|
-
"description": "
|
|
551
|
-
"operationId": "
|
|
722
|
+
"description": "Check if the tenant has view permission for a specific service execution (identified by its ID).",
|
|
723
|
+
"operationId": "headServiceExecution",
|
|
552
724
|
"parameters": [
|
|
553
725
|
{
|
|
554
726
|
"name": "id",
|
|
@@ -560,7 +732,51 @@
|
|
|
560
732
|
}
|
|
561
733
|
},
|
|
562
734
|
{
|
|
563
|
-
"name": "
|
|
735
|
+
"name": "X-OrganizationId",
|
|
736
|
+
"in": "header",
|
|
737
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
738
|
+
"schema": {
|
|
739
|
+
"type": "string"
|
|
740
|
+
}
|
|
741
|
+
}
|
|
742
|
+
],
|
|
743
|
+
"responses": {
|
|
744
|
+
"200": {
|
|
745
|
+
"description": "View permission for the service execution"
|
|
746
|
+
},
|
|
747
|
+
"401": {
|
|
748
|
+
"description": "Unauthorized"
|
|
749
|
+
},
|
|
750
|
+
"403": {
|
|
751
|
+
"description": "Forbidden"
|
|
752
|
+
},
|
|
753
|
+
"404": {
|
|
754
|
+
"description": "Not Found"
|
|
755
|
+
},
|
|
756
|
+
"500": {
|
|
757
|
+
"description": "Internal Server Error"
|
|
758
|
+
}
|
|
759
|
+
},
|
|
760
|
+
"security": [
|
|
761
|
+
{
|
|
762
|
+
"oauth2": []
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
"apiKey": []
|
|
766
|
+
}
|
|
767
|
+
]
|
|
768
|
+
}
|
|
769
|
+
},
|
|
770
|
+
"/service-jobs/{id}": {
|
|
771
|
+
"get": {
|
|
772
|
+
"tags": [
|
|
773
|
+
"Service Jobs"
|
|
774
|
+
],
|
|
775
|
+
"description": "Get a specific service job (identified by its ID).",
|
|
776
|
+
"operationId": "getServiceJob",
|
|
777
|
+
"parameters": [
|
|
778
|
+
{
|
|
779
|
+
"name": "id",
|
|
564
780
|
"in": "path",
|
|
565
781
|
"required": true,
|
|
566
782
|
"schema": {
|
|
@@ -578,8 +794,15 @@
|
|
|
578
794
|
}
|
|
579
795
|
],
|
|
580
796
|
"responses": {
|
|
581
|
-
"
|
|
582
|
-
"description": "
|
|
797
|
+
"200": {
|
|
798
|
+
"description": "A service job",
|
|
799
|
+
"content": {
|
|
800
|
+
"application/json": {
|
|
801
|
+
"schema": {
|
|
802
|
+
"$ref": "#/components/schemas/ServiceJobDto"
|
|
803
|
+
}
|
|
804
|
+
}
|
|
805
|
+
}
|
|
583
806
|
},
|
|
584
807
|
"401": {
|
|
585
808
|
"description": "Unauthorized"
|
|
@@ -603,21 +826,347 @@
|
|
|
603
826
|
}
|
|
604
827
|
]
|
|
605
828
|
}
|
|
606
|
-
}
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
"
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
"
|
|
829
|
+
},
|
|
830
|
+
"/service-jobs/{id}/results": {
|
|
831
|
+
"get": {
|
|
832
|
+
"tags": [
|
|
833
|
+
"Service Jobs"
|
|
834
|
+
],
|
|
835
|
+
"description": "Get the results for a specific service job (identified by its ID). If the service job has not completed yet or no results are available, a HTTP 204 (No Content) response is returned with a Retry-After header.",
|
|
836
|
+
"operationId": "getServiceJobResults",
|
|
837
|
+
"parameters": [
|
|
838
|
+
{
|
|
839
|
+
"name": "id",
|
|
840
|
+
"in": "path",
|
|
841
|
+
"required": true,
|
|
842
|
+
"schema": {
|
|
843
|
+
"type": "string",
|
|
844
|
+
"format": "uuid"
|
|
845
|
+
}
|
|
618
846
|
},
|
|
619
|
-
|
|
620
|
-
"
|
|
847
|
+
{
|
|
848
|
+
"name": "X-OrganizationId",
|
|
849
|
+
"in": "header",
|
|
850
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
851
|
+
"schema": {
|
|
852
|
+
"type": "string"
|
|
853
|
+
}
|
|
854
|
+
}
|
|
855
|
+
],
|
|
856
|
+
"responses": {
|
|
857
|
+
"200": {
|
|
858
|
+
"description": "Result for the service job",
|
|
859
|
+
"content": {
|
|
860
|
+
"application/json": {
|
|
861
|
+
"schema": {
|
|
862
|
+
"type": "object"
|
|
863
|
+
}
|
|
864
|
+
}
|
|
865
|
+
}
|
|
866
|
+
},
|
|
867
|
+
"204": {
|
|
868
|
+
"description": "No result available yet, retry later"
|
|
869
|
+
},
|
|
870
|
+
"401": {
|
|
871
|
+
"description": "Unauthorized"
|
|
872
|
+
},
|
|
873
|
+
"403": {
|
|
874
|
+
"description": "Forbidden"
|
|
875
|
+
},
|
|
876
|
+
"404": {
|
|
877
|
+
"description": "Not Found"
|
|
878
|
+
},
|
|
879
|
+
"500": {
|
|
880
|
+
"description": "Internal Server Error"
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
"security": [
|
|
884
|
+
{
|
|
885
|
+
"oauth2": []
|
|
886
|
+
},
|
|
887
|
+
{
|
|
888
|
+
"apiKey": []
|
|
889
|
+
}
|
|
890
|
+
]
|
|
891
|
+
}
|
|
892
|
+
},
|
|
893
|
+
"/service-jobs/{id}/logs": {
|
|
894
|
+
"get": {
|
|
895
|
+
"tags": [
|
|
896
|
+
"Service Jobs"
|
|
897
|
+
],
|
|
898
|
+
"description": "Get the logs for a specific service job (identified by its ID). If the service job has not started yet or no logs are available, a HTTP 204 (No Content) response is returned with a Retry-After header.",
|
|
899
|
+
"operationId": "getServiceJobLogs",
|
|
900
|
+
"parameters": [
|
|
901
|
+
{
|
|
902
|
+
"name": "id",
|
|
903
|
+
"in": "path",
|
|
904
|
+
"required": true,
|
|
905
|
+
"schema": {
|
|
906
|
+
"type": "string",
|
|
907
|
+
"format": "uuid"
|
|
908
|
+
}
|
|
909
|
+
},
|
|
910
|
+
{
|
|
911
|
+
"name": "X-OrganizationId",
|
|
912
|
+
"in": "header",
|
|
913
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
914
|
+
"schema": {
|
|
915
|
+
"type": "string"
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
],
|
|
919
|
+
"responses": {
|
|
920
|
+
"200": {
|
|
921
|
+
"description": "All logs for the service job",
|
|
922
|
+
"content": {
|
|
923
|
+
"application/json": {
|
|
924
|
+
"schema": {
|
|
925
|
+
"$ref": "#/components/schemas/ServiceExecutionLogs"
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
}
|
|
929
|
+
},
|
|
930
|
+
"204": {
|
|
931
|
+
"description": "No logs available yet, retry later"
|
|
932
|
+
},
|
|
933
|
+
"401": {
|
|
934
|
+
"description": "Unauthorized"
|
|
935
|
+
},
|
|
936
|
+
"403": {
|
|
937
|
+
"description": "Forbidden"
|
|
938
|
+
},
|
|
939
|
+
"404": {
|
|
940
|
+
"description": "Not Found"
|
|
941
|
+
},
|
|
942
|
+
"500": {
|
|
943
|
+
"description": "Internal Server Error"
|
|
944
|
+
}
|
|
945
|
+
},
|
|
946
|
+
"security": [
|
|
947
|
+
{
|
|
948
|
+
"oauth2": []
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"apiKey": []
|
|
952
|
+
}
|
|
953
|
+
]
|
|
954
|
+
}
|
|
955
|
+
},
|
|
956
|
+
"/service-executions/v1/{id}/metrics": {
|
|
957
|
+
"get": {
|
|
958
|
+
"tags": [
|
|
959
|
+
"Service Executions"
|
|
960
|
+
],
|
|
961
|
+
"description": "Get resource usage metrics for a specific service execution (identified by its ID).",
|
|
962
|
+
"operationId": "getServiceExecutionMetrics",
|
|
963
|
+
"parameters": [
|
|
964
|
+
{
|
|
965
|
+
"name": "id",
|
|
966
|
+
"in": "path",
|
|
967
|
+
"required": true,
|
|
968
|
+
"schema": {
|
|
969
|
+
"type": "string",
|
|
970
|
+
"format": "uuid"
|
|
971
|
+
}
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"name": "X-OrganizationId",
|
|
975
|
+
"in": "header",
|
|
976
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
977
|
+
"schema": {
|
|
978
|
+
"type": "string"
|
|
979
|
+
}
|
|
980
|
+
}
|
|
981
|
+
],
|
|
982
|
+
"responses": {
|
|
983
|
+
"200": {
|
|
984
|
+
"description": "The resource usage metrics",
|
|
985
|
+
"content": {
|
|
986
|
+
"application/json": {
|
|
987
|
+
"schema": {
|
|
988
|
+
"$ref": "#/components/schemas/ServiceExecutionMetrics"
|
|
989
|
+
}
|
|
990
|
+
}
|
|
991
|
+
}
|
|
992
|
+
},
|
|
993
|
+
"401": {
|
|
994
|
+
"description": "Unauthorized"
|
|
995
|
+
},
|
|
996
|
+
"403": {
|
|
997
|
+
"description": "Forbidden"
|
|
998
|
+
},
|
|
999
|
+
"404": {
|
|
1000
|
+
"description": "Not Found"
|
|
1001
|
+
},
|
|
1002
|
+
"500": {
|
|
1003
|
+
"description": "Internal Server Error"
|
|
1004
|
+
}
|
|
1005
|
+
},
|
|
1006
|
+
"security": [
|
|
1007
|
+
{
|
|
1008
|
+
"oauth2": []
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"apiKey": []
|
|
1012
|
+
}
|
|
1013
|
+
]
|
|
1014
|
+
}
|
|
1015
|
+
},
|
|
1016
|
+
"/datapools/{id}/files/{fileId}": {
|
|
1017
|
+
"get": {
|
|
1018
|
+
"tags": [
|
|
1019
|
+
"Data Pools"
|
|
1020
|
+
],
|
|
1021
|
+
"description": "Get the content of a specific file from a data pool (both file and data pool identified by their ID).",
|
|
1022
|
+
"operationId": "getDataPoolFile",
|
|
1023
|
+
"parameters": [
|
|
1024
|
+
{
|
|
1025
|
+
"name": "id",
|
|
1026
|
+
"in": "path",
|
|
1027
|
+
"required": true,
|
|
1028
|
+
"schema": {
|
|
1029
|
+
"type": "string",
|
|
1030
|
+
"format": "uuid"
|
|
1031
|
+
}
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
"name": "fileId",
|
|
1035
|
+
"in": "path",
|
|
1036
|
+
"required": true,
|
|
1037
|
+
"schema": {
|
|
1038
|
+
"type": "string",
|
|
1039
|
+
"format": "uuid"
|
|
1040
|
+
}
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"name": "X-OrganizationId",
|
|
1044
|
+
"in": "header",
|
|
1045
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
1046
|
+
"schema": {
|
|
1047
|
+
"type": "string"
|
|
1048
|
+
}
|
|
1049
|
+
}
|
|
1050
|
+
],
|
|
1051
|
+
"responses": {
|
|
1052
|
+
"200": {
|
|
1053
|
+
"description": "The file content",
|
|
1054
|
+
"content": {
|
|
1055
|
+
"application/octet-stream": {
|
|
1056
|
+
"schema": {
|
|
1057
|
+
"type": "string",
|
|
1058
|
+
"format": "binary"
|
|
1059
|
+
}
|
|
1060
|
+
}
|
|
1061
|
+
}
|
|
1062
|
+
},
|
|
1063
|
+
"304": {
|
|
1064
|
+
"description": "Not Modified"
|
|
1065
|
+
},
|
|
1066
|
+
"401": {
|
|
1067
|
+
"description": "Unauthorized"
|
|
1068
|
+
},
|
|
1069
|
+
"403": {
|
|
1070
|
+
"description": "Forbidden"
|
|
1071
|
+
},
|
|
1072
|
+
"404": {
|
|
1073
|
+
"description": "Not Found"
|
|
1074
|
+
},
|
|
1075
|
+
"500": {
|
|
1076
|
+
"description": "Internal Server Error"
|
|
1077
|
+
}
|
|
1078
|
+
},
|
|
1079
|
+
"security": [
|
|
1080
|
+
{
|
|
1081
|
+
"oauth2": []
|
|
1082
|
+
},
|
|
1083
|
+
{
|
|
1084
|
+
"apiKey": []
|
|
1085
|
+
}
|
|
1086
|
+
]
|
|
1087
|
+
},
|
|
1088
|
+
"delete": {
|
|
1089
|
+
"tags": [
|
|
1090
|
+
"Data Pools"
|
|
1091
|
+
],
|
|
1092
|
+
"description": "Delete a specific file from a data pool (both file and data pool identified by their IDs).",
|
|
1093
|
+
"operationId": "deleteDataPoolFile",
|
|
1094
|
+
"parameters": [
|
|
1095
|
+
{
|
|
1096
|
+
"name": "id",
|
|
1097
|
+
"in": "path",
|
|
1098
|
+
"required": true,
|
|
1099
|
+
"schema": {
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"format": "uuid"
|
|
1102
|
+
}
|
|
1103
|
+
},
|
|
1104
|
+
{
|
|
1105
|
+
"name": "fileId",
|
|
1106
|
+
"in": "path",
|
|
1107
|
+
"required": true,
|
|
1108
|
+
"schema": {
|
|
1109
|
+
"type": "string",
|
|
1110
|
+
"format": "uuid"
|
|
1111
|
+
}
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"name": "X-OrganizationId",
|
|
1115
|
+
"in": "header",
|
|
1116
|
+
"description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
|
|
1117
|
+
"schema": {
|
|
1118
|
+
"type": "string"
|
|
1119
|
+
}
|
|
1120
|
+
}
|
|
1121
|
+
],
|
|
1122
|
+
"responses": {
|
|
1123
|
+
"204": {
|
|
1124
|
+
"description": "File is deleted"
|
|
1125
|
+
},
|
|
1126
|
+
"401": {
|
|
1127
|
+
"description": "Unauthorized"
|
|
1128
|
+
},
|
|
1129
|
+
"403": {
|
|
1130
|
+
"description": "Forbidden"
|
|
1131
|
+
},
|
|
1132
|
+
"404": {
|
|
1133
|
+
"description": "Not Found"
|
|
1134
|
+
},
|
|
1135
|
+
"500": {
|
|
1136
|
+
"description": "Internal Server Error"
|
|
1137
|
+
}
|
|
1138
|
+
},
|
|
1139
|
+
"security": [
|
|
1140
|
+
{
|
|
1141
|
+
"oauth2": []
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"apiKey": []
|
|
1145
|
+
}
|
|
1146
|
+
]
|
|
1147
|
+
}
|
|
1148
|
+
}
|
|
1149
|
+
},
|
|
1150
|
+
"components": {
|
|
1151
|
+
"schemas": {
|
|
1152
|
+
"UpdateDataPoolRequest": {
|
|
1153
|
+
"type": "object",
|
|
1154
|
+
"properties": {
|
|
1155
|
+
"name": {
|
|
1156
|
+
"type": "string",
|
|
1157
|
+
"description": "The name of the data pool. Must be at least 3 characters and at most 255 characters long.",
|
|
1158
|
+
"example": "my-data-pool",
|
|
1159
|
+
"maxLength": 255,
|
|
1160
|
+
"minLength": 3
|
|
1161
|
+
},
|
|
1162
|
+
"shortDescription": {
|
|
1163
|
+
"type": "string",
|
|
1164
|
+
"description": "Short description of the data pool.",
|
|
1165
|
+
"maxLength": 255
|
|
1166
|
+
},
|
|
1167
|
+
"description": {
|
|
1168
|
+
"type": "string",
|
|
1169
|
+
"description": "Detailed description of the data pool."
|
|
621
1170
|
}
|
|
622
1171
|
}
|
|
623
1172
|
},
|
|
@@ -637,28 +1186,127 @@
|
|
|
637
1186
|
},
|
|
638
1187
|
"id": {
|
|
639
1188
|
"type": "string",
|
|
640
|
-
"format": "uuid"
|
|
1189
|
+
"format": "uuid",
|
|
1190
|
+
"description": "Unique identifier of the data pool."
|
|
641
1191
|
},
|
|
642
1192
|
"name": {
|
|
643
|
-
"type": "string"
|
|
1193
|
+
"type": "string",
|
|
1194
|
+
"description": "Name of the data pool.",
|
|
1195
|
+
"example": "my-data-pool"
|
|
644
1196
|
},
|
|
645
1197
|
"shortDescription": {
|
|
646
|
-
"type": "string"
|
|
1198
|
+
"type": "string",
|
|
1199
|
+
"description": "Short description of the data pool."
|
|
647
1200
|
},
|
|
648
1201
|
"description": {
|
|
649
|
-
"type": "string"
|
|
1202
|
+
"type": "string",
|
|
1203
|
+
"description": "Detailed description of the data pool."
|
|
650
1204
|
},
|
|
651
1205
|
"createdAt": {
|
|
652
1206
|
"type": "string",
|
|
1207
|
+
"description": "Timestamp when the data pool was created.",
|
|
1208
|
+
"example": "2023-10-01 12:00:00",
|
|
653
1209
|
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
654
1210
|
}
|
|
655
1211
|
}
|
|
656
1212
|
},
|
|
1213
|
+
"CreateServiceJobRequest": {
|
|
1214
|
+
"type": "object",
|
|
1215
|
+
"properties": {
|
|
1216
|
+
"serviceId": {
|
|
1217
|
+
"type": "string",
|
|
1218
|
+
"format": "uuid",
|
|
1219
|
+
"description": "The ID fo the service for which the job is created."
|
|
1220
|
+
},
|
|
1221
|
+
"input": {
|
|
1222
|
+
"additionalProperties": true,
|
|
1223
|
+
"description": "Input data for the service job. This can be any JSON object that the service expects as input. The structure and content of this object depend on the specific service being executed."
|
|
1224
|
+
},
|
|
1225
|
+
"tags": {
|
|
1226
|
+
"type": "array",
|
|
1227
|
+
"description": "List of tags associated with the service job. Tags are saved in lowercase and can be used for filtering and searching.",
|
|
1228
|
+
"items": {
|
|
1229
|
+
"type": "string"
|
|
1230
|
+
}
|
|
1231
|
+
}
|
|
1232
|
+
}
|
|
1233
|
+
},
|
|
1234
|
+
"ServiceJobDto": {
|
|
1235
|
+
"type": "object",
|
|
1236
|
+
"properties": {
|
|
1237
|
+
"id": {
|
|
1238
|
+
"type": "string",
|
|
1239
|
+
"format": "uuid",
|
|
1240
|
+
"description": "The ID of the service job."
|
|
1241
|
+
},
|
|
1242
|
+
"serviceId": {
|
|
1243
|
+
"type": "string",
|
|
1244
|
+
"format": "uuid",
|
|
1245
|
+
"description": "The ID of the service for which this job was created."
|
|
1246
|
+
},
|
|
1247
|
+
"serviceDefinitionId": {
|
|
1248
|
+
"type": "string",
|
|
1249
|
+
"format": "uuid",
|
|
1250
|
+
"description": "The ID of the service definition for which this job was created."
|
|
1251
|
+
},
|
|
1252
|
+
"status": {
|
|
1253
|
+
"type": "string",
|
|
1254
|
+
"description": "Status of the service job.",
|
|
1255
|
+
"enum": [
|
|
1256
|
+
"UNKNOWN",
|
|
1257
|
+
"PENDING",
|
|
1258
|
+
"RUNNING",
|
|
1259
|
+
"SUCCEEDED",
|
|
1260
|
+
"FAILED",
|
|
1261
|
+
"CANCELLED"
|
|
1262
|
+
],
|
|
1263
|
+
"example": "RUNNING"
|
|
1264
|
+
},
|
|
1265
|
+
"createdAt": {
|
|
1266
|
+
"type": "string",
|
|
1267
|
+
"description": "Timestamp when the service job was created.",
|
|
1268
|
+
"example": "2023-10-01 12:00:00",
|
|
1269
|
+
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
1270
|
+
},
|
|
1271
|
+
"startedAt": {
|
|
1272
|
+
"type": "string",
|
|
1273
|
+
"description": "Timestamp when the service job started.",
|
|
1274
|
+
"example": "2023-10-01 12:00:00",
|
|
1275
|
+
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
1276
|
+
},
|
|
1277
|
+
"endedAt": {
|
|
1278
|
+
"type": "string",
|
|
1279
|
+
"description": "Timestamp when the service job ended.",
|
|
1280
|
+
"example": "2023-10-01 12:00:00",
|
|
1281
|
+
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
1282
|
+
},
|
|
1283
|
+
"type": {
|
|
1284
|
+
"type": "string",
|
|
1285
|
+
"description": "Type identifier for the service job, indicating whether the underlying service is a 'managed' or 'workflow' service.",
|
|
1286
|
+
"enum": [
|
|
1287
|
+
"MANAGED",
|
|
1288
|
+
"EXTERNAL",
|
|
1289
|
+
"WORKFLOW"
|
|
1290
|
+
]
|
|
1291
|
+
},
|
|
1292
|
+
"tags": {
|
|
1293
|
+
"type": "array",
|
|
1294
|
+
"description": "List of tags associated with the service job. Tags are saved in lowercase and can be used for filtering and searching.",
|
|
1295
|
+
"items": {
|
|
1296
|
+
"type": "string"
|
|
1297
|
+
}
|
|
1298
|
+
}
|
|
1299
|
+
}
|
|
1300
|
+
},
|
|
657
1301
|
"CreateDataPoolRequest": {
|
|
658
1302
|
"type": "object",
|
|
659
1303
|
"properties": {
|
|
660
1304
|
"name": {
|
|
661
|
-
"type": "string"
|
|
1305
|
+
"type": "string",
|
|
1306
|
+
"description": "The name of the data pool. Must be at least 3 characters and at most 255 characters long.",
|
|
1307
|
+
"example": "my-data-pool",
|
|
1308
|
+
"maxLength": 255,
|
|
1309
|
+
"minLength": 3
|
|
662
1310
|
}
|
|
663
1311
|
}
|
|
664
1312
|
},
|
|
@@ -667,30 +1315,278 @@
|
|
|
667
1315
|
"properties": {
|
|
668
1316
|
"id": {
|
|
669
1317
|
"type": "string",
|
|
670
|
-
"format": "uuid"
|
|
1318
|
+
"format": "uuid",
|
|
1319
|
+
"description": "Unique identifier of the data pool file."
|
|
671
1320
|
},
|
|
672
1321
|
"dataPoolId": {
|
|
673
1322
|
"type": "string",
|
|
674
|
-
"format": "uuid"
|
|
1323
|
+
"format": "uuid",
|
|
1324
|
+
"description": "Unique identifier of the data pool."
|
|
675
1325
|
},
|
|
676
1326
|
"name": {
|
|
677
|
-
"type": "string"
|
|
1327
|
+
"type": "string",
|
|
1328
|
+
"description": "The name of the file.",
|
|
1329
|
+
"example": "example.txt"
|
|
678
1330
|
},
|
|
679
1331
|
"fullPath": {
|
|
680
|
-
"type": "string"
|
|
1332
|
+
"type": "string",
|
|
1333
|
+
"description": "The full path of the file in the data pool.",
|
|
1334
|
+
"example": "/path/to/example.txt"
|
|
681
1335
|
},
|
|
682
1336
|
"contentType": {
|
|
683
|
-
"type": "string"
|
|
1337
|
+
"type": "string",
|
|
1338
|
+
"description": "The content type of the file.",
|
|
1339
|
+
"example": "text/plain"
|
|
684
1340
|
},
|
|
685
1341
|
"contentLength": {
|
|
686
1342
|
"type": "integer",
|
|
687
|
-
"format": "int64"
|
|
1343
|
+
"format": "int64",
|
|
1344
|
+
"description": "The size of the file in bytes.",
|
|
1345
|
+
"example": 1024
|
|
688
1346
|
},
|
|
689
1347
|
"createdAt": {
|
|
690
1348
|
"type": "string",
|
|
1349
|
+
"description": "Timestamp when the file was created.",
|
|
1350
|
+
"example": "2023-10-01 12:00:00",
|
|
1351
|
+
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
1352
|
+
}
|
|
1353
|
+
}
|
|
1354
|
+
},
|
|
1355
|
+
"LogEntry": {
|
|
1356
|
+
"type": "object",
|
|
1357
|
+
"properties": {
|
|
1358
|
+
"message": {
|
|
1359
|
+
"type": "string",
|
|
1360
|
+
"description": "Log message content."
|
|
1361
|
+
},
|
|
1362
|
+
"severity": {
|
|
1363
|
+
"type": "string",
|
|
1364
|
+
"description": "Severity of the log entry.",
|
|
1365
|
+
"enum": [
|
|
1366
|
+
"DEBUG",
|
|
1367
|
+
"NOTICE",
|
|
1368
|
+
"INFO",
|
|
1369
|
+
"WARNING",
|
|
1370
|
+
"ERROR"
|
|
1371
|
+
],
|
|
1372
|
+
"example": "INFO"
|
|
1373
|
+
},
|
|
1374
|
+
"timestamp": {
|
|
1375
|
+
"type": "string",
|
|
1376
|
+
"description": "Timestamp when the entry was logged.",
|
|
1377
|
+
"example": "2023-10-01 12:00:00",
|
|
691
1378
|
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
692
1379
|
}
|
|
693
1380
|
}
|
|
1381
|
+
},
|
|
1382
|
+
"ServiceExecutionLogs": {
|
|
1383
|
+
"type": "array",
|
|
1384
|
+
"items": {
|
|
1385
|
+
"$ref": "#/components/schemas/LogEntry"
|
|
1386
|
+
},
|
|
1387
|
+
"properties": {
|
|
1388
|
+
"empty": {
|
|
1389
|
+
"type": "boolean"
|
|
1390
|
+
}
|
|
1391
|
+
}
|
|
1392
|
+
},
|
|
1393
|
+
"ServiceExecutionDto": {
|
|
1394
|
+
"type": "object",
|
|
1395
|
+
"properties": {
|
|
1396
|
+
"id": {
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"format": "uuid"
|
|
1399
|
+
},
|
|
1400
|
+
"createdAt": {
|
|
1401
|
+
"type": "string",
|
|
1402
|
+
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
1403
|
+
},
|
|
1404
|
+
"startedAt": {
|
|
1405
|
+
"type": "string",
|
|
1406
|
+
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
1407
|
+
},
|
|
1408
|
+
"endedAt": {
|
|
1409
|
+
"type": "string",
|
|
1410
|
+
"pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
|
|
1411
|
+
},
|
|
1412
|
+
"status": {
|
|
1413
|
+
"type": "string",
|
|
1414
|
+
"enum": [
|
|
1415
|
+
"UNKNOWN",
|
|
1416
|
+
"PENDING",
|
|
1417
|
+
"RUNNING",
|
|
1418
|
+
"SUCCEEDED",
|
|
1419
|
+
"FAILED",
|
|
1420
|
+
"CANCELLED"
|
|
1421
|
+
]
|
|
1422
|
+
}
|
|
1423
|
+
}
|
|
1424
|
+
},
|
|
1425
|
+
"ActivityInstance": {
|
|
1426
|
+
"type": "object",
|
|
1427
|
+
"properties": {
|
|
1428
|
+
"id": {
|
|
1429
|
+
"type": "string"
|
|
1430
|
+
},
|
|
1431
|
+
"modelId": {
|
|
1432
|
+
"type": "string"
|
|
1433
|
+
},
|
|
1434
|
+
"name": {
|
|
1435
|
+
"type": "string"
|
|
1436
|
+
},
|
|
1437
|
+
"type": {
|
|
1438
|
+
"type": "string"
|
|
1439
|
+
},
|
|
1440
|
+
"startTime": {
|
|
1441
|
+
"type": "string",
|
|
1442
|
+
"format": "date-time"
|
|
1443
|
+
},
|
|
1444
|
+
"endTime": {
|
|
1445
|
+
"type": "string",
|
|
1446
|
+
"format": "date-time"
|
|
1447
|
+
},
|
|
1448
|
+
"state": {
|
|
1449
|
+
"type": "string",
|
|
1450
|
+
"enum": [
|
|
1451
|
+
"PENDING",
|
|
1452
|
+
"RUNNING",
|
|
1453
|
+
"COMPLETED"
|
|
1454
|
+
]
|
|
1455
|
+
}
|
|
1456
|
+
}
|
|
1457
|
+
},
|
|
1458
|
+
"VariableInstance": {
|
|
1459
|
+
"type": "object",
|
|
1460
|
+
"properties": {
|
|
1461
|
+
"id": {
|
|
1462
|
+
"type": "string"
|
|
1463
|
+
},
|
|
1464
|
+
"name": {
|
|
1465
|
+
"type": "string"
|
|
1466
|
+
},
|
|
1467
|
+
"type": {
|
|
1468
|
+
"type": "string"
|
|
1469
|
+
},
|
|
1470
|
+
"value": {}
|
|
1471
|
+
}
|
|
1472
|
+
},
|
|
1473
|
+
"WorkflowInstance": {
|
|
1474
|
+
"type": "object",
|
|
1475
|
+
"properties": {
|
|
1476
|
+
"id": {
|
|
1477
|
+
"type": "string"
|
|
1478
|
+
},
|
|
1479
|
+
"state": {
|
|
1480
|
+
"type": "string",
|
|
1481
|
+
"enum": [
|
|
1482
|
+
"UNKNOWN",
|
|
1483
|
+
"PENDING",
|
|
1484
|
+
"RUNNING",
|
|
1485
|
+
"SUCCEEDED",
|
|
1486
|
+
"FAILED",
|
|
1487
|
+
"CANCELLED"
|
|
1488
|
+
]
|
|
1489
|
+
},
|
|
1490
|
+
"startedAt": {
|
|
1491
|
+
"type": "string",
|
|
1492
|
+
"format": "date-time"
|
|
1493
|
+
},
|
|
1494
|
+
"endedAt": {
|
|
1495
|
+
"type": "string",
|
|
1496
|
+
"format": "date-time"
|
|
1497
|
+
},
|
|
1498
|
+
"activities": {
|
|
1499
|
+
"type": "array",
|
|
1500
|
+
"items": {
|
|
1501
|
+
"$ref": "#/components/schemas/ActivityInstance"
|
|
1502
|
+
},
|
|
1503
|
+
"uniqueItems": true
|
|
1504
|
+
},
|
|
1505
|
+
"variables": {
|
|
1506
|
+
"type": "array",
|
|
1507
|
+
"items": {
|
|
1508
|
+
"$ref": "#/components/schemas/VariableInstance"
|
|
1509
|
+
},
|
|
1510
|
+
"uniqueItems": true
|
|
1511
|
+
}
|
|
1512
|
+
}
|
|
1513
|
+
},
|
|
1514
|
+
"WorkflowServiceExecutionDto": {
|
|
1515
|
+
"type": "object",
|
|
1516
|
+
"properties": {
|
|
1517
|
+
"workflowInstance": {
|
|
1518
|
+
"$ref": "#/components/schemas/WorkflowInstance"
|
|
1519
|
+
},
|
|
1520
|
+
"workflowModel": {
|
|
1521
|
+
"type": "string"
|
|
1522
|
+
}
|
|
1523
|
+
}
|
|
1524
|
+
},
|
|
1525
|
+
"MetricDataPoint": {
|
|
1526
|
+
"type": "object",
|
|
1527
|
+
"description": "A single data point in a time series metric",
|
|
1528
|
+
"properties": {
|
|
1529
|
+
"timestamp": {
|
|
1530
|
+
"type": "integer",
|
|
1531
|
+
"format": "int64",
|
|
1532
|
+
"description": "Timestamp of the data point in milliseconds since Unix epoch (UTC)",
|
|
1533
|
+
"example": 1756965745000
|
|
1534
|
+
},
|
|
1535
|
+
"value": {
|
|
1536
|
+
"type": "number",
|
|
1537
|
+
"format": "double",
|
|
1538
|
+
"description": "The metric value"
|
|
1539
|
+
}
|
|
1540
|
+
}
|
|
1541
|
+
},
|
|
1542
|
+
"ServiceExecutionMetrics": {
|
|
1543
|
+
"type": "object",
|
|
1544
|
+
"description": "Resource usage metrics for a service execution",
|
|
1545
|
+
"properties": {
|
|
1546
|
+
"serviceExecutionId": {
|
|
1547
|
+
"type": "string",
|
|
1548
|
+
"format": "uuid",
|
|
1549
|
+
"description": "Service execution ID"
|
|
1550
|
+
},
|
|
1551
|
+
"cpuUsage": {
|
|
1552
|
+
"type": "array",
|
|
1553
|
+
"description": "CPU usage metrics time series",
|
|
1554
|
+
"items": {
|
|
1555
|
+
"$ref": "#/components/schemas/MetricDataPoint"
|
|
1556
|
+
}
|
|
1557
|
+
},
|
|
1558
|
+
"cpuLimit": {
|
|
1559
|
+
"type": "array",
|
|
1560
|
+
"description": "CPU limit metrics time series",
|
|
1561
|
+
"items": {
|
|
1562
|
+
"$ref": "#/components/schemas/MetricDataPoint"
|
|
1563
|
+
}
|
|
1564
|
+
},
|
|
1565
|
+
"memoryUsage": {
|
|
1566
|
+
"type": "array",
|
|
1567
|
+
"description": "Memory usage metrics time series",
|
|
1568
|
+
"items": {
|
|
1569
|
+
"$ref": "#/components/schemas/MetricDataPoint"
|
|
1570
|
+
}
|
|
1571
|
+
},
|
|
1572
|
+
"memoryLimit": {
|
|
1573
|
+
"type": "array",
|
|
1574
|
+
"description": "Memory limit metrics time series",
|
|
1575
|
+
"items": {
|
|
1576
|
+
"$ref": "#/components/schemas/MetricDataPoint"
|
|
1577
|
+
}
|
|
1578
|
+
},
|
|
1579
|
+
"startTime": {
|
|
1580
|
+
"type": "string",
|
|
1581
|
+
"format": "date-time",
|
|
1582
|
+
"description": "Time range start"
|
|
1583
|
+
},
|
|
1584
|
+
"endTime": {
|
|
1585
|
+
"type": "string",
|
|
1586
|
+
"format": "date-time",
|
|
1587
|
+
"description": "Time range end"
|
|
1588
|
+
}
|
|
1589
|
+
}
|
|
694
1590
|
}
|
|
695
1591
|
},
|
|
696
1592
|
"securitySchemes": {
|
|
@@ -713,4 +1609,4 @@
|
|
|
713
1609
|
}
|
|
714
1610
|
}
|
|
715
1611
|
}
|
|
716
|
-
}
|
|
1612
|
+
}
|