Project

General

Profile

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

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