-
Notifications
You must be signed in to change notification settings - Fork 19
/
Copy pathsdmx-json-structure-schema.json
5890 lines (5884 loc) · 248 KB
/
sdmx-json-structure-schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$id":"https://raw.githubusercontent.com/sdmx-twg/sdmx-json/master/structure-message/tools/schemas/2.0.0/sdmx-json-structure-schema.json",
"$schema":"http://json-schema.org/schema#",
"description":"SDMX-JSON 2.0.0 Schema for SDMX 3.0.0 structure messages",
"type":"object",
"properties":{
"meta":{
"description":"A meta object that contains non-standard meta-information and basic technical information about the message, such as when it was prepared and who has sent it. Additional properties such as for 'copyright' information can be added.",
"type":"object",
"properties":{
"schema":{
"$ref":"#/definitions/uri",
"description":"Contains the URL to the schema allowing to validate the message. This also allows identifying the version of SDMX-JSON format used in this message. Providing the link to the SDMX-JSON schema is recommended."
},
"id":{
"description":"Unique string assigned by the sender that identifies the message for further references.",
"type":"string",
"pattern":"^[A-Za-z0-9_@$-]+$"
},
"test":{
"description":"Test indicates whether the message is for test purposes or not. False for normal messages.",
"type":"boolean"
},
"prepared":{
"description":"A timestamp indicating when the message was prepared. Values must follow the ISO 8601 syntax for combined dates and times, including time zone.",
"type":"string",
"format":"date-time"
},
"contentLanguages":{
"description":"Array of strings containing the identifyer of all languages used anywhere in the message for localized elements, and thus the languages of the intended audience, representaing in an array format the same information than the http Content-Language response header, e.g. \"en, fr-fr\". See IETF Language Tags: https://tools.ietf.org/html/rfc5646#section-2.1. The array's first element indicates the main language used in the message for localized elements. The usage of this property is recommended.",
"type":"array",
"minItems":1,
"uniqueItems":true,
"items":{
"type":"string",
"pattern":"^(?:(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))$|^((?:[a-z]{2,3}(?:(?:-[a-z]{3}){1,3})?)|[a-z]{4}|[a-z]{5,8})(?:-([a-z]{4}))?(?:-([a-z]{2}|[0-9]{3}))?((?:-(?:[0-9a-z]{5,8}|[0-9][0-9a-z]{3}))*)?((?:-[0-9a-wy-z](?:-[0-9a-z]{2,8})+)*)?(-x(?:-[0-9a-z]{1,8})+)?$|^(x(?:-[0-9a-z]{1,8})+)$"
}
},
"name":{
"$ref":"#/definitions/localisedBestMatchText",
"description":"Name provides a name for the transmission. Multiple instances allow for parallel language values."
},
"names":{
"$ref":"#/definitions/localisedText",
"description":"Name provides a name for the transmission. Multiple instances allow for parallel language values."
},
"sender":{
"$ref":"#/definitions/party",
"description":"Sender is information about the party that is transmitting the message."
},
"receivers":{
"description":"Receiver is information about the part(y/ies) that is/are the intended recipient(s) of the message. This can be useful if the WS requires authentication.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/party"
}
},
"links":{
"$ref":"#/definitions/links"
}
},
"required":[
"id",
"prepared",
"sender"
]
},
"data":{
"description":"Data contains the message's “primary data”.",
"type":"object",
"properties":{
"dataStructures":{
"description":"dataStructures contains a collection of data structure definitions. The data structure definitions may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/DataStructureType",
"description":"DataStructure provides the details of a data structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate data."
}
},
"metadataStructures":{
"description":"metadataStructures contains a collection of metadata structure definition descriptions. The metadata structure definitions may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/MetadataStructureType",
"description":"metadataStructure provides the details of a metadata structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata. A metadata structure definition performs several functions: it groups sets of objects into \"targets\" against which reference metadata may be reported. Targets define the structure of the reference metadata \"keys\" which identify specific types of reported metadata, and describe the valid values for populating the keys. Also, metadata structure definitions provide a presentational organization of concepts for reporting purposes. The structure of a reference metadata report is derived from this presentational structure."
}
},
"categorySchemes":{
"description":"categorySchemes contains a collection of category scheme descriptions. The category schemes may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/CategorySchemeType",
"description":"categoryScheme provides the details of a category scheme, which is the descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common. This provides for a simple, leveled hierarchy or categories."
}
},
"conceptSchemes":{
"description":"conceptSchemes contains one or more concept schemes, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/ConceptSchemeType",
"description":"conceptScheme provides the details of a concept scheme, which is the descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common. It contains a collection of concept definitions, that may be arranged in simple hierarchies."
}
},
"codelists":{
"description":"codelists contains a collection of code list descriptions. The code lists may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/CodelistType",
"description":"codelist provides the details of a codelist, which is defined as a list from which some statistical concepts (coded concepts) take their values."
}
},
"geographicCodelists":{
"description":"geographicCodelists contains a collection of geographic code list descriptions. The geographic code lists may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/GeographicCodelistType",
"description":"geographicCodelist provides the details of a geographic code list, which comprises a set of GeoFeatureSetCodes, by adding a value in the Code that follows a pattern to represent a geo feature set."
}
},
"geoGridCodelists":{
"description":"geoGridCodelists contains a collection of geographic grid code list descriptions. The geographic grid code lists may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/GeoGridCodelistType",
"description":"geoGridCodelist provides the details of a geographic grid code list, which comprises a set of GridCodes, which are related to the gridDefinition specified in the GeoGridCodelist."
}
},
"valueLists":{
"description":"valueLists contains a collection of value list descriptions. The value lists may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/ValueListType",
"description":"valueList provides the details of a value list, which is a closed set of values that can occur for a dimension, measure, or attribute. This may be a simple list of values, or a list of values with names and descriptions (similar to a codelist)."
}
},
"hierarchies":{
"description":"hierarchies contains a collection of hierarchies, which are hierarchical code list descriptions, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/HierarchyType",
"description":"hierarchy provides the details of a hierarchy, which is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list."
}
},
"hierarchyAssociations":{
"description":"hierarchyAssociations ontains a collection of hierarchy associations. The associations may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/HierarchyAssociationType",
"description":"hierarchyAssociation provides the details of a hiearchy assoication, which associates a hiearchy with an identifiable object in the context of another object."
}
},
"agencySchemes":{
"description":"agencySchemes contains a collection of agency scheme descriptions.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/AgencySchemeType",
"description":"agencyScheme provides the details of an agency scheme, in which agencies are described."
}
},
"dataProviderSchemes":{
"description":"dataProviderSchemes contains a collection of data provider schemes descriptions.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/DataProviderSchemeType",
"description":"dataProviderScheme provides the details of a data provider scheme, in which data providers are described."
}
},
"dataConsumerSchemes":{
"description":"dataConsumerSchemes contains a collection of data consumer schemes descriptions.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/DataConsumerSchemeType",
"description":"dataConsumerScheme provides the details of an data consumer scheme, in which data consumers are described."
}
},
"metadataProviderSchemes":{
"description":"metadataProviderSchemes contains a collection of metadata provider schemes descriptions.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/MetadataProviderSchemeType",
"description":"metadataProviderScheme provides the details of an metadata provider scheme, in which metadata providers are described."
}
},
"organisationUnitSchemes":{
"description":"organisationUnitSchemes contains a collection of organisation unit schemes descriptions.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/OrganisationUnitSchemeType",
"description":"organisationUnitScheme provides the details of an organisation unit scheme, in which organisation units are described."
}
},
"dataflows":{
"description":"dataflows contains a collection of data flow descriptions. The data flows may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/DataflowType",
"description":"dataflow provides the details of a data flow, which is defined as the structure of data that will be provided for different reference periods."
}
},
"metadataflows":{
"description":"metadataflows contains a collection of metadata flow descriptions. The metadata flows may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/MetadataflowType",
"description":"metadataflow provides the details of a metadata flow, which is defined as the structure of reference metadata that will be provided for different reference periods"
}
},
"reportingTaxonomies":{
"description":"reportingTaxonomies contains a collection of reporting taxonomy descriptions. The reporting taxonomies may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/ReportingTaxonomyType",
"description":"reportingTaxonomy provides the details of a reporting taxonomy, which is a scheme which defines the composition structure of a data report where each component can be described by an independent data or metadata flow definition."
}
},
"provisionAgreements":{
"description":"provisionAgreements contains a collection of provision agreements. The provision agreements may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/ProvisionAgreementType",
"description":"provisionAgreement provides the details of a provision agreement, which is an agreement for a data provider to report data or reference metadata against a flow."
}
},
"metadataProvisionAgreements":{
"description":"metadataProvisionAgreements contains a collection of metadata provision agreements. The metadata provision agreements may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/MetadataProvisionAgreementType",
"description":"metadataProvisionAgreement provides the details of a metadata provision agreement, which is an agreement for a metadata provider to report reference metadata against a flow."
}
},
"structureMaps":{
"description":"structureMaps contains a collection of structure map descriptions. The structure maps may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/StructureMapType",
"description":"StructureMap provides the details of a structure map, which allows allows mapping between data dtructures or dataflows."
}
},
"representationMaps":{
"description":"representationMaps contains a collection of representation map descriptions. The representation maps may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/RepresentationMapType",
"description":"representationMap provides the details of a representation map, which ..."
}
},
"conceptSchemeMaps":{
"description":"conceptSchemeMaps contains a collection of concept scheme map descriptions. The concept scheme maps may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/ConceptSchemeMapType",
"description":"conceptSchemeMap provides the details of a concept scheme map, which ..."
}
},
"categorySchemeMaps":{
"description":"categorySchemeMaps contains a collection of category scheme map descriptions. The category scheme maps may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/CategorySchemeMapType",
"description":"categorySchemeMap provides the details of a category scheme map, which ..."
}
},
"organisationSchemeMaps":{
"description":"organisationSchemeMaps contains a collection of organisation scheme map descriptions. The organisation scheme maps may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/OrganisationSchemeMapType",
"description":"organisationSchemeMap provides the details of a organisation scheme map, which ..."
}
},
"reportingTaxonomyMaps":{
"description":"reportingTaxonomyMaps contains a collection of reporting taxonomy map descriptions. The reporting taxonomy maps may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/ReportingTaxonomyMapType",
"description":"reportingTaxonomyMap provides the details of a reporting taxonomy map, which ..."
}
},
"processes":{
"description":"processes contains a collection of process descriptions. The processes may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/ProcessType",
"description":"process provides the details of a process, which is a scheme which defines or documents the operations performed on data in order to validate data or to derive new information according to a given set of rules. It is not meant to support process automation, but serves as a description of how processes occur. The primary use for this structural mechanism is the attachment of reference metadata regarding statistical processing. This must either contain the full details of the category scheme, or provide a name and identification information and reference the full details from an external structure document or registry service."
}
},
"categorisations":{
"description":"categorisations contains a collection of structural object categorisations. This container may contain categorisations for many types of objects. The categorisations may be detailed in full, or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/CategorisationType",
"description":"categorisation allows for the association of an identifiable object to a category, providing for the classifications of the reference identifiable object. This must either contain the full details of the categorisation, or provide a name and identification information and reference the full details from an external structure document or registry service."
}
},
"dataConstraints":{
"description":"dataConstraints contains one or more data constraint, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/DataConstraintType",
"description":"dataConstraint specifies a sub set of the definition of the allowable or available content of a data set in terms of the content or in terms of the set of key combinations."
}
},
"metadataConstraints":{
"description":"metadataConstraints contains one or more metadata constraint, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/MetadataConstraintType",
"description":"metadataConstraint specifies a sub set of the definition of the allowable content of a metadata set."
}
},
"customTypeSchemes":{
"description":"customTypeSchemes contains one or more custom type schemes, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/CustomTypeSchemeType",
"description":"customTypeScheme ..."
}
},
"vtlMappingSchemes":{
"description":"vtlMappingSchemes contains one or more vtl mapping schemes, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/VtlMappingSchemeType",
"description":"vtlMappingScheme ..."
}
},
"namePersonalisationSchemes":{
"description":"namePersonalisationSchemes contains one or more name personalisation schemes, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/NamePersonalisationSchemeType",
"description":"namePersonalisationScheme ..."
}
},
"rulesetSchemes":{
"description":"rulesetSchemes contains one or more ruleset schemes, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/RulesetSchemeType",
"description":"rulesetScheme ..."
}
},
"transformationSchemes":{
"description":"transformationSchemes contains one or more transformation schemes, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/TransformationSchemeType",
"description":"transformationScheme ..."
}
},
"userDefinedOperatorSchemes":{
"description":"userDefinedOperatorSchemes contains one or more user defined operator schemes, which can be explicitly detailed or referenced from an external structure document or registry service.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/UserDefinedOperatorSchemeType",
"description":"userDefinedOperatorScheme ..."
}
}
}
},
"errors":{
"description":"Errors field is an array of error objects. When appropriate provides a list of error messages in addition to RESTful web services HTTP error status codes.",
"type":"array",
"items":{
"description":"Error describes the structure of an error or warning message.",
"type":"object",
"properties":{
"code":{
"description":"Provides a code number for the error message. Code numbers are defined in the SDMX 2.1 Web Services Guidelines.",
"type":"number"
},
"title":{
"$ref":"#/definitions/localisedBestMatchText",
"description":"Title contains the title of the message, in best-match language value. A short, human-readable localised summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"titles":{
"$ref":"#/definitions/localisedText",
"description":"Title contains the title of the message, in parallel language values. A list of short, human-readable localised summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail":{
"$ref":"#/definitions/localisedBestMatchText",
"description":"Detail contains the detailed text of the message, in best-match language value. A human-readable localised explanation specific to this occurrence of the problem. Like title, this field’s value can be localized. It is fully customizable by the service providers and should provide enough detail to ease understanding the reasons of the error."
},
"details":{
"$ref":"#/definitions/localisedText",
"description":"Detail contains the detailed text of the message, in parallel language values. A list of human-readable localised explanations specific to this occurrence of the problem. Like title, this field’s value can be localized. It is fully customizable by the service providers and should provide enough detail to ease understanding the reasons of the error."
},
"links":{
"$ref":"#/definitions/links",
"description":"Links field is an array of link objects. If appropriate, a collection of links to additional external resources for the error."
}
},
"required":[
"code"
]
}
}
},
"definitions":{
"party":{
"description":"Sender contains information about the party that is transmitting the message.",
"type":"object",
"properties":{
"id":{
"description":"The id holds the identification of the party.",
"type":"string",
"pattern":"^[A-Za-z0-9_@$-]+$"
},
"name":{
"description":"Name is a human-readable name of the party.",
"$ref":"#/definitions/localisedBestMatchText"
},
"names":{
"description":"Name is a human-readable name of the party.",
"$ref":"#/definitions/localisedText"
},
"contacts":{
"description":"Contact provides contact information for the party in regard to the transmission of the message.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/contactType"
}
}
},
"required":[
"id"
]
},
"links":{
"description":"Links field is an array of link objects. If appropriate, a collection of links to additional resources, including external resources.",
"type":"array",
"items":{
"type":"object",
"properties":{
"href":{
"$ref":"#/definitions/uri"
},
"rel":{
"description":"Relationship of the object to the resource. See semantics below. Use 'self' to indicate the urn to the parent object.",
"anyOf":[
{
"type":"string"
},
{
"description":"structure: provides a reference to the data structure or metadata structure definition depending on the context. Other SDMX artefact types can be specified, e.g. dataflow, provisionagreement, etc. For the others please see: https://tools.ietf.org/rfc/rfc5988.txt",
"type":"string",
"enum":[
"agency",
"agencyscheme",
"attributedescriptor",
"alternate",
"appendix",
"bookmark",
"categorisation",
"category",
"categoryscheme",
"categoryschememap",
"chapter",
"code",
"codelist",
"componentmap",
"concept",
"conceptscheme",
"conceptschememap",
"constraint",
"contents",
"copyright",
"current",
"customtype",
"customtypescheme",
"dataattribute",
"dataconstraint",
"dataconsumer",
"dataconsumerscheme",
"dataflow",
"dataprovider",
"dataproviderscheme",
"datastructure",
"datastructuredefinition",
"datepatternmap",
"describedby",
"dimension",
"dimensiondescriptor",
"edit",
"edit-media",
"enclosure",
"epochmap",
"first",
"frequencyformatmapping",
"glossary",
"groupdimesiondescriptor",
"help",
"hierarchicalcode",
"hierarchy",
"hierarchyassociation",
"hub",
"index",
"itemschememap",
"last",
"latest-version",
"license",
"level",
"measure",
"measuredescriptor",
"metadataattribute",
"metadataconstraint",
"metadataflow",
"metadataproviderscheme",
"metadataprovisionagreement",
"metadataprovider",
"metadatastructure",
"metadatastructuredefinition",
"namepersonalisation",
"namepersonalisatinscheme",
"next",
"next-archive",
"organisationschememap",
"organisationunit",
"organisationunitscheme",
"payment",
"prev",
"predecessor-version",
"previous",
"prev-archive",
"process",
"processstep",
"provisionagreement",
"related",
"replies",
"reportingcategory",
"reportingtaxonomy",
"reportingtaxonomymap",
"metadataattributedescriptor",
"representatiomap",
"ruleset",
"rulesetscheme",
"section",
"self",
"service",
"start",
"structure",
"structuremap",
"stylesheet",
"subscription",
"subsection",
"successor-version",
"timedimension",
"transformation",
"transformationscheme",
"transition",
"userdefinedoperator",
"userdefinedoperatorscheme",
"up",
"valuelist",
"version-history",
"via",
"vtlcodelistmapping",
"vtlconceptmapping",
"vtldataflowmapping",
"vtlmappingscheme",
"working-copy",
"working-copy-of"
]
}
]
},
"urn":{
"description":"The urn holds any valid SDMX Registry URN (see SDMX Registry Specification for details).",
"$ref":"#/definitions/urn"
},
"uri":{
"description":"The uri attribute holds a URI that contains a link to additional information about the resource, such as a web page. This uri is not an SDMX resource.",
"$ref":"#/definitions/uri"
},
"title":{
"$ref":"#/definitions/localisedBestMatchText"
},
"titles":{
"$ref":"#/definitions/localisedText"
},
"type":{
"description":"A hint about the type of representation returned by the link.",
"type":"string"
},
"hreflang":{
"description":"The natural language of the external link, the same as used in the HTTP Accept-Language request header.",
"type":"string",
"pattern":"^(?:(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))$|^((?:[a-z]{2,3}(?:(?:-[a-z]{3}){1,3})?)|[a-z]{4}|[a-z]{5,8})(?:-([a-z]{4}))?(?:-([a-z]{2}|[0-9]{3}))?((?:-(?:[0-9a-z]{5,8}|[0-9][0-9a-z]{3}))*)?((?:-[0-9a-wy-z](?:-[0-9a-z]{2,8})+)*)?(-x(?:-[0-9a-z]{1,8})+)?$|^(x(?:-[0-9a-z]{1,8})+)$"
}
},
"anyOf":[
{
"required":[
"href",
"rel"
]
},
{
"required":[
"urn",
"rel"
]
}
]
}
},
"localisedBestMatchText":{
"type":"string",
"description":"localisedBestMatchText is a reusable element, used for providing a human-readable best-language-match texts."
},
"localisedText":{
"description":"localisedText provides for a set of language-specific alternates to be provided for any human-readable constructs in the instance. ",
"type":"object",
"patternProperties":{
"^(?:(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))$|^((?:[a-z]{2,3}(?:(?:-[a-z]{3}){1,3})?)|[a-z]{4}|[a-z]{5,8})(?:-([a-z]{4}))?(?:-([a-z]{2}|[0-9]{3}))?((?:-(?:[0-9a-z]{5,8}|[0-9][0-9a-z]{3}))*)?((?:-[0-9a-wy-z](?:-[0-9a-z]{2,8})+)*)?(-x(?:-[0-9a-z]{1,8})+)?$|^(x(?:-[0-9a-z]{1,8})+)$":{
"type":"string"
}
}
},
"contactType":{
"description":"ContactType describes the structure of a contact's details.",
"type":"object",
"properties":{
"id":{
"$ref":"#/definitions/idType"
},
"name":{
"description":"Name contains a humain-readable name for the contact.",
"$ref":"#/definitions/localisedBestMatchText"
},
"names":{
"description":"Name contains a humain-readable name for the contact.",
"$ref":"#/definitions/localisedText"
},
"department":{
"description":"Department is a humain-readable designation of the organisational structure by a linguistic expression, within which the contact person works.",
"$ref":"#/definitions/localisedBestMatchText"
},
"departments":{
"description":"Department is a humain-readable designation of the organisational structure by a linguistic expression, within which the contact person works.",
"$ref":"#/definitions/localisedText"
},
"role":{
"description":"Role is the humain-readable responsibility of the contact person with respect to the object for which this person is the contact.",
"$ref":"#/definitions/localisedBestMatchText"
},
"roles":{
"description":"Role is the humain-readable responsibility of the contact person with respect to the object for which this person is the contact.",
"$ref":"#/definitions/localisedText"
},
"telephones":{
"type":"array",
"minItems":1,
"items":{
"description":"Telephone holds the telephone number for the contact person.",
"type":"string"
}
},
"faxes":{
"type":"array",
"minItems":1,
"items":{
"description":"Fax holds the fax number for the contact person.",
"type":"string"
}
},
"x400s":{
"type":"array",
"minItems":1,
"items":{
"description":"X400 holds the X.400 address for the contact person.",
"type":"string"
}
},
"uris":{
"type":"array",
"minItems":1,
"items":{
"description":"URI holds an information URL for the contact person.",
"$ref":"#/definitions/uri"
}
},
"emails":{
"type":"array",
"minItems":1,
"items":{
"description":"Email holds the email address for the contact person.",
"type":"string",
"format":"email"
}
}
}
},
"idType":{
"description":"IDType provides a type which is used for restricting the characters in codes and IDs throughout all SDMX-ML messages. Valid characters include A-Z, a-z, @, 0-9, _, -, $. Regex: [A-Za-z0-9_@$-]+",
"type":"string",
"pattern":"^[A-Za-z0-9_@$-]+$"
},
"WildcardIDType":{
"description":"WildcardIDTypeType combines the IDType and WildcardType to allow a reference to either a specific identifier, or to wildcard the identifier in the reference by specifying the '*' value.",
"anyOf":[
{
"$ref":"#/definitions/idType"
},
{
"$ref":"#/definitions/WildcardType"
}
]
},
"AnnotationType":{
"description":"AnnotationType provides for non-documentation notes and annotations to be embedded in data and structure messages. It provides optional fields for providing a title, a type description, a URI, and the text of the annotation.",
"type":"object",
"properties":{
"id":{
"description":"Non-standard identification of an annotation.",
"type":"string"
},
"title":{
"description":"AnnotationTitle provides a title for the annotation.",
"type":"string"
},
"type":{
"description":"AnnotationType is used to distinguish between annotations designed to support various uses. The types are not enumerated, as these can be specified by the user or creator of the annotations. The definitions and use of annotation types should be documented by their creator.",
"type":"string"
},
"value":{
"description":"AnnotationValue holds a string containing the non-localised value text of the annotation.",
"type":"string"
},
"text":{
"description":"AnnotationText holds a language-specific string containing the text of the annotation.",
"$ref":"#/definitions/localisedBestMatchText"
},
"texts":{
"description":"AnnotationText holds a language-specific string containing the text of the annotation.",
"$ref":"#/definitions/localisedText"
},
"links":{
"description":"Links field is an array of link objects. Also used to specify the Annotation URL which points to an external resource which may contain or supplement the annotation (using 'self' as relationship). If a specific behavior is desired, an annotation type should be defined which specifies the use of this field more exactly. If appropriate, a collection of links to additional external resources.",
"$ref":"#/definitions/links"
}
}
},
"AnnotationsType":{
"description":"AnnotationsType is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotableType my reference it.",
"type":"array",
"minItems":1,
"items":{
"$ref":"#/definitions/AnnotationType"
}
},
"AnnotableType":{
"description":"AnnotableType is an abstract base type used for all annotable artefacts. Any type that provides for annotations should extend this type.",
"type":"object",
"properties":{
"annotations":{
"$ref":"#/definitions/AnnotationsType"
}
}
},
"IdentifiableType":{
"description":"IdentifiableType is an abstract base type for all identifiable objects.",
"type":"object",
"allOf":[
{
"properties":{
"id":{
"$ref":"#/definitions/idType"
},
"links":{
"$ref":"#/definitions/links",
"description":"Links field is an array of link objects. Also used to specify the URI or the URN to itself. If appropriate, a collection of links to additional external resources."
}
}
},
{
"$ref":"#/definitions/AnnotableType"
}
]
},
"IdentifiableTypeWithNCNameID":{
"description":"IdentifiableType is an abstract base type for all identifiable objects.",
"type":"object",
"allOf":[
{
"properties":{
"id":{
"$ref":"#/definitions/NCNameIDType"
},
"links":{
"$ref":"#/definitions/links",
"description":"Links field is an array of link objects. Also used to specify the URI or the URN to itself. If appropriate, a collection of links to additional external resources."
}
}
},
{
"$ref":"#/definitions/AnnotableType"
}
]
},
"NameableType":{
"description":"NameableType is an abstract base type for all nameable objects.",
"type":"object",
"allOf":[
{
"$ref":"#/definitions/IdentifiableType"
},
{
"properties":{
"name":{
"$ref":"#/definitions/localisedBestMatchText"
},
"names":{
"$ref":"#/definitions/localisedText"
},
"description":{
"$ref":"#/definitions/localisedBestMatchText"
},
"descriptions":{
"$ref":"#/definitions/localisedText"
}
}
}
],
"required":[
"name"
]
},
"NameableTypeWithNCNameID":{
"description":"NameableType is an abstract base type for all nameable objects with NCNameID.",
"type":"object",
"allOf":[
{
"$ref":"#/definitions/IdentifiableTypeWithNCNameID"
},
{
"properties":{
"name":{
"$ref":"#/definitions/localisedBestMatchText"
},
"names":{
"$ref":"#/definitions/localisedText"
},
"description":{
"$ref":"#/definitions/localisedBestMatchText"
},
"descriptions":{
"$ref":"#/definitions/localisedText"
}
}
}
],
"required":[
"name"
]
},
"MaintainableType":{
"description":"MaintainableType is an abstract base type for all maintainable objects.",
"type":"object",
"allOf":[
{
"$ref":"#/definitions/NameableType"
},
{
"properties":{
"version":{
"$ref":"#/definitions/VersionType"
},
"agencyID":{
"$ref":"#/definitions/NestedNCNameIDType"
},
"isExternalReference":{
"type":"boolean"
},
"validFrom":{
"type":"string",
"format":"date-time"
},
"validTo":{
"type":"string",
"format":"date-time"
}
}
}
],
"required":[
"id",
"agencyID",
"name"
]
},
"MaintainableWithoutVersionType":{
"description":"MaintainableWithoutVersionType is an abstract base type for all maintainable objects without version (and fixed id). For the moment, the version number is fixed to '1.0'",
"type":"object",
"allOf":[
{
"$ref":"#/definitions/AnnotableType"
},
{
"properties":{
"version":{
"const":"1.0"
},
"agencyID":{
"$ref":"#/definitions/NestedNCNameIDType"
},
"name":{
"$ref":"#/definitions/localisedBestMatchText"
},
"names":{
"$ref":"#/definitions/localisedText"
},
"description":{
"$ref":"#/definitions/localisedBestMatchText"
},
"descriptions":{
"$ref":"#/definitions/localisedText"
},
"isExternalReference":{
"type":"boolean"
},
"validFrom":{
"type":"string",
"format":"date-time"
},
"validTo":{
"type":"string",
"format":"date-time"
},
"links":{
"$ref":"#/definitions/links",
"description":"Links field is an array of link objects. Also used to specify the URI or the URN to itself. If appropriate, a collection of links to additional external resources."
}
}
}
],
"required":[
"id",
"agencyID",
"name"
]
},
"MaintainableTypeWithNCNameID":{
"description":"MaintainableType is an abstract base type for all maintainable objects with NCNameID.",
"type":"object",
"allOf":[
{
"properties":{
"version":{
"$ref":"#/definitions/VersionType"
},
"agencyID":{
"$ref":"#/definitions/NestedNCNameIDType"
}
}
},
{
"$ref":"#/definitions/NameableTypeWithNCNameID"
},
{
"properties":{