Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 7.5
edited by Helena
on 2025/05/14 13:36
Change comment: There is no comment for this version
To version 7.1
edited by Helena
on 2025/05/14 13:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,13 +1,9 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
4 -
1 +{{box title="**Contents**"}}{{toc/}}{{/box}}
5 5  **Revision History**
6 6  
7 -(% style="width:738.039px" %)
8 -|(% style="width:187px" %)Revision|(% style="width:157px" %)Date|(% style="width:390px" %)Contents
9 -|(% style="width:187px" %)DRAFT 1.0|(% style="width:157px" %)May 2021|(% style="width:390px" %)Draft release updated for SDMX 3.0 for public consultation
10 -|(% style="width:187px" %)1.0|(% style="width:157px" %)October 2021|(% style="width:390px" %)Public Release for SDMX 3.0
4 +|Revision|Date|Contents
5 +|DRAFT 1.0|May 2021|Draft release updated for SDMX 3.0 for public consultation
6 +|1.0|October 2021|Public Release for SDMX 3.0
11 11  
12 12  = 1 Overview =
13 13  
... ... @@ -25,7 +25,7 @@
25 25  
26 26  **Versioning of Structural Metadata Artefacts**
27 27  
28 -* Adoption of the three-number semantic versioning standard for structural metadata artefacts ([[https:~~/~~/semver.org/>>https://semver.org/||rel="noopener noreferrer" target="_blank"]])
24 +• Adoption of the three-number semantic versioning standard for structural metadata artefacts [[(>>url:https://semver.org/]][[__https:~~/~~/semver.org__>>url:https://semver.org/]][[)>>url:https://semver.org/]]
29 29  
30 30  **REST Web Services Application Programming Interface (API)**
31 31  
... ... @@ -36,7 +36,7 @@
36 36  
37 37  **SOAP Web Services API**
38 38  
39 -* The SOAP web services API has been deprecated with version 3.0 standardising on REST**;**
35 +• The SOAP web services API has been deprecated with version 3.0 standardising on REST** **
40 40  
41 41  **XML, JSON, CSV and EDI Transmission formats**
42 42  
... ... @@ -67,8 +67,7 @@
67 67  
68 68  == //2.1 Web Services API// ==
69 69  
70 -(% style="width:948.039px" %)
71 -|**REST API**|(% style="width:818px" %)(((
66 +|**REST API**|(((
72 72  The REST API is not backwardly compatible due to modifications to the URLs and query parameters resulting in breaking changes in four of the five main resources:
73 73  
74 74  * Structure queries
... ... @@ -84,7 +84,7 @@
84 84  
85 85  Implementors are also recommended to version their API services providing users with an explicit choice of which version to use.
86 86  )))
87 -|**SOAP API**|(% style="width:818px" %)The SOAP API has been deprecated.
82 +|**SOAP API**|The SOAP API has been deprecated.
88 88  
89 89  == //2.2 Transmission Formats// ==
90 90  
... ... @@ -91,8 +91,7 @@
91 91  :
92 92  
93 93  (((
94 -(% style="width:952.039px" %)
95 -|(% style="width:130px" %)**SDMX-ML**|(% style="width:820px" %)(((
89 +|**SDMX-ML**|(((
96 96  The following legacy XML data messages have been deprecated:
97 97  
98 98  SDMX-ML 1.0/2.0 Generic (time-series) data message
... ... @@ -108,10 +108,13 @@
108 108  The SDMX-ML structure message is not backwardly compatible primarily due to:
109 109  
110 110  * Changes to the information model
111 -* Changes to the way the structures are organised into ‘collections’ within the message
105 +* Changes to the way the structures are organised into
106 +
107 +‘collections’ within the message
108 +
112 112  * Deprecation of the Agency, ID, Version option for referencing of structures in messages
113 113  )))
114 -|(% style="width:130px" %)**SDMX-JSON**|(% style="width:820px" %)(((
111 +|**SDMX-JSON**|(((
115 115  The JSON data message is not backwardly compatible with version 2.1 primarily due to changes needed to support the improved REST API data queries, in particular the ability to retrieve in one operation data from multiple datasets with potentially different Data Structure Definitions.
116 116  
117 117  The JSON structure message is not backwardly compatible primarily due to:
... ... @@ -123,8 +123,8 @@
123 123  
124 124  * Deprecation of the Agency, ID, Version option for referencing of structures in messages
125 125  )))
126 -|(% style="width:130px" %)**SDMX-EDI**|(% style="width:820px" %)The EDI format for both structures and data has been deprecated.
127 -|(% style="width:130px" %)**SDMX-CSV**|(% style="width:820px" %)The CSV data and reference metadata messages are not backwardly compatible with those under version 2.1 due to changes to the structure of the messages needed to support new features such as the improved REST API data queries.**     **
123 +|**SDMX-EDI**|The EDI format for both structures and data has been deprecated.
124 +|**SDMX-CSV**|The CSV data and reference metadata messages are not backwardly compatible with those under version 2.1 due to changes to the structure of the messages needed to support new features such as the improved REST API data queries.**     **
128 128  )))
129 129  
130 130  == //2.3 Information Model// ==
... ... @@ -132,8 +132,7 @@
132 132  :
133 133  
134 134  (((
135 -(% style="width:955.039px" %)
136 -|(% style="width:132px" %)**Data Structure Definition**|(% style="width:819px" %)(((
132 +|**Data Structure Definition**|(((
137 137  The version 3.0 Data Structure Definition (DSD) model is not directly backwardly compatible with 2.1 primarily due to the deprecation of the special MeasureDimension.
138 138  
139 139  //Conversion guidance for implementors//
... ... @@ -142,7 +142,7 @@
142 142  
143 143  Version 3.0 DSDs cannot be reliably converted to the 2.1 model due to the introduction of new features such as multiple measures and value arrays for measures and attributes.
144 144  )))
145 -|(% style="width:132px" %)**Structure mapping model**|(% style="width:819px" %)(((
141 +|**Structure mapping model**|(((
146 146  The structure mapping model has changed significantly in version 3.0 with deprecation of the Structure Set maintainable artefact and introduction of five new ones: Representation Map and four variants of item scheme map.
147 147  
148 148  //Conversion guidance for implementors//
... ... @@ -151,7 +151,7 @@
151 151  
152 152  Conversion from the version 3.0 structure mapping model to 2.1 is generally possible. However, when attempting to convert mapping rules from 2.1 to 3.0 and back to 2.1, the resulting Structure Set will not be precisely the same as the original. In converting to version 3.0, the system must generate IDs for each of the new maintainable artefacts, but details of the original Structure Set artefacts are lost.
153 153  )))
154 -|(% style="width:132px" %)**Reference metadata model**|(% style="width:819px" %)(((
150 +|**Reference metadata model**|(((
155 155  The reference metadata model has changed in version 3.0 with modifications to the role of the Data Structure Definition, Metadata Structure Definition and Metadataflow artefacts. Metadata Provision Agreement and Metadata Provider Scheme have been added. Metadatasets are now identifiable.
156 156  
157 157  Version 2.1 reference metadata models are not valid in version 3.0.
... ... @@ -160,12 +160,12 @@
160 160  
161 161  A version 2.1 Metadata Structure Definition can be converted to the version 3.0 model under some circumstances, but target information is either lost or has to be translated into a metadataflow. Further, conversion of a Data Structure Definition for collecting reference metadata against a dataset would need to make changes to the dataset’s Data Structure Definition. As the Data Structure Definition may not actually be specified, judgement would need to be taken, perhaps determining the most likely candidate by examining which
162 162  )))
163 -|(% style="width:132px" %) |(% style="width:819px" %)(((
159 +| |(((
164 164  already have metadata reported against their datasets. A 2.1 metadata report could be converted to a version 3.0 Metadataset if it is attached to a structure, but requires a Metadata Provision Agreement which would need to be created if not already in existence.
165 165  
166 166  Conversion from the version 3.0 model to version 2.1 cannot be performed reliably. The process would need target information to be derived from analysis of the Metadataflows and Metadata Provision Agreements. Depending on the complexity it may not be possible to express that information in a version 2.1 Data Structure Definition.
167 167  )))
168 -|(% style="width:132px" %)**Constraint model**|(% style="width:819px" %)(((
164 +|**Constraint model**|(((
169 169  The version 2.1 Content Constraint artefact has been deprecated in version 3.0 and replaced by the Data Constraint for data, and the Metadata Constraint for reference metadata.
170 170  
171 171  //Conversion guidance for implementors//
... ... @@ -174,7 +174,7 @@
174 174  
175 175  Conversion from 3.0 to 2.1 presents challenges where wildcards have been used, in those cases requiring expansion of the wildcard into explicit values.
176 176  )))
177 -|(% style="width:132px" %)**Hierarchical codelist structures**|(% style="width:819px" %)(((
173 +|**Hierarchical codelist structures**|(((
178 178  The version 2.1 Hierarchical Codelist artefact has been deprecated in version 3.0 and replaced by two new artefacts, Hierarchy and Hierarchy Association.
179 179  
180 180  //Conversion guidance for implementors//
... ... @@ -508,7 +508,7 @@
508 508  
509 509  = 4 Versioning of Structural Metadata Artefacts =
510 510  
511 -Version 3.0 adopts semantic versioning principles for versioning of metadata artefacts following the rules set out at __[[https:~~/~~/semver.org>>https://semver.org]] __However, this is not mandatory, and organisations may continue to use the pre-existing two-digit versioning strategy, or not to version artefacts by omitting the //version// property. The version number no longer defaults to 1.0 if not explicitly set.
507 +Version 3.0 adopts semantic versioning principles for versioning of metadata artefacts following the rules set out at [[__https:~~/~~/semver.org__>>url:https://semver.org/]][[.>>url:https://semver.org/]] However, this is not mandatory, and organisations may continue to use the pre-existing two-digit versioning strategy, or not to version artefacts by omitting the //version// property. The version number no longer defaults to 1.0 if not explicitly set.
512 512  
513 513  Semantic version numbers are three digits:
514 514  
... ... @@ -590,12 +590,11 @@
590 590  
591 591  /data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include:
592 592  
593 -(% style="width:531.039px" %)
594 -|(% style="width:151px" %)eq|(% style="width:378px" %)Equals
595 -|(% style="width:151px" %)ne|(% style="width:378px" %)Not equal to
596 -|(% style="width:151px" %)le|(% style="width:378px" %)Less than
597 -|(% style="width:151px" %)ge|(% style="width:378px" %)Greater than or equal to
598 -|(% style="width:151px" %)sw|(% style="width:378px" %)Starts with
589 +|eq|Equals
590 +|ne|Not equal to
591 +|le|Less than
592 +|ge|Greater than or equal to
593 +|sw|Starts with
599 599  
600 600  === Support for multiple keys ===
601 601  
... ... @@ -637,49 +637,47 @@
637 637  
638 638  Additionally, the way the individual artefacts are organised into ‘collections’ within the message has been significantly revised with a simpler flat structure adopted as set out in the following table:
639 639  
640 -(% style="width:1102.04px" %)
641 -|(% style="width:321px" %)**Artefact type**|(% style="width:351px" %)**Version 2.1 Collection**|(% style="width:426px" %)**Version 3.0 Collection**
642 -|(% style="width:321px" %)AgencyScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)AgencySchemes
643 -|(% style="width:321px" %)DataConsumerScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)DataConsumerSchemes
644 -|(% style="width:321px" %)DataProviderScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)DataProviderSchemes
645 -|(% style="width:321px" %)MetadataProviderScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)MetadataProviderSchemes
646 -|(% style="width:321px" %)OrganisationUnitScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)OrganisationUnitSchemes
647 -|(% style="width:321px" %)GeographicCodelist|(% style="width:351px" %)Codelists|(% style="width:426px" %)GeographicCodelists
648 -|(% style="width:321px" %)GeoGridCodelist|(% style="width:351px" %)Codelists|(% style="width:426px" %)GeoGridCodelists
649 -|(% style="width:321px" %)ConceptScheme|(% style="width:351px" %)Concepts|(% style="width:426px" %)ConceptSchemes
650 -|(% style="width:321px" %)ValueList|(% style="width:351px" %)Codelists|(% style="width:426px" %)ValueLists
651 -|(% style="width:321px" %)StructureMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)StructureMaps
652 -|(% style="width:321px" %)RepresentationMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)RepresentationMaps
653 -|(% style="width:321px" %)ConceptSchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)ConceptSchemeMaps
654 -|(% style="width:321px" %)CategorySchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)CategorySchemeMaps
655 -|(% style="width:321px" %)OrganisationSchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)OrganisationSchemeMaps
656 -|(% style="width:321px" %)ReportingTaxonomyMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)ReportingTaxonomyMaps
657 -|(% style="width:321px" %)DataConstraint|(% style="width:351px" %)Constraints|(% style="width:426px" %)DataConstraints
658 -|(% style="width:321px" %)MetadataConstraint|(% style="width:351px" %)Constraints|(% style="width:426px" %)MetadataConstraints
659 -|(% style="width:321px" %)MetadataProvisionAgreement|(% style="width:351px" %)ProvisionAgreement|(% style="width:426px" %)MetadataProvisionAgreements
660 -|(% style="width:321px" %)CustomTypeScheme|(% style="width:351px" %)CustomTypes|(% style="width:426px" %)CustomTypeSchemes
661 -|(% style="width:321px" %)VtlMappingScheme|(% style="width:351px" %)VtlMappings|(% style="width:426px" %)VtlMappingSchemes
662 -|(% style="width:321px" %)NamePersonalisationScheme|(% style="width:351px" %)NamePersonalisations|(% style="width:426px" %)NamePersonalisationSchemes
663 -|(% style="width:321px" %)RulesetScheme|(% style="width:351px" %)Rulesets|(% style="width:426px" %)RulesetSchemes
664 -|(% style="width:321px" %)TransformationScheme|(% style="width:351px" %)Transformations|(% style="width:426px" %)TransformationSchemes
665 -|(% style="width:321px" %)UserDefinedOperatorScheme|(% style="width:351px" %)UserDefinedOperators|(% style="width:426px" %)UserDefinedOperatorSchemes
635 +|**Artefact type**|**Version 2.1 Collection**|**Version 3.0 Collection**
636 +|AgencyScheme|OrganisationSchemes|AgencySchemes
637 +|DataConsumerScheme|OrganisationSchemes|DataConsumerSchemes
638 +|DataProviderScheme|OrganisationSchemes|DataProviderSchemes
639 +|MetadataProviderScheme|OrganisationSchemes|MetadataProviderSchemes
640 +|OrganisationUnitScheme|OrganisationSchemes|OrganisationUnitSchemes
641 +|GeographicCodelist|Codelists|GeographicCodelists
642 +|GeoGridCodelist|Codelists|GeoGridCodelists
643 +|ConceptScheme|Concepts|ConceptSchemes
644 +|ValueList|Codelists|ValueLists
645 +|StructureMap|StructureMappings|StructureMaps
646 +|RepresentationMap|StructureMappings|RepresentationMaps
647 +|ConceptSchemeMap|StructureMappings|ConceptSchemeMaps
648 +|CategorySchemeMap|StructureMappings|CategorySchemeMaps
649 +|OrganisationSchemeMap|StructureMappings|OrganisationSchemeMaps
650 +|ReportingTaxonomyMap|StructureMappings|ReportingTaxonomyMaps
651 +|DataConstraint|Constraints|DataConstraints
652 +|MetadataConstraint|Constraints|MetadataConstraints
653 +|MetadataProvisionAgreement|ProvisionAgreement|MetadataProvisionAgreements
654 +|CustomTypeScheme|CustomTypes|CustomTypeSchemes
655 +|VtlMappingScheme|VtlMappings|VtlMappingSchemes
656 +|NamePersonalisationScheme|NamePersonalisations|NamePersonalisationSchemes
657 +|RulesetScheme|Rulesets|RulesetSchemes
658 +|TransformationScheme|Transformations|TransformationSchemes
659 +|UserDefinedOperatorScheme|UserDefinedOperators|UserDefinedOperatorSchemes
666 666  
667 667  No changes have been made to the way the following artefacts are organised in the structure message:
668 668  
669 -(% style="width:1106.04px" %)
670 -|(% style="width:326px" %)**Artefact type**|(% style="width:776px" %)**Collection**
671 -|(% style="width:326px" %)Dataflow|(% style="width:776px" %)Dataflows
672 -|(% style="width:326px" %)Metadataflow|(% style="width:776px" %)Metadataflows
673 -|(% style="width:326px" %)CategoryScheme|(% style="width:776px" %)CategorySchemes
674 -|(% style="width:326px" %)Categorisation|(% style="width:776px" %)Categorisations
675 -|(% style="width:326px" %)Codelist|(% style="width:776px" %)Codelists
676 -|(% style="width:326px" %)Hierarchy|(% style="width:776px" %)Hierarchies
677 -|(% style="width:326px" %)HierarchyAssociation|(% style="width:776px" %)HierarchyAssociations
678 -|(% style="width:326px" %)MetadataStructure|(% style="width:776px" %)MetadataStructures
679 -|(% style="width:326px" %)DataStructure|(% style="width:776px" %)DataStructures
680 -|(% style="width:326px" %)ReportingTaxonomy|(% style="width:776px" %)ReportingTaxonomies
681 -|(% style="width:326px" %)Process|(% style="width:776px" %)Processes
682 -|(% style="width:326px" %)ProvisionAgreement|(% style="width:776px" %)ProvisionAgreements
663 +|**Artefact type**|**Collection**
664 +|Dataflow|Dataflows
665 +|Metadataflow|Metadataflows
666 +|CategoryScheme|CategorySchemes
667 +|Categorisation|Categorisations
668 +|Codelist|Codelists
669 +|Hierarchy|Hierarchies
670 +|HierarchyAssociation|HierarchyAssociations
671 +|MetadataStructure|MetadataStructures
672 +|DataStructure|DataStructures
673 +|ReportingTaxonomy|ReportingTaxonomies
674 +|Process|Processes
675 +|ProvisionAgreement|ProvisionAgreements
683 683  
684 684  From version 3.0, collections can appear in any order within a structure message.
685 685