@twin.org/node 0.0.3-next.23 → 0.0.3-next.24
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/dist/locales/en.json +112 -21
- package/docs/changelog.md +14 -0
- package/docs/open-api/spec.json +764 -299
- package/package.json +2 -2
package/docs/open-api/spec.json
CHANGED
|
@@ -88,8 +88,12 @@
|
|
|
88
88
|
"description": "Service providing Dataspace Protocol-compliant catalogue endpoints for dataset discovery and query."
|
|
89
89
|
},
|
|
90
90
|
{
|
|
91
|
-
"name": "Data
|
|
92
|
-
"description": "Endpoints to access a Data
|
|
91
|
+
"name": "Dataspace Data Plane",
|
|
92
|
+
"description": "Endpoints to access a Dataspace Data Plane."
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "Transfer Process",
|
|
96
|
+
"description": "DSP Transfer Process Protocol endpoints for initiating and managing data transfers."
|
|
93
97
|
},
|
|
94
98
|
{
|
|
95
99
|
"name": "Policy Administration Point",
|
|
@@ -13886,12 +13890,12 @@
|
|
|
13886
13890
|
}
|
|
13887
13891
|
}
|
|
13888
13892
|
},
|
|
13889
|
-
"/data-
|
|
13893
|
+
"/dataspace-data-plane/notify": {
|
|
13890
13894
|
"post": {
|
|
13891
13895
|
"operationId": "activityStreamNotify",
|
|
13892
13896
|
"summary": "Notify of a new Activity",
|
|
13893
13897
|
"tags": [
|
|
13894
|
-
"Data
|
|
13898
|
+
"Dataspace Data Plane"
|
|
13895
13899
|
],
|
|
13896
13900
|
"security": [
|
|
13897
13901
|
{
|
|
@@ -14008,17 +14012,17 @@
|
|
|
14008
14012
|
}
|
|
14009
14013
|
}
|
|
14010
14014
|
},
|
|
14011
|
-
"/data-
|
|
14015
|
+
"/dataspace-data-plane/activity-logs/{id}": {
|
|
14012
14016
|
"get": {
|
|
14013
|
-
"operationId": "
|
|
14017
|
+
"operationId": "dataspaceDataPlaneGetActivityLogEntry",
|
|
14014
14018
|
"summary": "Get a Activity Log Entry",
|
|
14015
14019
|
"tags": [
|
|
14016
|
-
"Data
|
|
14020
|
+
"Dataspace Data Plane"
|
|
14017
14021
|
],
|
|
14018
14022
|
"parameters": [
|
|
14019
14023
|
{
|
|
14020
14024
|
"name": "id",
|
|
14021
|
-
"description": "
|
|
14025
|
+
"description": "",
|
|
14022
14026
|
"in": "path",
|
|
14023
14027
|
"required": true,
|
|
14024
14028
|
"schema": {
|
|
@@ -14052,7 +14056,7 @@
|
|
|
14052
14056
|
"pendingTasks": [
|
|
14053
14057
|
{
|
|
14054
14058
|
"taskId": "urn:x-task-id:45678",
|
|
14055
|
-
"
|
|
14059
|
+
"dataspaceAppId": "https://my-app.example.org/app1"
|
|
14056
14060
|
}
|
|
14057
14061
|
],
|
|
14058
14062
|
"runningTasks": [],
|
|
@@ -14124,79 +14128,12 @@
|
|
|
14124
14128
|
}
|
|
14125
14129
|
}
|
|
14126
14130
|
},
|
|
14127
|
-
"/data-
|
|
14131
|
+
"/dataspace-data-plane/entities": {
|
|
14128
14132
|
"get": {
|
|
14129
|
-
"operationId": "
|
|
14133
|
+
"operationId": "dataspaceDataPlaneGetDataAssetEntities",
|
|
14130
14134
|
"summary": "Get Data Asset Entities",
|
|
14131
14135
|
"tags": [
|
|
14132
|
-
"Data
|
|
14133
|
-
],
|
|
14134
|
-
"parameters": [
|
|
14135
|
-
{
|
|
14136
|
-
"name": "id",
|
|
14137
|
-
"description": "The ID of the entity(ies) to get. (comma separated list)",
|
|
14138
|
-
"in": "query",
|
|
14139
|
-
"required": false,
|
|
14140
|
-
"schema": {
|
|
14141
|
-
"type": "string"
|
|
14142
|
-
},
|
|
14143
|
-
"example": "urn:ucr:24PLP051219453I002610799053311"
|
|
14144
|
-
},
|
|
14145
|
-
{
|
|
14146
|
-
"name": "type",
|
|
14147
|
-
"description": "The type of the entity to get.",
|
|
14148
|
-
"in": "query",
|
|
14149
|
-
"required": false,
|
|
14150
|
-
"schema": {
|
|
14151
|
-
"type": "string"
|
|
14152
|
-
},
|
|
14153
|
-
"example": "https://vocabulary.uncefact.org/Consignment"
|
|
14154
|
-
},
|
|
14155
|
-
{
|
|
14156
|
-
"name": "dataServiceId",
|
|
14157
|
-
"description": "The Id of the data service that offers the data asset",
|
|
14158
|
-
"in": "query",
|
|
14159
|
-
"required": false,
|
|
14160
|
-
"schema": {
|
|
14161
|
-
"type": "string"
|
|
14162
|
-
}
|
|
14163
|
-
},
|
|
14164
|
-
{
|
|
14165
|
-
"name": "datasetId",
|
|
14166
|
-
"description": "The Id of the datasets that describes the data asset (comma separated list)",
|
|
14167
|
-
"in": "query",
|
|
14168
|
-
"required": false,
|
|
14169
|
-
"schema": {
|
|
14170
|
-
"type": "string"
|
|
14171
|
-
}
|
|
14172
|
-
},
|
|
14173
|
-
{
|
|
14174
|
-
"name": "limit",
|
|
14175
|
-
"description": "The maximum number of entities to retrieve.",
|
|
14176
|
-
"in": "query",
|
|
14177
|
-
"required": false,
|
|
14178
|
-
"schema": {
|
|
14179
|
-
"type": "string"
|
|
14180
|
-
}
|
|
14181
|
-
},
|
|
14182
|
-
{
|
|
14183
|
-
"name": "cursor",
|
|
14184
|
-
"description": "Cursor to control pagination.",
|
|
14185
|
-
"in": "query",
|
|
14186
|
-
"required": false,
|
|
14187
|
-
"schema": {
|
|
14188
|
-
"type": "string"
|
|
14189
|
-
}
|
|
14190
|
-
},
|
|
14191
|
-
{
|
|
14192
|
-
"name": "authorization",
|
|
14193
|
-
"in": "header",
|
|
14194
|
-
"required": true,
|
|
14195
|
-
"schema": {
|
|
14196
|
-
"type": "string"
|
|
14197
|
-
},
|
|
14198
|
-
"style": "simple"
|
|
14199
|
-
}
|
|
14136
|
+
"Dataspace Data Plane"
|
|
14200
14137
|
],
|
|
14201
14138
|
"responses": {
|
|
14202
14139
|
"200": {
|
|
@@ -14266,41 +14203,12 @@
|
|
|
14266
14203
|
}
|
|
14267
14204
|
}
|
|
14268
14205
|
},
|
|
14269
|
-
"/data-
|
|
14206
|
+
"/dataspace-data-plane/entities/query": {
|
|
14270
14207
|
"post": {
|
|
14271
|
-
"operationId": "
|
|
14208
|
+
"operationId": "dataspaceDataPlaneQueryDataAsset",
|
|
14272
14209
|
"summary": "Query Data Asset",
|
|
14273
14210
|
"tags": [
|
|
14274
|
-
"Data
|
|
14275
|
-
],
|
|
14276
|
-
"parameters": [
|
|
14277
|
-
{
|
|
14278
|
-
"name": "cursor",
|
|
14279
|
-
"description": "Opaque cursor token for pagination.",
|
|
14280
|
-
"in": "query",
|
|
14281
|
-
"required": false,
|
|
14282
|
-
"schema": {
|
|
14283
|
-
"type": "string"
|
|
14284
|
-
}
|
|
14285
|
-
},
|
|
14286
|
-
{
|
|
14287
|
-
"name": "limit",
|
|
14288
|
-
"description": "Maximum number of items to return.",
|
|
14289
|
-
"in": "query",
|
|
14290
|
-
"required": false,
|
|
14291
|
-
"schema": {
|
|
14292
|
-
"type": "string"
|
|
14293
|
-
}
|
|
14294
|
-
},
|
|
14295
|
-
{
|
|
14296
|
-
"name": "authorization",
|
|
14297
|
-
"in": "header",
|
|
14298
|
-
"required": true,
|
|
14299
|
-
"schema": {
|
|
14300
|
-
"type": "string"
|
|
14301
|
-
},
|
|
14302
|
-
"style": "simple"
|
|
14303
|
-
}
|
|
14211
|
+
"Dataspace Data Plane"
|
|
14304
14212
|
],
|
|
14305
14213
|
"requestBody": {
|
|
14306
14214
|
"description": "Request to query data asset entities.",
|
|
@@ -14313,7 +14221,7 @@
|
|
|
14313
14221
|
"examples": {
|
|
14314
14222
|
"dataAssetQuery": {
|
|
14315
14223
|
"value": {
|
|
14316
|
-
"
|
|
14224
|
+
"consumerPid": "urn:uuid:consumer-pid-12345",
|
|
14317
14225
|
"query": {
|
|
14318
14226
|
"type": "Example",
|
|
14319
14227
|
"q": "example query"
|
|
@@ -14392,52 +14300,26 @@
|
|
|
14392
14300
|
}
|
|
14393
14301
|
}
|
|
14394
14302
|
},
|
|
14395
|
-
"/
|
|
14303
|
+
"/dataspace-control-plane/transfers/request": {
|
|
14396
14304
|
"post": {
|
|
14397
|
-
"operationId": "
|
|
14398
|
-
"summary": "
|
|
14305
|
+
"operationId": "requestTransfer",
|
|
14306
|
+
"summary": "Request Transfer Process (DSP)",
|
|
14399
14307
|
"tags": [
|
|
14400
|
-
"
|
|
14308
|
+
"Transfer Process"
|
|
14401
14309
|
],
|
|
14402
14310
|
"security": [
|
|
14403
14311
|
{
|
|
14404
14312
|
"jwtBearerAuthScheme": []
|
|
14405
14313
|
}
|
|
14406
14314
|
],
|
|
14407
|
-
"requestBody": {
|
|
14408
|
-
"description": "The request structure for creating a policy.",
|
|
14409
|
-
"required": true,
|
|
14410
|
-
"content": {
|
|
14411
|
-
"application/json": {
|
|
14412
|
-
"schema": {
|
|
14413
|
-
"$ref": "#/components/schemas/PapCreateRequest"
|
|
14414
|
-
},
|
|
14415
|
-
"examples": {
|
|
14416
|
-
"papCreateRequestExample": {
|
|
14417
|
-
"value": {
|
|
14418
|
-
"@context": "http://www.w3.org/ns/odrl.jsonld",
|
|
14419
|
-
"@type": "Set",
|
|
14420
|
-
"permission": [
|
|
14421
|
-
{
|
|
14422
|
-
"target": "http://example.com/asset/1",
|
|
14423
|
-
"action": "use"
|
|
14424
|
-
}
|
|
14425
|
-
]
|
|
14426
|
-
}
|
|
14427
|
-
}
|
|
14428
|
-
}
|
|
14429
|
-
}
|
|
14430
|
-
}
|
|
14431
|
-
},
|
|
14432
14315
|
"responses": {
|
|
14433
|
-
"
|
|
14434
|
-
"description": "The rest request ended in
|
|
14435
|
-
"
|
|
14436
|
-
"
|
|
14316
|
+
"200": {
|
|
14317
|
+
"description": "The rest request ended in success with no data.",
|
|
14318
|
+
"content": {
|
|
14319
|
+
"text/plain": {
|
|
14437
14320
|
"schema": {
|
|
14438
|
-
"
|
|
14439
|
-
}
|
|
14440
|
-
"description": "e.g. urn:rights-management:abc123def456"
|
|
14321
|
+
"$ref": "#/components/schemas/OkResponse"
|
|
14322
|
+
}
|
|
14441
14323
|
}
|
|
14442
14324
|
}
|
|
14443
14325
|
},
|
|
@@ -14499,77 +14381,25 @@
|
|
|
14499
14381
|
}
|
|
14500
14382
|
}
|
|
14501
14383
|
}
|
|
14502
|
-
}
|
|
14384
|
+
}
|
|
14385
|
+
},
|
|
14386
|
+
"/dataspace-control-plane/transfers/{pid}": {
|
|
14503
14387
|
"get": {
|
|
14504
|
-
"operationId": "
|
|
14505
|
-
"summary": "
|
|
14388
|
+
"operationId": "getTransferProcess",
|
|
14389
|
+
"summary": "Get Transfer Process state (DSP)",
|
|
14506
14390
|
"tags": [
|
|
14507
|
-
"
|
|
14391
|
+
"Transfer Process"
|
|
14508
14392
|
],
|
|
14509
14393
|
"parameters": [
|
|
14510
14394
|
{
|
|
14511
|
-
"name": "
|
|
14512
|
-
"description": "
|
|
14513
|
-
"in": "
|
|
14514
|
-
"required":
|
|
14515
|
-
"schema": {
|
|
14516
|
-
"type": "string"
|
|
14517
|
-
}
|
|
14518
|
-
},
|
|
14519
|
-
{
|
|
14520
|
-
"name": "assignee",
|
|
14521
|
-
"description": "The assignee to filter by.",
|
|
14522
|
-
"in": "query",
|
|
14523
|
-
"required": false,
|
|
14524
|
-
"schema": {
|
|
14525
|
-
"type": "string"
|
|
14526
|
-
}
|
|
14527
|
-
},
|
|
14528
|
-
{
|
|
14529
|
-
"name": "action",
|
|
14530
|
-
"description": "The action to filter by.",
|
|
14531
|
-
"in": "query",
|
|
14532
|
-
"required": false,
|
|
14533
|
-
"schema": {
|
|
14534
|
-
"type": "string"
|
|
14535
|
-
}
|
|
14536
|
-
},
|
|
14537
|
-
{
|
|
14538
|
-
"name": "target",
|
|
14539
|
-
"description": "The target to filter by.",
|
|
14540
|
-
"in": "query",
|
|
14541
|
-
"required": false,
|
|
14542
|
-
"schema": {
|
|
14543
|
-
"type": "string"
|
|
14544
|
-
}
|
|
14545
|
-
},
|
|
14546
|
-
{
|
|
14547
|
-
"name": "conditions",
|
|
14548
|
-
"description": "The condition for the query.",
|
|
14549
|
-
"in": "query",
|
|
14550
|
-
"required": false,
|
|
14551
|
-
"schema": {
|
|
14552
|
-
"type": "string"
|
|
14553
|
-
}
|
|
14554
|
-
},
|
|
14555
|
-
{
|
|
14556
|
-
"name": "limit",
|
|
14557
|
-
"description": "Limit the number of entities to return.",
|
|
14558
|
-
"in": "query",
|
|
14559
|
-
"required": false,
|
|
14560
|
-
"schema": {
|
|
14561
|
-
"type": "string"
|
|
14562
|
-
}
|
|
14563
|
-
},
|
|
14564
|
-
{
|
|
14565
|
-
"name": "cursor",
|
|
14566
|
-
"description": "The cursor to get next chunk of data, returned in previous response.",
|
|
14567
|
-
"in": "query",
|
|
14568
|
-
"required": false,
|
|
14395
|
+
"name": "pid",
|
|
14396
|
+
"description": "",
|
|
14397
|
+
"in": "path",
|
|
14398
|
+
"required": true,
|
|
14569
14399
|
"schema": {
|
|
14570
14400
|
"type": "string"
|
|
14571
14401
|
},
|
|
14572
|
-
"
|
|
14402
|
+
"style": "simple"
|
|
14573
14403
|
}
|
|
14574
14404
|
],
|
|
14575
14405
|
"security": [
|
|
@@ -14579,28 +14409,11 @@
|
|
|
14579
14409
|
],
|
|
14580
14410
|
"responses": {
|
|
14581
14411
|
"200": {
|
|
14582
|
-
"description": "The
|
|
14412
|
+
"description": "The rest request ended in success with no data.",
|
|
14583
14413
|
"content": {
|
|
14584
|
-
"
|
|
14414
|
+
"text/plain": {
|
|
14585
14415
|
"schema": {
|
|
14586
|
-
"$ref": "#/components/schemas/
|
|
14587
|
-
},
|
|
14588
|
-
"examples": {
|
|
14589
|
-
"papQueryResponseExample": {
|
|
14590
|
-
"value": [
|
|
14591
|
-
{
|
|
14592
|
-
"@context": "http://www.w3.org/ns/odrl.jsonld",
|
|
14593
|
-
"@type": "Set",
|
|
14594
|
-
"uid": "urn:rights-management:abc123def456",
|
|
14595
|
-
"permission": [
|
|
14596
|
-
{
|
|
14597
|
-
"target": "http://example.com/asset/1",
|
|
14598
|
-
"action": "use"
|
|
14599
|
-
}
|
|
14600
|
-
]
|
|
14601
|
-
}
|
|
14602
|
-
]
|
|
14603
|
-
}
|
|
14416
|
+
"$ref": "#/components/schemas/OkResponse"
|
|
14604
14417
|
}
|
|
14605
14418
|
}
|
|
14606
14419
|
}
|
|
@@ -14665,24 +14478,23 @@
|
|
|
14665
14478
|
}
|
|
14666
14479
|
}
|
|
14667
14480
|
},
|
|
14668
|
-
"/
|
|
14669
|
-
"
|
|
14670
|
-
"operationId": "
|
|
14671
|
-
"summary": "
|
|
14481
|
+
"/dataspace-control-plane/transfers/{pid}/start": {
|
|
14482
|
+
"post": {
|
|
14483
|
+
"operationId": "startTransfer",
|
|
14484
|
+
"summary": "Start Transfer Process (DSP)",
|
|
14672
14485
|
"tags": [
|
|
14673
|
-
"
|
|
14486
|
+
"Transfer Process"
|
|
14674
14487
|
],
|
|
14675
14488
|
"parameters": [
|
|
14676
14489
|
{
|
|
14677
|
-
"name": "
|
|
14678
|
-
"description": "
|
|
14490
|
+
"name": "pid",
|
|
14491
|
+
"description": "",
|
|
14679
14492
|
"in": "path",
|
|
14680
14493
|
"required": true,
|
|
14681
14494
|
"schema": {
|
|
14682
14495
|
"type": "string"
|
|
14683
14496
|
},
|
|
14684
|
-
"style": "simple"
|
|
14685
|
-
"example": "urn:rights-management:abc123def456"
|
|
14497
|
+
"style": "simple"
|
|
14686
14498
|
}
|
|
14687
14499
|
],
|
|
14688
14500
|
"security": [
|
|
@@ -14690,31 +14502,685 @@
|
|
|
14690
14502
|
"jwtBearerAuthScheme": []
|
|
14691
14503
|
}
|
|
14692
14504
|
],
|
|
14693
|
-
"
|
|
14694
|
-
"
|
|
14695
|
-
|
|
14696
|
-
|
|
14697
|
-
|
|
14698
|
-
|
|
14699
|
-
|
|
14700
|
-
|
|
14701
|
-
|
|
14702
|
-
|
|
14703
|
-
|
|
14704
|
-
|
|
14705
|
-
|
|
14706
|
-
|
|
14707
|
-
|
|
14708
|
-
|
|
14709
|
-
|
|
14710
|
-
|
|
14711
|
-
|
|
14712
|
-
|
|
14713
|
-
|
|
14714
|
-
|
|
14715
|
-
|
|
14716
|
-
|
|
14717
|
-
|
|
14505
|
+
"responses": {
|
|
14506
|
+
"200": {
|
|
14507
|
+
"description": "The rest request ended in success with no data.",
|
|
14508
|
+
"content": {
|
|
14509
|
+
"text/plain": {
|
|
14510
|
+
"schema": {
|
|
14511
|
+
"$ref": "#/components/schemas/OkResponse"
|
|
14512
|
+
}
|
|
14513
|
+
}
|
|
14514
|
+
}
|
|
14515
|
+
},
|
|
14516
|
+
"400": {
|
|
14517
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
14518
|
+
"content": {
|
|
14519
|
+
"application/json": {
|
|
14520
|
+
"schema": {
|
|
14521
|
+
"$ref": "#/components/schemas/Error"
|
|
14522
|
+
},
|
|
14523
|
+
"examples": {
|
|
14524
|
+
"exampleResponse": {
|
|
14525
|
+
"value": {
|
|
14526
|
+
"name": "GeneralError",
|
|
14527
|
+
"message": "errorMessage",
|
|
14528
|
+
"properties": {
|
|
14529
|
+
"foo": "bar"
|
|
14530
|
+
}
|
|
14531
|
+
}
|
|
14532
|
+
}
|
|
14533
|
+
}
|
|
14534
|
+
}
|
|
14535
|
+
}
|
|
14536
|
+
},
|
|
14537
|
+
"401": {
|
|
14538
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
14539
|
+
"content": {
|
|
14540
|
+
"application/json": {
|
|
14541
|
+
"schema": {
|
|
14542
|
+
"$ref": "#/components/schemas/Error"
|
|
14543
|
+
},
|
|
14544
|
+
"examples": {
|
|
14545
|
+
"exampleResponse": {
|
|
14546
|
+
"value": {
|
|
14547
|
+
"name": "UnauthorizedError",
|
|
14548
|
+
"message": "errorMessage"
|
|
14549
|
+
}
|
|
14550
|
+
}
|
|
14551
|
+
}
|
|
14552
|
+
}
|
|
14553
|
+
}
|
|
14554
|
+
},
|
|
14555
|
+
"500": {
|
|
14556
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
14557
|
+
"content": {
|
|
14558
|
+
"application/json": {
|
|
14559
|
+
"schema": {
|
|
14560
|
+
"$ref": "#/components/schemas/Error"
|
|
14561
|
+
},
|
|
14562
|
+
"examples": {
|
|
14563
|
+
"exampleResponse": {
|
|
14564
|
+
"value": {
|
|
14565
|
+
"name": "InternalServerError",
|
|
14566
|
+
"message": "errorMessage"
|
|
14567
|
+
}
|
|
14568
|
+
}
|
|
14569
|
+
}
|
|
14570
|
+
}
|
|
14571
|
+
}
|
|
14572
|
+
}
|
|
14573
|
+
}
|
|
14574
|
+
}
|
|
14575
|
+
},
|
|
14576
|
+
"/dataspace-control-plane/transfers/{pid}/complete": {
|
|
14577
|
+
"post": {
|
|
14578
|
+
"operationId": "completeTransfer",
|
|
14579
|
+
"summary": "Complete Transfer Process (DSP)",
|
|
14580
|
+
"tags": [
|
|
14581
|
+
"Transfer Process"
|
|
14582
|
+
],
|
|
14583
|
+
"parameters": [
|
|
14584
|
+
{
|
|
14585
|
+
"name": "pid",
|
|
14586
|
+
"description": "",
|
|
14587
|
+
"in": "path",
|
|
14588
|
+
"required": true,
|
|
14589
|
+
"schema": {
|
|
14590
|
+
"type": "string"
|
|
14591
|
+
},
|
|
14592
|
+
"style": "simple"
|
|
14593
|
+
}
|
|
14594
|
+
],
|
|
14595
|
+
"security": [
|
|
14596
|
+
{
|
|
14597
|
+
"jwtBearerAuthScheme": []
|
|
14598
|
+
}
|
|
14599
|
+
],
|
|
14600
|
+
"responses": {
|
|
14601
|
+
"200": {
|
|
14602
|
+
"description": "The rest request ended in success with no data.",
|
|
14603
|
+
"content": {
|
|
14604
|
+
"text/plain": {
|
|
14605
|
+
"schema": {
|
|
14606
|
+
"$ref": "#/components/schemas/OkResponse"
|
|
14607
|
+
}
|
|
14608
|
+
}
|
|
14609
|
+
}
|
|
14610
|
+
},
|
|
14611
|
+
"400": {
|
|
14612
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
14613
|
+
"content": {
|
|
14614
|
+
"application/json": {
|
|
14615
|
+
"schema": {
|
|
14616
|
+
"$ref": "#/components/schemas/Error"
|
|
14617
|
+
},
|
|
14618
|
+
"examples": {
|
|
14619
|
+
"exampleResponse": {
|
|
14620
|
+
"value": {
|
|
14621
|
+
"name": "GeneralError",
|
|
14622
|
+
"message": "errorMessage",
|
|
14623
|
+
"properties": {
|
|
14624
|
+
"foo": "bar"
|
|
14625
|
+
}
|
|
14626
|
+
}
|
|
14627
|
+
}
|
|
14628
|
+
}
|
|
14629
|
+
}
|
|
14630
|
+
}
|
|
14631
|
+
},
|
|
14632
|
+
"401": {
|
|
14633
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
14634
|
+
"content": {
|
|
14635
|
+
"application/json": {
|
|
14636
|
+
"schema": {
|
|
14637
|
+
"$ref": "#/components/schemas/Error"
|
|
14638
|
+
},
|
|
14639
|
+
"examples": {
|
|
14640
|
+
"exampleResponse": {
|
|
14641
|
+
"value": {
|
|
14642
|
+
"name": "UnauthorizedError",
|
|
14643
|
+
"message": "errorMessage"
|
|
14644
|
+
}
|
|
14645
|
+
}
|
|
14646
|
+
}
|
|
14647
|
+
}
|
|
14648
|
+
}
|
|
14649
|
+
},
|
|
14650
|
+
"500": {
|
|
14651
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
14652
|
+
"content": {
|
|
14653
|
+
"application/json": {
|
|
14654
|
+
"schema": {
|
|
14655
|
+
"$ref": "#/components/schemas/Error"
|
|
14656
|
+
},
|
|
14657
|
+
"examples": {
|
|
14658
|
+
"exampleResponse": {
|
|
14659
|
+
"value": {
|
|
14660
|
+
"name": "InternalServerError",
|
|
14661
|
+
"message": "errorMessage"
|
|
14662
|
+
}
|
|
14663
|
+
}
|
|
14664
|
+
}
|
|
14665
|
+
}
|
|
14666
|
+
}
|
|
14667
|
+
}
|
|
14668
|
+
}
|
|
14669
|
+
}
|
|
14670
|
+
},
|
|
14671
|
+
"/dataspace-control-plane/transfers/{pid}/suspend": {
|
|
14672
|
+
"post": {
|
|
14673
|
+
"operationId": "suspendTransfer",
|
|
14674
|
+
"summary": "Suspend Transfer Process (DSP)",
|
|
14675
|
+
"tags": [
|
|
14676
|
+
"Transfer Process"
|
|
14677
|
+
],
|
|
14678
|
+
"parameters": [
|
|
14679
|
+
{
|
|
14680
|
+
"name": "pid",
|
|
14681
|
+
"description": "",
|
|
14682
|
+
"in": "path",
|
|
14683
|
+
"required": true,
|
|
14684
|
+
"schema": {
|
|
14685
|
+
"type": "string"
|
|
14686
|
+
},
|
|
14687
|
+
"style": "simple"
|
|
14688
|
+
}
|
|
14689
|
+
],
|
|
14690
|
+
"security": [
|
|
14691
|
+
{
|
|
14692
|
+
"jwtBearerAuthScheme": []
|
|
14693
|
+
}
|
|
14694
|
+
],
|
|
14695
|
+
"responses": {
|
|
14696
|
+
"200": {
|
|
14697
|
+
"description": "The rest request ended in success with no data.",
|
|
14698
|
+
"content": {
|
|
14699
|
+
"text/plain": {
|
|
14700
|
+
"schema": {
|
|
14701
|
+
"$ref": "#/components/schemas/OkResponse"
|
|
14702
|
+
}
|
|
14703
|
+
}
|
|
14704
|
+
}
|
|
14705
|
+
},
|
|
14706
|
+
"400": {
|
|
14707
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
14708
|
+
"content": {
|
|
14709
|
+
"application/json": {
|
|
14710
|
+
"schema": {
|
|
14711
|
+
"$ref": "#/components/schemas/Error"
|
|
14712
|
+
},
|
|
14713
|
+
"examples": {
|
|
14714
|
+
"exampleResponse": {
|
|
14715
|
+
"value": {
|
|
14716
|
+
"name": "GeneralError",
|
|
14717
|
+
"message": "errorMessage",
|
|
14718
|
+
"properties": {
|
|
14719
|
+
"foo": "bar"
|
|
14720
|
+
}
|
|
14721
|
+
}
|
|
14722
|
+
}
|
|
14723
|
+
}
|
|
14724
|
+
}
|
|
14725
|
+
}
|
|
14726
|
+
},
|
|
14727
|
+
"401": {
|
|
14728
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
14729
|
+
"content": {
|
|
14730
|
+
"application/json": {
|
|
14731
|
+
"schema": {
|
|
14732
|
+
"$ref": "#/components/schemas/Error"
|
|
14733
|
+
},
|
|
14734
|
+
"examples": {
|
|
14735
|
+
"exampleResponse": {
|
|
14736
|
+
"value": {
|
|
14737
|
+
"name": "UnauthorizedError",
|
|
14738
|
+
"message": "errorMessage"
|
|
14739
|
+
}
|
|
14740
|
+
}
|
|
14741
|
+
}
|
|
14742
|
+
}
|
|
14743
|
+
}
|
|
14744
|
+
},
|
|
14745
|
+
"500": {
|
|
14746
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
14747
|
+
"content": {
|
|
14748
|
+
"application/json": {
|
|
14749
|
+
"schema": {
|
|
14750
|
+
"$ref": "#/components/schemas/Error"
|
|
14751
|
+
},
|
|
14752
|
+
"examples": {
|
|
14753
|
+
"exampleResponse": {
|
|
14754
|
+
"value": {
|
|
14755
|
+
"name": "InternalServerError",
|
|
14756
|
+
"message": "errorMessage"
|
|
14757
|
+
}
|
|
14758
|
+
}
|
|
14759
|
+
}
|
|
14760
|
+
}
|
|
14761
|
+
}
|
|
14762
|
+
}
|
|
14763
|
+
}
|
|
14764
|
+
}
|
|
14765
|
+
},
|
|
14766
|
+
"/dataspace-control-plane/transfers/{pid}/terminate": {
|
|
14767
|
+
"post": {
|
|
14768
|
+
"operationId": "terminateTransfer",
|
|
14769
|
+
"summary": "Terminate Transfer Process (DSP)",
|
|
14770
|
+
"tags": [
|
|
14771
|
+
"Transfer Process"
|
|
14772
|
+
],
|
|
14773
|
+
"parameters": [
|
|
14774
|
+
{
|
|
14775
|
+
"name": "pid",
|
|
14776
|
+
"description": "",
|
|
14777
|
+
"in": "path",
|
|
14778
|
+
"required": true,
|
|
14779
|
+
"schema": {
|
|
14780
|
+
"type": "string"
|
|
14781
|
+
},
|
|
14782
|
+
"style": "simple"
|
|
14783
|
+
}
|
|
14784
|
+
],
|
|
14785
|
+
"security": [
|
|
14786
|
+
{
|
|
14787
|
+
"jwtBearerAuthScheme": []
|
|
14788
|
+
}
|
|
14789
|
+
],
|
|
14790
|
+
"responses": {
|
|
14791
|
+
"200": {
|
|
14792
|
+
"description": "The rest request ended in success with no data.",
|
|
14793
|
+
"content": {
|
|
14794
|
+
"text/plain": {
|
|
14795
|
+
"schema": {
|
|
14796
|
+
"$ref": "#/components/schemas/OkResponse"
|
|
14797
|
+
}
|
|
14798
|
+
}
|
|
14799
|
+
}
|
|
14800
|
+
},
|
|
14801
|
+
"400": {
|
|
14802
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
14803
|
+
"content": {
|
|
14804
|
+
"application/json": {
|
|
14805
|
+
"schema": {
|
|
14806
|
+
"$ref": "#/components/schemas/Error"
|
|
14807
|
+
},
|
|
14808
|
+
"examples": {
|
|
14809
|
+
"exampleResponse": {
|
|
14810
|
+
"value": {
|
|
14811
|
+
"name": "GeneralError",
|
|
14812
|
+
"message": "errorMessage",
|
|
14813
|
+
"properties": {
|
|
14814
|
+
"foo": "bar"
|
|
14815
|
+
}
|
|
14816
|
+
}
|
|
14817
|
+
}
|
|
14818
|
+
}
|
|
14819
|
+
}
|
|
14820
|
+
}
|
|
14821
|
+
},
|
|
14822
|
+
"401": {
|
|
14823
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
14824
|
+
"content": {
|
|
14825
|
+
"application/json": {
|
|
14826
|
+
"schema": {
|
|
14827
|
+
"$ref": "#/components/schemas/Error"
|
|
14828
|
+
},
|
|
14829
|
+
"examples": {
|
|
14830
|
+
"exampleResponse": {
|
|
14831
|
+
"value": {
|
|
14832
|
+
"name": "UnauthorizedError",
|
|
14833
|
+
"message": "errorMessage"
|
|
14834
|
+
}
|
|
14835
|
+
}
|
|
14836
|
+
}
|
|
14837
|
+
}
|
|
14838
|
+
}
|
|
14839
|
+
},
|
|
14840
|
+
"500": {
|
|
14841
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
14842
|
+
"content": {
|
|
14843
|
+
"application/json": {
|
|
14844
|
+
"schema": {
|
|
14845
|
+
"$ref": "#/components/schemas/Error"
|
|
14846
|
+
},
|
|
14847
|
+
"examples": {
|
|
14848
|
+
"exampleResponse": {
|
|
14849
|
+
"value": {
|
|
14850
|
+
"name": "InternalServerError",
|
|
14851
|
+
"message": "errorMessage"
|
|
14852
|
+
}
|
|
14853
|
+
}
|
|
14854
|
+
}
|
|
14855
|
+
}
|
|
14856
|
+
}
|
|
14857
|
+
}
|
|
14858
|
+
}
|
|
14859
|
+
}
|
|
14860
|
+
},
|
|
14861
|
+
"/rights-management/policy/admin": {
|
|
14862
|
+
"post": {
|
|
14863
|
+
"operationId": "papCreate",
|
|
14864
|
+
"summary": "Create a policy",
|
|
14865
|
+
"tags": [
|
|
14866
|
+
"Policy Administration Point"
|
|
14867
|
+
],
|
|
14868
|
+
"security": [
|
|
14869
|
+
{
|
|
14870
|
+
"jwtBearerAuthScheme": []
|
|
14871
|
+
}
|
|
14872
|
+
],
|
|
14873
|
+
"requestBody": {
|
|
14874
|
+
"description": "The request structure for creating a policy.",
|
|
14875
|
+
"required": true,
|
|
14876
|
+
"content": {
|
|
14877
|
+
"application/json": {
|
|
14878
|
+
"schema": {
|
|
14879
|
+
"$ref": "#/components/schemas/PapCreateRequest"
|
|
14880
|
+
},
|
|
14881
|
+
"examples": {
|
|
14882
|
+
"papCreateRequestExample": {
|
|
14883
|
+
"value": {
|
|
14884
|
+
"@context": "http://www.w3.org/ns/odrl.jsonld",
|
|
14885
|
+
"@type": "Set",
|
|
14886
|
+
"permission": [
|
|
14887
|
+
{
|
|
14888
|
+
"target": "http://example.com/asset/1",
|
|
14889
|
+
"action": "use"
|
|
14890
|
+
}
|
|
14891
|
+
]
|
|
14892
|
+
}
|
|
14893
|
+
}
|
|
14894
|
+
}
|
|
14895
|
+
}
|
|
14896
|
+
}
|
|
14897
|
+
},
|
|
14898
|
+
"responses": {
|
|
14899
|
+
"201": {
|
|
14900
|
+
"description": "The rest request ended in created response.",
|
|
14901
|
+
"headers": {
|
|
14902
|
+
"location": {
|
|
14903
|
+
"schema": {
|
|
14904
|
+
"type": "string"
|
|
14905
|
+
},
|
|
14906
|
+
"description": "e.g. urn:rights-management:abc123def456"
|
|
14907
|
+
}
|
|
14908
|
+
}
|
|
14909
|
+
},
|
|
14910
|
+
"400": {
|
|
14911
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
14912
|
+
"content": {
|
|
14913
|
+
"application/json": {
|
|
14914
|
+
"schema": {
|
|
14915
|
+
"$ref": "#/components/schemas/Error"
|
|
14916
|
+
},
|
|
14917
|
+
"examples": {
|
|
14918
|
+
"exampleResponse": {
|
|
14919
|
+
"value": {
|
|
14920
|
+
"name": "GeneralError",
|
|
14921
|
+
"message": "errorMessage",
|
|
14922
|
+
"properties": {
|
|
14923
|
+
"foo": "bar"
|
|
14924
|
+
}
|
|
14925
|
+
}
|
|
14926
|
+
}
|
|
14927
|
+
}
|
|
14928
|
+
}
|
|
14929
|
+
}
|
|
14930
|
+
},
|
|
14931
|
+
"401": {
|
|
14932
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
14933
|
+
"content": {
|
|
14934
|
+
"application/json": {
|
|
14935
|
+
"schema": {
|
|
14936
|
+
"$ref": "#/components/schemas/Error"
|
|
14937
|
+
},
|
|
14938
|
+
"examples": {
|
|
14939
|
+
"exampleResponse": {
|
|
14940
|
+
"value": {
|
|
14941
|
+
"name": "UnauthorizedError",
|
|
14942
|
+
"message": "errorMessage"
|
|
14943
|
+
}
|
|
14944
|
+
}
|
|
14945
|
+
}
|
|
14946
|
+
}
|
|
14947
|
+
}
|
|
14948
|
+
},
|
|
14949
|
+
"500": {
|
|
14950
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
14951
|
+
"content": {
|
|
14952
|
+
"application/json": {
|
|
14953
|
+
"schema": {
|
|
14954
|
+
"$ref": "#/components/schemas/Error"
|
|
14955
|
+
},
|
|
14956
|
+
"examples": {
|
|
14957
|
+
"exampleResponse": {
|
|
14958
|
+
"value": {
|
|
14959
|
+
"name": "InternalServerError",
|
|
14960
|
+
"message": "errorMessage"
|
|
14961
|
+
}
|
|
14962
|
+
}
|
|
14963
|
+
}
|
|
14964
|
+
}
|
|
14965
|
+
}
|
|
14966
|
+
}
|
|
14967
|
+
}
|
|
14968
|
+
},
|
|
14969
|
+
"get": {
|
|
14970
|
+
"operationId": "papQuery",
|
|
14971
|
+
"summary": "Query policies",
|
|
14972
|
+
"tags": [
|
|
14973
|
+
"Policy Administration Point"
|
|
14974
|
+
],
|
|
14975
|
+
"parameters": [
|
|
14976
|
+
{
|
|
14977
|
+
"name": "assigner",
|
|
14978
|
+
"description": "The assigner to filter by.",
|
|
14979
|
+
"in": "query",
|
|
14980
|
+
"required": false,
|
|
14981
|
+
"schema": {
|
|
14982
|
+
"type": "string"
|
|
14983
|
+
}
|
|
14984
|
+
},
|
|
14985
|
+
{
|
|
14986
|
+
"name": "assignee",
|
|
14987
|
+
"description": "The assignee to filter by.",
|
|
14988
|
+
"in": "query",
|
|
14989
|
+
"required": false,
|
|
14990
|
+
"schema": {
|
|
14991
|
+
"type": "string"
|
|
14992
|
+
}
|
|
14993
|
+
},
|
|
14994
|
+
{
|
|
14995
|
+
"name": "action",
|
|
14996
|
+
"description": "The action to filter by.",
|
|
14997
|
+
"in": "query",
|
|
14998
|
+
"required": false,
|
|
14999
|
+
"schema": {
|
|
15000
|
+
"type": "string"
|
|
15001
|
+
}
|
|
15002
|
+
},
|
|
15003
|
+
{
|
|
15004
|
+
"name": "target",
|
|
15005
|
+
"description": "The target to filter by.",
|
|
15006
|
+
"in": "query",
|
|
15007
|
+
"required": false,
|
|
15008
|
+
"schema": {
|
|
15009
|
+
"type": "string"
|
|
15010
|
+
}
|
|
15011
|
+
},
|
|
15012
|
+
{
|
|
15013
|
+
"name": "conditions",
|
|
15014
|
+
"description": "The condition for the query.",
|
|
15015
|
+
"in": "query",
|
|
15016
|
+
"required": false,
|
|
15017
|
+
"schema": {
|
|
15018
|
+
"type": "string"
|
|
15019
|
+
}
|
|
15020
|
+
},
|
|
15021
|
+
{
|
|
15022
|
+
"name": "limit",
|
|
15023
|
+
"description": "Limit the number of entities to return.",
|
|
15024
|
+
"in": "query",
|
|
15025
|
+
"required": false,
|
|
15026
|
+
"schema": {
|
|
15027
|
+
"type": "string"
|
|
15028
|
+
}
|
|
15029
|
+
},
|
|
15030
|
+
{
|
|
15031
|
+
"name": "cursor",
|
|
15032
|
+
"description": "The cursor to get next chunk of data, returned in previous response.",
|
|
15033
|
+
"in": "query",
|
|
15034
|
+
"required": false,
|
|
15035
|
+
"schema": {
|
|
15036
|
+
"type": "string"
|
|
15037
|
+
},
|
|
15038
|
+
"example": "optional-pagination-cursor"
|
|
15039
|
+
}
|
|
15040
|
+
],
|
|
15041
|
+
"security": [
|
|
15042
|
+
{
|
|
15043
|
+
"jwtBearerAuthScheme": []
|
|
15044
|
+
}
|
|
15045
|
+
],
|
|
15046
|
+
"responses": {
|
|
15047
|
+
"200": {
|
|
15048
|
+
"description": "The response structure for querying policies.",
|
|
15049
|
+
"content": {
|
|
15050
|
+
"application/json": {
|
|
15051
|
+
"schema": {
|
|
15052
|
+
"$ref": "#/components/schemas/PapQueryResponse"
|
|
15053
|
+
},
|
|
15054
|
+
"examples": {
|
|
15055
|
+
"papQueryResponseExample": {
|
|
15056
|
+
"value": [
|
|
15057
|
+
{
|
|
15058
|
+
"@context": "http://www.w3.org/ns/odrl.jsonld",
|
|
15059
|
+
"@type": "Set",
|
|
15060
|
+
"uid": "urn:rights-management:abc123def456",
|
|
15061
|
+
"permission": [
|
|
15062
|
+
{
|
|
15063
|
+
"target": "http://example.com/asset/1",
|
|
15064
|
+
"action": "use"
|
|
15065
|
+
}
|
|
15066
|
+
]
|
|
15067
|
+
}
|
|
15068
|
+
]
|
|
15069
|
+
}
|
|
15070
|
+
}
|
|
15071
|
+
}
|
|
15072
|
+
}
|
|
15073
|
+
},
|
|
15074
|
+
"400": {
|
|
15075
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
15076
|
+
"content": {
|
|
15077
|
+
"application/json": {
|
|
15078
|
+
"schema": {
|
|
15079
|
+
"$ref": "#/components/schemas/Error"
|
|
15080
|
+
},
|
|
15081
|
+
"examples": {
|
|
15082
|
+
"exampleResponse": {
|
|
15083
|
+
"value": {
|
|
15084
|
+
"name": "GeneralError",
|
|
15085
|
+
"message": "errorMessage",
|
|
15086
|
+
"properties": {
|
|
15087
|
+
"foo": "bar"
|
|
15088
|
+
}
|
|
15089
|
+
}
|
|
15090
|
+
}
|
|
15091
|
+
}
|
|
15092
|
+
}
|
|
15093
|
+
}
|
|
15094
|
+
},
|
|
15095
|
+
"401": {
|
|
15096
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
15097
|
+
"content": {
|
|
15098
|
+
"application/json": {
|
|
15099
|
+
"schema": {
|
|
15100
|
+
"$ref": "#/components/schemas/Error"
|
|
15101
|
+
},
|
|
15102
|
+
"examples": {
|
|
15103
|
+
"exampleResponse": {
|
|
15104
|
+
"value": {
|
|
15105
|
+
"name": "UnauthorizedError",
|
|
15106
|
+
"message": "errorMessage"
|
|
15107
|
+
}
|
|
15108
|
+
}
|
|
15109
|
+
}
|
|
15110
|
+
}
|
|
15111
|
+
}
|
|
15112
|
+
},
|
|
15113
|
+
"500": {
|
|
15114
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
15115
|
+
"content": {
|
|
15116
|
+
"application/json": {
|
|
15117
|
+
"schema": {
|
|
15118
|
+
"$ref": "#/components/schemas/Error"
|
|
15119
|
+
},
|
|
15120
|
+
"examples": {
|
|
15121
|
+
"exampleResponse": {
|
|
15122
|
+
"value": {
|
|
15123
|
+
"name": "InternalServerError",
|
|
15124
|
+
"message": "errorMessage"
|
|
15125
|
+
}
|
|
15126
|
+
}
|
|
15127
|
+
}
|
|
15128
|
+
}
|
|
15129
|
+
}
|
|
15130
|
+
}
|
|
15131
|
+
}
|
|
15132
|
+
}
|
|
15133
|
+
},
|
|
15134
|
+
"/rights-management/policy/admin/{id}": {
|
|
15135
|
+
"put": {
|
|
15136
|
+
"operationId": "papUpdate",
|
|
15137
|
+
"summary": "Update a policy",
|
|
15138
|
+
"tags": [
|
|
15139
|
+
"Policy Administration Point"
|
|
15140
|
+
],
|
|
15141
|
+
"parameters": [
|
|
15142
|
+
{
|
|
15143
|
+
"name": "id",
|
|
15144
|
+
"description": "The ID of the policy to update.",
|
|
15145
|
+
"in": "path",
|
|
15146
|
+
"required": true,
|
|
15147
|
+
"schema": {
|
|
15148
|
+
"type": "string"
|
|
15149
|
+
},
|
|
15150
|
+
"style": "simple",
|
|
15151
|
+
"example": "urn:rights-management:abc123def456"
|
|
15152
|
+
}
|
|
15153
|
+
],
|
|
15154
|
+
"security": [
|
|
15155
|
+
{
|
|
15156
|
+
"jwtBearerAuthScheme": []
|
|
15157
|
+
}
|
|
15158
|
+
],
|
|
15159
|
+
"requestBody": {
|
|
15160
|
+
"description": "The request structure for updating a policy.",
|
|
15161
|
+
"required": true,
|
|
15162
|
+
"content": {
|
|
15163
|
+
"application/json": {
|
|
15164
|
+
"schema": {
|
|
15165
|
+
"$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
|
|
15166
|
+
},
|
|
15167
|
+
"examples": {
|
|
15168
|
+
"papUpdateRequestExample": {
|
|
15169
|
+
"value": {
|
|
15170
|
+
"@context": "http://www.w3.org/ns/odrl.jsonld",
|
|
15171
|
+
"@type": "Set",
|
|
15172
|
+
"uid": "urn:rights-management:abc123def456",
|
|
15173
|
+
"permission": [
|
|
15174
|
+
{
|
|
15175
|
+
"target": "http://example.com/asset/2",
|
|
15176
|
+
"action": "read"
|
|
15177
|
+
}
|
|
15178
|
+
]
|
|
15179
|
+
}
|
|
15180
|
+
}
|
|
15181
|
+
}
|
|
15182
|
+
}
|
|
15183
|
+
}
|
|
14718
15184
|
},
|
|
14719
15185
|
"responses": {
|
|
14720
15186
|
"204": {
|
|
@@ -16393,7 +16859,8 @@
|
|
|
16393
16859
|
"id": "pid",
|
|
16394
16860
|
"correlationId": "cid",
|
|
16395
16861
|
"dateCreated": "2025-09-03T00:00:00.000Z",
|
|
16396
|
-
"state": "REQUESTED"
|
|
16862
|
+
"state": "REQUESTED",
|
|
16863
|
+
"organizationIdentity": "did:iota:123456789abcdefghi"
|
|
16397
16864
|
}
|
|
16398
16865
|
}
|
|
16399
16866
|
}
|
|
@@ -16497,7 +16964,8 @@
|
|
|
16497
16964
|
"id": "pid",
|
|
16498
16965
|
"correlationId": "cid",
|
|
16499
16966
|
"dateCreated": "2025-09-03T00:00:00.000Z",
|
|
16500
|
-
"state": "REQUESTED"
|
|
16967
|
+
"state": "REQUESTED",
|
|
16968
|
+
"organizationIdentity": "did:iota:123456789abcdefghi"
|
|
16501
16969
|
}
|
|
16502
16970
|
}
|
|
16503
16971
|
}
|
|
@@ -16704,7 +17172,8 @@
|
|
|
16704
17172
|
"id": "pid",
|
|
16705
17173
|
"correlationId": "cid",
|
|
16706
17174
|
"dateCreated": "2025-09-03T00:00:00.000Z",
|
|
16707
|
-
"state": "REQUESTED"
|
|
17175
|
+
"state": "REQUESTED",
|
|
17176
|
+
"organizationIdentity": "did:iota:123456789abcdefghi"
|
|
16708
17177
|
}
|
|
16709
17178
|
]
|
|
16710
17179
|
}
|
|
@@ -16830,13 +17299,13 @@
|
|
|
16830
17299
|
"type": "string",
|
|
16831
17300
|
"description": "Task Id."
|
|
16832
17301
|
},
|
|
16833
|
-
"
|
|
17302
|
+
"dataspaceAppId": {
|
|
16834
17303
|
"type": "string",
|
|
16835
|
-
"description": "
|
|
17304
|
+
"description": "Dataspace App Id."
|
|
16836
17305
|
}
|
|
16837
17306
|
},
|
|
16838
17307
|
"required": [
|
|
16839
|
-
"
|
|
17308
|
+
"dataspaceAppId",
|
|
16840
17309
|
"startDate",
|
|
16841
17310
|
"taskId"
|
|
16842
17311
|
]
|
|
@@ -16865,13 +17334,13 @@
|
|
|
16865
17334
|
"type": "string",
|
|
16866
17335
|
"description": "Task Id."
|
|
16867
17336
|
},
|
|
16868
|
-
"
|
|
17337
|
+
"dataspaceAppId": {
|
|
16869
17338
|
"type": "string",
|
|
16870
|
-
"description": "
|
|
17339
|
+
"description": "Dataspace App Id."
|
|
16871
17340
|
}
|
|
16872
17341
|
},
|
|
16873
17342
|
"required": [
|
|
16874
|
-
"
|
|
17343
|
+
"dataspaceAppId",
|
|
16875
17344
|
"result",
|
|
16876
17345
|
"startDate",
|
|
16877
17346
|
"taskId"
|
|
@@ -16892,13 +17361,13 @@
|
|
|
16892
17361
|
"type": "string",
|
|
16893
17362
|
"description": "Task Id."
|
|
16894
17363
|
},
|
|
16895
|
-
"
|
|
17364
|
+
"dataspaceAppId": {
|
|
16896
17365
|
"type": "string",
|
|
16897
|
-
"description": "
|
|
17366
|
+
"description": "Dataspace App Id."
|
|
16898
17367
|
}
|
|
16899
17368
|
},
|
|
16900
17369
|
"required": [
|
|
16901
|
-
"
|
|
17370
|
+
"dataspaceAppId",
|
|
16902
17371
|
"error",
|
|
16903
17372
|
"taskId"
|
|
16904
17373
|
]
|
|
@@ -18356,19 +18825,6 @@
|
|
|
18356
18825
|
],
|
|
18357
18826
|
"description": "The body which contains the error."
|
|
18358
18827
|
},
|
|
18359
|
-
"DataAssetDescription": {
|
|
18360
|
-
"type": "object",
|
|
18361
|
-
"properties": {
|
|
18362
|
-
"dataSetId": {
|
|
18363
|
-
"type": "array",
|
|
18364
|
-
"items": {
|
|
18365
|
-
"type": "string"
|
|
18366
|
-
},
|
|
18367
|
-
"description": "The concerned datasets."
|
|
18368
|
-
}
|
|
18369
|
-
},
|
|
18370
|
-
"description": "The description of a Data Asset"
|
|
18371
|
-
},
|
|
18372
18828
|
"DataAssetItemList": {
|
|
18373
18829
|
"type": "object",
|
|
18374
18830
|
"properties": {
|
|
@@ -18400,15 +18856,16 @@
|
|
|
18400
18856
|
"DataAssetQueryRequest": {
|
|
18401
18857
|
"type": "object",
|
|
18402
18858
|
"properties": {
|
|
18403
|
-
"
|
|
18404
|
-
"
|
|
18859
|
+
"consumerPid": {
|
|
18860
|
+
"type": "string",
|
|
18861
|
+
"description": "The consumer Process ID from the DSP Transfer Process. Mandatory - used to determine the Dataset, Distribution, and Agreement. The datasetId is resolved from the Transfer Process using this ID."
|
|
18405
18862
|
},
|
|
18406
18863
|
"query": {
|
|
18407
18864
|
"$ref": "#/components/schemas/FilteringQuery"
|
|
18408
18865
|
}
|
|
18409
18866
|
},
|
|
18410
18867
|
"required": [
|
|
18411
|
-
"
|
|
18868
|
+
"consumerPid",
|
|
18412
18869
|
"query"
|
|
18413
18870
|
],
|
|
18414
18871
|
"description": "Request body containing the data asset and query criteria."
|
|
@@ -18656,7 +19113,7 @@
|
|
|
18656
19113
|
"type",
|
|
18657
19114
|
"q"
|
|
18658
19115
|
],
|
|
18659
|
-
"description": "A query over a data asset that to be processed by a
|
|
19116
|
+
"description": "A query over a data asset that to be processed by a Dataspace Data Plane App."
|
|
18660
19117
|
},
|
|
18661
19118
|
"GetDatasetResponse": {
|
|
18662
19119
|
"anyOf": [
|
|
@@ -19597,6 +20054,10 @@
|
|
|
19597
20054
|
"type": "string",
|
|
19598
20055
|
"description": "The callback address to send updates to the requester."
|
|
19599
20056
|
},
|
|
20057
|
+
"organizationIdentity": {
|
|
20058
|
+
"type": "string",
|
|
20059
|
+
"description": "Organization identity to be used when sending trust payloads."
|
|
20060
|
+
},
|
|
19600
20061
|
"offer": {
|
|
19601
20062
|
"$ref": "https://schema.twindev.org/w3c-odrl/OdrlOffer"
|
|
19602
20063
|
},
|
|
@@ -19648,6 +20109,9 @@
|
|
|
19648
20109
|
},
|
|
19649
20110
|
"description": "A more detailed reason for the negotiation error."
|
|
19650
20111
|
},
|
|
20112
|
+
"errorDetails": {
|
|
20113
|
+
"$ref": "#/components/schemas/Error"
|
|
20114
|
+
},
|
|
19651
20115
|
"handlerId": {
|
|
19652
20116
|
"type": "string",
|
|
19653
20117
|
"description": "The id of the handler, on provider side this is the negotiator, on consumer side this is the requester."
|
|
@@ -19661,7 +20125,8 @@
|
|
|
19661
20125
|
"id",
|
|
19662
20126
|
"correlationId",
|
|
19663
20127
|
"dateCreated",
|
|
19664
|
-
"state"
|
|
20128
|
+
"state",
|
|
20129
|
+
"organizationIdentity"
|
|
19665
20130
|
],
|
|
19666
20131
|
"description": "Interface describing a rights management policy negotiation."
|
|
19667
20132
|
},
|
|
@@ -19898,16 +20363,16 @@
|
|
|
19898
20363
|
"type": "string",
|
|
19899
20364
|
"description": "Task Id."
|
|
19900
20365
|
},
|
|
19901
|
-
"
|
|
20366
|
+
"dataspaceAppId": {
|
|
19902
20367
|
"type": "string",
|
|
19903
|
-
"description": "
|
|
20368
|
+
"description": "Dataspace App Id."
|
|
19904
20369
|
}
|
|
19905
20370
|
},
|
|
19906
20371
|
"required": [
|
|
19907
20372
|
"taskId",
|
|
19908
|
-
"
|
|
20373
|
+
"dataspaceAppId"
|
|
19909
20374
|
],
|
|
19910
|
-
"description": "Denotes a task associated with a
|
|
20375
|
+
"description": "Denotes a task associated with a Dataspace App"
|
|
19911
20376
|
},
|
|
19912
20377
|
"TelemetryAddMetricValueRequest": {
|
|
19913
20378
|
"type": "object",
|