Project

General

Profile

Files » Draft-2019-12-21-19512-Preservation-API-schema.json

14:18 - Detlef Hühnlein, 12/21/2019 02:19 PM

 
1
{
2
    "$schema": "http:\/\/json-schema.org\/draft-04\/schema#",
3
    "definitions": {
4
        "dsb-AnyType": {
5
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsb-AnyType"
6
        },
7
        "dsb-AttachmentReferenceType": {
8
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsb-AttachmentReferenceType"
9
        },
10
        "dsb-DigestInfoType": {
11
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsb-DigestInfoType"
12
        },
13
        "dsigrw-TransformsType": {
14
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsigrw-TransformsType"
15
        },
16
        "dsigrw-TransformType": {
17
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsigrw-TransformType"
18
        },
19
        "nsl-NsPrefixMappingType": {
20
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/nsl-NsPrefixMappingType"
21
        },
22
        "dsb-Base64DataType": {
23
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsb-Base64DataType"
24
        },
25
        "dsb-ResultType": {
26
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsb-ResultType"
27
        },
28
        "dsb-InternationalStringType": {
29
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsb-InternationalStringType"
30
        },
31
        "md-OperationType": {
32
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-md\/v1.0\/cs02\/schema\/oasis-dss-metadata-schema.json#\/definitions\/md-OperationType"
33
        },
34
        "md-ParameterType": {
35
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-md\/v1.0\/cs02\/schema\/oasis-dss-metadata-schema.json#\/definitions\/md-ParameterType"
36
        },
37
        "md-FormatType": {
38
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-md\/v1.0\/cs02\/schema\/oasis-dss-metadata-schema.json#\/definitions\/md-FormatType"
39
        },
40
        "md-ExtensionType": {
41
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-md\/v1.0\/cs02\/schema\/oasis-dss-metadata-schema.json#\/definitions\/md-ExtensionType"
42
        },
43
        "md-PolicyType": {
44
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-md\/v1.0\/cs02\/schema\/oasis-dss-metadata-schema.json#\/definitions\/md-PolicyType"
45
        },
46
        "md-PolicyByRefType": {
47
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-md\/v1.0\/cs02\/schema\/oasis-dss-metadata-schema.json#\/definitions\/md-PolicyByRefType"
48
        },
49
        "dsigrw-DigestMethodType": {
50
            "$ref": "http:\/\/docs.oasis-open.org\/dss-x\/dss-core\/v2.0\/cs02\/schema\/oasis-dss-core-schema.json#\/definitions\/dsigrw-DigestMethodType"
51
        },
52
        "dsb-OptionalInputsType": {
53
            "type": "object",
54
            "properties": {
55
                "policy": {
56
                    "type": "array",
57
                    "items": {
58
                        "type": "string"
59
                    }
60
                },
61
                "lang": {
62
                    "type": "string"
63
                },
64
                "other": {
65
                    "type": "array",
66
                    "items": {
67
                        "$ref": "#\/definitions\/dsb-AnyType"
68
                    }
69
                }
70
            }
71
        },
72
        "dsb-OptionalOutputsType": {
73
            "type": "object",
74
            "properties": {
75
                "policy": {
76
                    "type": "array",
77
                    "items": {
78
                        "type": "string"
79
                    }
80
                },
81
                "other": {
82
                    "type": "array",
83
                    "items": {
84
                        "$ref": "#\/definitions\/dsb-AnyType"
85
                    }
86
                }
87
            }
88
        },
89
        "pres-PreservePOType": {
90
            "type": "object",
91
            "properties": {
92
                "optIn": {
93
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
94
                },
95
                "reqId": {
96
                    "type": "string"
97
                },
98
                "pro": {
99
                    "type": "string"
100
                },
101
                "po": {
102
                    "type": "array",
103
                    "items": {
104
                        "$ref": "#\/definitions\/pres-POType"
105
                    }
106
                }
107
            },
108
            "required": ["pro"]
109
        },
110
        "pres-POType": {
111
            "type": "object",
112
            "properties": {
113
                "binaryData": {
114
                    "$ref": "#\/definitions\/pres-POType:BinaryData"
115
                },
116
                "xmlData": {
117
                    "$ref": "#\/definitions\/pres-POType:XmlData"
118
                },
119
                "formatId": {
120
                    "type": "string"
121
                },
122
                "mimeType": {
123
                    "type": "string"
124
                },
125
                "pronomId": {
126
                    "type": "string"
127
                },
128
                "id": {
129
                    "type": "string"
130
                },
131
                "relObj": {
132
                    "type": "array",
133
                    "items": {
134
                        "type": "string"
135
                    }
136
                }
137
            },
138
            "minProperties": 1
139
        },
140
        "pres-POType:BinaryData": {
141
            "type": "object",
142
            "properties": {
143
                "b64Content": {
144
                    "type": "string"
145
                }
146
            }
147
        },
148
        "pres-POType:XmlData": {
149
            "type": "object",
150
            "properties": {
151
                "b64Content": {
152
                    "type": "string"
153
                }
154
            }
155
        },
156
        "pres-PreservePOResponseType": {
157
            "type": "object",
158
            "properties": {
159
                "optOut": {
160
                    "$ref": "#\/definitions\/dsb-OptionalOutputsType"
161
                },
162
                "result": {
163
                    "$ref": "#\/definitions\/dsb-ResultType"
164
                },
165
                "reqId": {
166
                    "type": "string"
167
                },
168
                "poId": {
169
                    "type": "string"
170
                },
171
                "po": {
172
                    "type": "array",
173
                    "items": {
174
                        "$ref": "#\/definitions\/pres-POType"
175
                    }
176
                }
177
            }
178
        },
179
        "pres-UpdatePOCType": {
180
            "type": "object",
181
            "properties": {
182
                "optIn": {
183
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
184
                },
185
                "reqId": {
186
                    "type": "string"
187
                },
188
                "poId": {
189
                    "type": "string"
190
                },
191
                "deltaPoc": {
192
                    "type": "array",
193
                    "items": {
194
                        "$ref": "#\/definitions\/pres-POType"
195
                    }
196
                }
197
            },
198
            "required": ["poId", "deltaPoc"]
199
        },
200
        "pres-UpdatePOCResponseType": {
201
            "type": "object",
202
            "properties": {
203
                "optOut": {
204
                    "$ref": "#\/definitions\/dsb-OptionalOutputsType"
205
                },
206
                "result": {
207
                    "$ref": "#\/definitions\/dsb-ResultType"
208
                },
209
                "reqId": {
210
                    "type": "string"
211
                },
212
                "versionId": {
213
                    "type": "string"
214
                }
215
            }
216
        },
217
        "pres-RetrievePOType": {
218
            "type": "object",
219
            "properties": {
220
                "optIn": {
221
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
222
                },
223
                "reqId": {
224
                    "type": "string"
225
                },
226
                "poId": {
227
                    "type": "string"
228
                },
229
                "versionId": {
230
                    "type": "array",
231
                    "items": {
232
                        "type": "string"
233
                    }
234
                },
235
                "sor": {
236
                    "type": "string"
237
                },
238
                "poFormat": {
239
                    "type": "string"
240
                },
241
                "evFormat": {
242
                    "type": "string"
243
                }
244
            },
245
            "required": ["poId"]
246
        },
247
        "pres-RetrievePOResponseType": {
248
            "type": "object",
249
            "properties": {
250
                "optOut": {
251
                    "$ref": "#\/definitions\/dsb-OptionalOutputsType"
252
                },
253
                "result": {
254
                    "$ref": "#\/definitions\/dsb-ResultType"
255
                },
256
                "reqId": {
257
                    "type": "string"
258
                },
259
                "po": {
260
                    "type": "array",
261
                    "items": {
262
                        "$ref": "#\/definitions\/pres-POType"
263
                    }
264
                }
265
            }
266
        },
267
        "pres-DeletePOType": {
268
            "type": "object",
269
            "properties": {
270
                "optIn": {
271
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
272
                },
273
                "reqId": {
274
                    "type": "string"
275
                },
276
                "poId": {
277
                    "type": "string"
278
                },
279
                "mod": {
280
                    "type": "string"
281
                },
282
                "crn": {
283
                    "type": "string"
284
                },
285
                "reason": {
286
                    "type": "string"
287
                }
288
            },
289
            "required": ["poId"]
290
        },
291
        "pres-ResponseType": {
292
            "type": "object",
293
            "properties": {
294
                "optOut": {
295
                    "$ref": "#\/definitions\/dsb-OptionalOutputsType"
296
                },
297
                "result": {
298
                    "$ref": "#\/definitions\/dsb-ResultType"
299
                },
300
                "reqId": {
301
                    "type": "string"
302
                }
303
            },
304
            "required": ["result"]
305
        },
306
        "pres-RetrieveTraceType": {
307
            "type": "object",
308
            "properties": {
309
                "optIn": {
310
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
311
                },
312
                "reqId": {
313
                    "type": "string"
314
                },
315
                "poId": {
316
                    "type": "string"
317
                }
318
            },
319
            "required": ["poId"]
320
        },
321
        "pres-RetrieveTraceResponseType": {
322
            "type": "object",
323
            "properties": {
324
                "optOut": {
325
                    "$ref": "#\/definitions\/dsb-OptionalOutputsType"
326
                },
327
                "result": {
328
                    "$ref": "#\/definitions\/dsb-ResultType"
329
                },
330
                "reqId": {
331
                    "type": "string"
332
                },
333
                "trace": {
334
                    "$ref": "#\/definitions\/pres-TraceType"
335
                }
336
            },
337
            "required": ["trace"]
338
        },
339
        "pres-TraceType": {
340
            "type": "object",
341
            "properties": {
342
                "event": {
343
                    "type": "array",
344
                    "items": {
345
                        "$ref": "#\/definitions\/pres-EventType"
346
                    }
347
                }
348
            }
349
        },
350
        "pres-EventType": {
351
            "type": "object",
352
            "properties": {
353
                "time": {
354
                    "type": "string",
355
                    "format": "date-time"
356
                },
357
                "sub": {
358
                    "type": "string"
359
                },
360
                "op": {
361
                    "type": "string"
362
                },
363
                "obj": {
364
                    "type": "string"
365
                },
366
                "det": {
367
                    "type": "string"
368
                }
369
            },
370
            "required": ["time", "sub", "op"]
371
        },
372
        "pres-ValidateEvidenceType": {
373
            "type": "object",
374
            "properties": {
375
                "optIn": {
376
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
377
                },
378
                "reqId": {
379
                    "type": "string"
380
                },
381
                "ev": {
382
                    "$ref": "#\/definitions\/pres-EvidenceType"
383
                },
384
                "po": {
385
                    "type": "array",
386
                    "items": {
387
                        "$ref": "#\/definitions\/pres-POType"
388
                    }
389
                }
390
            }
391
        },
392
        "pres-EvidenceType": {
393
            "type": "object",
394
            "properties": {
395
                "binaryData": {
396
                    "$ref": "#\/definitions\/pres-POType:BinaryData"
397
                },
398
                "xmlData": {
399
                    "$ref": "#\/definitions\/pres-POType:XmlData"
400
                },
401
                "formatId": {
402
                    "type": "string"
403
                },
404
                "mimeType": {
405
                    "type": "string"
406
                },
407
                "pronomId": {
408
                    "type": "string"
409
                },
410
                "id": {
411
                    "type": "string"
412
                },
413
                "relObj": {
414
                    "type": "array",
415
                    "items": {
416
                        "type": "string"
417
                    }
418
                },
419
                "poId": {
420
                    "type": "string"
421
                },
422
                "verId": {
423
                    "type": "string"
424
                }
425
            }
426
        },
427
        "pres-ValidateEvidenceResponseType": {
428
            "type": "object",
429
            "properties": {
430
                "optOut": {
431
                    "$ref": "#\/definitions\/dsb-OptionalOutputsType"
432
                },
433
                "result": {
434
                    "$ref": "#\/definitions\/dsb-ResultType"
435
                },
436
                "reqId": {
437
                    "type": "string"
438
                },
439
                "valRep": {
440
                    "$ref": "#\/definitions\/pres-POType"
441
                },
442
                "poe": {
443
                    "type": "string",
444
                    "format": "date-time"
445
                }
446
            }
447
        },
448
        "pres-ProfileType": {
449
            "type": "object",
450
            "properties": {
451
                "pid": {
452
                    "type": "string"
453
                },
454
                "spec": {
455
                    "type": "array",
456
                    "items": {
457
                        "type": "string"
458
                    }
459
                },
460
                "description": {
461
                    "type": "array",
462
                    "items": {
463
                        "$ref": "#\/definitions\/dsb-InternationalStringType"
464
                    }
465
                },
466
                "op": {
467
                    "type": "array",
468
                    "items": {
469
                        "$ref": "#\/definitions\/md-OperationType"
470
                    }
471
                },
472
                "pol": {
473
                    "type": "array",
474
                    "items": {
475
                        "$ref": "#\/definitions\/md-PolicyType"
476
                    }
477
                },
478
                "ext": {
479
                    "type": "array",
480
                    "items": {
481
                        "$ref": "#\/definitions\/md-ExtensionType"
482
                    }
483
                },
484
                "sid": {
485
                    "type": "string"
486
                },
487
                "pvp": {
488
                    "$ref": "#\/definitions\/pres-ProfileValidityPeriodType"
489
                },
490
                "psm": {
491
                    "type": "string"
492
                },
493
                "pg": {
494
                    "type": "array",
495
                    "items": {
496
                        "type": "string"
497
                    }
498
                },
499
                "ef": {
500
                    "type": "array",
501
                    "items": {
502
                        "$ref": "#\/definitions\/md-FormatType"
503
                    }
504
                },
505
                "eed": {
506
                    "type": "string"
507
                },
508
                "perp": {
509
                    "type": "string"
510
                }
511
            },
512
            "required": ["pvp", "psm", "pg", "ef"]
513
        },
514
        "pres-ProfileValidityPeriodType": {
515
            "type": "object",
516
            "properties": {
517
                "vfrom": {
518
                    "type": "string",
519
                    "format": "date-time"
520
                },
521
                "vuntl": {
522
                    "type": "string",
523
                    "format": "date-time"
524
                }
525
            },
526
            "required": ["vfrom"]
527
        },
528
        "pres-RetrieveInfoType": {
529
            "type": "object",
530
            "properties": {
531
                "optIn": {
532
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
533
                },
534
                "reqId": {
535
                    "type": "string"
536
                },
537
                "pro": {
538
                    "type": "string"
539
                },
540
                "stat": {
541
                    "type": "string"
542
                }
543
            }
544
        },
545
        "pres-RetrieveInfoResponseType": {
546
            "type": "object",
547
            "properties": {
548
                "optOut": {
549
                    "$ref": "#\/definitions\/dsb-OptionalOutputsType"
550
                },
551
                "result": {
552
                    "$ref": "#\/definitions\/dsb-ResultType"
553
                },
554
                "reqId": {
555
                    "type": "string"
556
                },
557
                "pro": {
558
                    "type": "array",
559
                    "items": {
560
                        "$ref": "#\/definitions\/pres-ProfileType"
561
                    }
562
                }
563
            }
564
        },
565
        "pres-SearchType": {
566
            "type": "object",
567
            "properties": {
568
                "optIn": {
569
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
570
                },
571
                "reqId": {
572
                    "type": "string"
573
                },
574
                "fi": {
575
                    "type": "string"
576
                }
577
            },
578
            "required": ["fi"]
579
        },
580
        "pres-SearchResponseType": {
581
            "type": "object",
582
            "properties": {
583
                "optOut": {
584
                    "$ref": "#\/definitions\/dsb-OptionalOutputsType"
585
                },
586
                "result": {
587
                    "$ref": "#\/definitions\/dsb-ResultType"
588
                },
589
                "reqId": {
590
                    "type": "string"
591
                },
592
                "poId": {
593
                    "type": "array",
594
                    "items": {
595
                        "type": "string"
596
                    }
597
                }
598
            }
599
        },
600
        "pres-DigestListType": {
601
            "type": "object",
602
            "properties": {
603
                "digAlg": {
604
                    "$ref": "#\/definitions\/dsigrw-DigestMethodType"
605
                },
606
                "digVal": {
607
                    "type": "array",
608
                    "items": {
609
                        "type": "string"
610
                    }
611
                },
612
                "ev": {
613
                    "$ref": "#\/definitions\/pres-EvidenceType"
614
                }
615
            },
616
            "required": ["digAlg", "digVal"]
617
        },
618
        "pres-RequestType": {
619
            "type": "object",
620
            "properties": {
621
                "optIn": {
622
                    "$ref": "#\/definitions\/dsb-OptionalInputsType"
623
                },
624
                "reqId": {
625
                    "type": "string"
626
                }
627
            }
628
        }
629
    },
630
    "type": "object",
631
    "properties": {
632
        "presPO": {
633
            "$ref": "#\/definitions\/pres-PreservePOType"
634
        },
635
        "preserveResp": {
636
            "$ref": "#\/definitions\/pres-PreservePOResponseType"
637
        },
638
        "updPoc": {
639
            "$ref": "#\/definitions\/pres-UpdatePOCType"
640
        },
641
        "updPocResp": {
642
            "$ref": "#\/definitions\/pres-UpdatePOCResponseType"
643
        },
644
        "getPO": {
645
            "$ref": "#\/definitions\/pres-RetrievePOType"
646
        },
647
        "getPOResp": {
648
            "$ref": "#\/definitions\/pres-RetrievePOResponseType"
649
        },
650
        "delPO": {
651
            "$ref": "#\/definitions\/pres-DeletePOType"
652
        },
653
        "getResp": {
654
            "$ref": "#\/definitions\/pres-ResponseType"
655
        },
656
        "getTrace": {
657
            "$ref": "#\/definitions\/pres-RetrieveTraceType"
658
        },
659
        "getTraceResp": {
660
            "$ref": "#\/definitions\/pres-RetrieveTraceResponseType"
661
        },
662
        "valEvidence": {
663
            "$ref": "#\/definitions\/pres-ValidateEvidenceType"
664
        },
665
        "valEvidenceResp": {
666
            "$ref": "#\/definitions\/pres-ValidateEvidenceResponseType"
667
        },
668
        "sor": {
669
            "type": "string"
670
        },
671
        "profile": {
672
            "$ref": "#\/definitions\/pres-ProfileType"
673
        },
674
        "stat": {
675
            "type": "string"
676
        },
677
        "retrvInfo": {
678
            "$ref": "#\/definitions\/pres-RetrieveInfoType"
679
        },
680
        "retrvInfoResp": {
681
            "$ref": "#\/definitions\/pres-RetrieveInfoResponseType"
682
        },
683
        "presStoreModel": {
684
            "type": "string"
685
        },
686
        "search": {
687
            "$ref": "#\/definitions\/pres-SearchType"
688
        },
689
        "searchResp": {
690
            "$ref": "#\/definitions\/pres-SearchResponseType"
691
        },
692
        "digestList": {
693
            "$ref": "#\/definitions\/pres-DigestListType"
694
        },
695
        "req": {
696
            "$ref": "#\/definitions\/pres-RequestType"
697
        },
698
        "resp": {
699
            "$ref": "#\/definitions\/pres-ResponseType"
700
        }
701
    }
702
}
(11-11/12)