Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 7.4
edited by Helena
on 2025/05/14 13:35
Change comment: There is no comment for this version
To version 7.3
edited by Helena
on 2025/05/14 13:30
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -24,7 +24,7 @@
24 24  
25 25  **Versioning of Structural Metadata Artefacts**
26 26  
27 -* Adoption of the three-number semantic versioning standard for structural metadata artefacts ([[https:~~/~~/semver.org/>>https://semver.org/||rel="noopener noreferrer" target="_blank"]])
27 +* Adoption of the three-number semantic versioning standard for structural metadata artefacts ([[https:~~/~~/semver.org/>>https://semver.org/||target="_blank"]])
28 28  
29 29  **REST Web Services Application Programming Interface (API)**
30 30  
... ... @@ -66,8 +66,7 @@
66 66  
67 67  == //2.1 Web Services API// ==
68 68  
69 -(% style="width:948.039px" %)
70 -|**REST API**|(% style="width:818px" %)(((
69 +|**REST API**|(((
71 71  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:
72 72  
73 73  * Structure queries
... ... @@ -83,7 +83,7 @@
83 83  
84 84  Implementors are also recommended to version their API services providing users with an explicit choice of which version to use.
85 85  )))
86 -|**SOAP API**|(% style="width:818px" %)The SOAP API has been deprecated.
85 +|**SOAP API**|The SOAP API has been deprecated.
87 87  
88 88  == //2.2 Transmission Formats// ==
89 89  
... ... @@ -90,8 +90,7 @@
90 90  :
91 91  
92 92  (((
93 -(% style="width:952.039px" %)
94 -|(% style="width:130px" %)**SDMX-ML**|(% style="width:820px" %)(((
92 +|**SDMX-ML**|(((
95 95  The following legacy XML data messages have been deprecated:
96 96  
97 97  SDMX-ML 1.0/2.0 Generic (time-series) data message
... ... @@ -113,7 +113,7 @@
113 113  
114 114  * Deprecation of the Agency, ID, Version option for referencing of structures in messages
115 115  )))
116 -|(% style="width:130px" %)**SDMX-JSON**|(% style="width:820px" %)(((
114 +|**SDMX-JSON**|(((
117 117  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.
118 118  
119 119  The JSON structure message is not backwardly compatible primarily due to:
... ... @@ -125,8 +125,8 @@
125 125  
126 126  * Deprecation of the Agency, ID, Version option for referencing of structures in messages
127 127  )))
128 -|(% style="width:130px" %)**SDMX-EDI**|(% style="width:820px" %)The EDI format for both structures and data has been deprecated.
129 -|(% 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.**     **
126 +|**SDMX-EDI**|The EDI format for both structures and data has been deprecated.
127 +|**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.**     **
130 130  )))
131 131  
132 132  == //2.3 Information Model// ==
... ... @@ -134,8 +134,7 @@
134 134  :
135 135  
136 136  (((
137 -(% style="width:955.039px" %)
138 -|(% style="width:132px" %)**Data Structure Definition**|(% style="width:819px" %)(((
135 +|**Data Structure Definition**|(((
139 139  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.
140 140  
141 141  //Conversion guidance for implementors//
... ... @@ -144,7 +144,7 @@
144 144  
145 145  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.
146 146  )))
147 -|(% style="width:132px" %)**Structure mapping model**|(% style="width:819px" %)(((
144 +|**Structure mapping model**|(((
148 148  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.
149 149  
150 150  //Conversion guidance for implementors//
... ... @@ -153,7 +153,7 @@
153 153  
154 154  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.
155 155  )))
156 -|(% style="width:132px" %)**Reference metadata model**|(% style="width:819px" %)(((
153 +|**Reference metadata model**|(((
157 157  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.
158 158  
159 159  Version 2.1 reference metadata models are not valid in version 3.0.
... ... @@ -162,12 +162,12 @@
162 162  
163 163  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
164 164  )))
165 -|(% style="width:132px" %) |(% style="width:819px" %)(((
162 +| |(((
166 166  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.
167 167  
168 168  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.
169 169  )))
170 -|(% style="width:132px" %)**Constraint model**|(% style="width:819px" %)(((
167 +|**Constraint model**|(((
171 171  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.
172 172  
173 173  //Conversion guidance for implementors//
... ... @@ -176,7 +176,7 @@
176 176  
177 177  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.
178 178  )))
179 -|(% style="width:132px" %)**Hierarchical codelist structures**|(% style="width:819px" %)(((
176 +|**Hierarchical codelist structures**|(((
180 180  The version 2.1 Hierarchical Codelist artefact has been deprecated in version 3.0 and replaced by two new artefacts, Hierarchy and Hierarchy Association.
181 181  
182 182  //Conversion guidance for implementors//
... ... @@ -510,7 +510,7 @@
510 510  
511 511  = 4 Versioning of Structural Metadata Artefacts =
512 512  
513 -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.
510 +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.
514 514  
515 515  Semantic version numbers are three digits:
516 516  
... ... @@ -592,12 +592,11 @@
592 592  
593 593  /data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include:
594 594  
595 -(% style="width:531.039px" %)
596 -|(% style="width:151px" %)eq|(% style="width:378px" %)Equals
597 -|(% style="width:151px" %)ne|(% style="width:378px" %)Not equal to
598 -|(% style="width:151px" %)le|(% style="width:378px" %)Less than
599 -|(% style="width:151px" %)ge|(% style="width:378px" %)Greater than or equal to
600 -|(% style="width:151px" %)sw|(% style="width:378px" %)Starts with
592 +|eq|Equals
593 +|ne|Not equal to
594 +|le|Less than
595 +|ge|Greater than or equal to
596 +|sw|Starts with
601 601  
602 602  === Support for multiple keys ===
603 603  
... ... @@ -639,49 +639,47 @@
639 639  
640 640  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:
641 641  
642 -(% style="width:1102.04px" %)
643 -|(% style="width:321px" %)**Artefact type**|(% style="width:351px" %)**Version 2.1 Collection**|(% style="width:426px" %)**Version 3.0 Collection**
644 -|(% style="width:321px" %)AgencyScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)AgencySchemes
645 -|(% style="width:321px" %)DataConsumerScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)DataConsumerSchemes
646 -|(% style="width:321px" %)DataProviderScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)DataProviderSchemes
647 -|(% style="width:321px" %)MetadataProviderScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)MetadataProviderSchemes
648 -|(% style="width:321px" %)OrganisationUnitScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)OrganisationUnitSchemes
649 -|(% style="width:321px" %)GeographicCodelist|(% style="width:351px" %)Codelists|(% style="width:426px" %)GeographicCodelists
650 -|(% style="width:321px" %)GeoGridCodelist|(% style="width:351px" %)Codelists|(% style="width:426px" %)GeoGridCodelists
651 -|(% style="width:321px" %)ConceptScheme|(% style="width:351px" %)Concepts|(% style="width:426px" %)ConceptSchemes
652 -|(% style="width:321px" %)ValueList|(% style="width:351px" %)Codelists|(% style="width:426px" %)ValueLists
653 -|(% style="width:321px" %)StructureMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)StructureMaps
654 -|(% style="width:321px" %)RepresentationMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)RepresentationMaps
655 -|(% style="width:321px" %)ConceptSchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)ConceptSchemeMaps
656 -|(% style="width:321px" %)CategorySchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)CategorySchemeMaps
657 -|(% style="width:321px" %)OrganisationSchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)OrganisationSchemeMaps
658 -|(% style="width:321px" %)ReportingTaxonomyMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)ReportingTaxonomyMaps
659 -|(% style="width:321px" %)DataConstraint|(% style="width:351px" %)Constraints|(% style="width:426px" %)DataConstraints
660 -|(% style="width:321px" %)MetadataConstraint|(% style="width:351px" %)Constraints|(% style="width:426px" %)MetadataConstraints
661 -|(% style="width:321px" %)MetadataProvisionAgreement|(% style="width:351px" %)ProvisionAgreement|(% style="width:426px" %)MetadataProvisionAgreements
662 -|(% style="width:321px" %)CustomTypeScheme|(% style="width:351px" %)CustomTypes|(% style="width:426px" %)CustomTypeSchemes
663 -|(% style="width:321px" %)VtlMappingScheme|(% style="width:351px" %)VtlMappings|(% style="width:426px" %)VtlMappingSchemes
664 -|(% style="width:321px" %)NamePersonalisationScheme|(% style="width:351px" %)NamePersonalisations|(% style="width:426px" %)NamePersonalisationSchemes
665 -|(% style="width:321px" %)RulesetScheme|(% style="width:351px" %)Rulesets|(% style="width:426px" %)RulesetSchemes
666 -|(% style="width:321px" %)TransformationScheme|(% style="width:351px" %)Transformations|(% style="width:426px" %)TransformationSchemes
667 -|(% style="width:321px" %)UserDefinedOperatorScheme|(% style="width:351px" %)UserDefinedOperators|(% style="width:426px" %)UserDefinedOperatorSchemes
638 +|**Artefact type**|**Version 2.1 Collection**|**Version 3.0 Collection**
639 +|AgencyScheme|OrganisationSchemes|AgencySchemes
640 +|DataConsumerScheme|OrganisationSchemes|DataConsumerSchemes
641 +|DataProviderScheme|OrganisationSchemes|DataProviderSchemes
642 +|MetadataProviderScheme|OrganisationSchemes|MetadataProviderSchemes
643 +|OrganisationUnitScheme|OrganisationSchemes|OrganisationUnitSchemes
644 +|GeographicCodelist|Codelists|GeographicCodelists
645 +|GeoGridCodelist|Codelists|GeoGridCodelists
646 +|ConceptScheme|Concepts|ConceptSchemes
647 +|ValueList|Codelists|ValueLists
648 +|StructureMap|StructureMappings|StructureMaps
649 +|RepresentationMap|StructureMappings|RepresentationMaps
650 +|ConceptSchemeMap|StructureMappings|ConceptSchemeMaps
651 +|CategorySchemeMap|StructureMappings|CategorySchemeMaps
652 +|OrganisationSchemeMap|StructureMappings|OrganisationSchemeMaps
653 +|ReportingTaxonomyMap|StructureMappings|ReportingTaxonomyMaps
654 +|DataConstraint|Constraints|DataConstraints
655 +|MetadataConstraint|Constraints|MetadataConstraints
656 +|MetadataProvisionAgreement|ProvisionAgreement|MetadataProvisionAgreements
657 +|CustomTypeScheme|CustomTypes|CustomTypeSchemes
658 +|VtlMappingScheme|VtlMappings|VtlMappingSchemes
659 +|NamePersonalisationScheme|NamePersonalisations|NamePersonalisationSchemes
660 +|RulesetScheme|Rulesets|RulesetSchemes
661 +|TransformationScheme|Transformations|TransformationSchemes
662 +|UserDefinedOperatorScheme|UserDefinedOperators|UserDefinedOperatorSchemes
668 668  
669 669  No changes have been made to the way the following artefacts are organised in the structure message:
670 670  
671 -(% style="width:1106.04px" %)
672 -|(% style="width:326px" %)**Artefact type**|(% style="width:776px" %)**Collection**
673 -|(% style="width:326px" %)Dataflow|(% style="width:776px" %)Dataflows
674 -|(% style="width:326px" %)Metadataflow|(% style="width:776px" %)Metadataflows
675 -|(% style="width:326px" %)CategoryScheme|(% style="width:776px" %)CategorySchemes
676 -|(% style="width:326px" %)Categorisation|(% style="width:776px" %)Categorisations
677 -|(% style="width:326px" %)Codelist|(% style="width:776px" %)Codelists
678 -|(% style="width:326px" %)Hierarchy|(% style="width:776px" %)Hierarchies
679 -|(% style="width:326px" %)HierarchyAssociation|(% style="width:776px" %)HierarchyAssociations
680 -|(% style="width:326px" %)MetadataStructure|(% style="width:776px" %)MetadataStructures
681 -|(% style="width:326px" %)DataStructure|(% style="width:776px" %)DataStructures
682 -|(% style="width:326px" %)ReportingTaxonomy|(% style="width:776px" %)ReportingTaxonomies
683 -|(% style="width:326px" %)Process|(% style="width:776px" %)Processes
684 -|(% style="width:326px" %)ProvisionAgreement|(% style="width:776px" %)ProvisionAgreements
666 +|**Artefact type**|**Collection**
667 +|Dataflow|Dataflows
668 +|Metadataflow|Metadataflows
669 +|CategoryScheme|CategorySchemes
670 +|Categorisation|Categorisations
671 +|Codelist|Codelists
672 +|Hierarchy|Hierarchies
673 +|HierarchyAssociation|HierarchyAssociations
674 +|MetadataStructure|MetadataStructures
675 +|DataStructure|DataStructures
676 +|ReportingTaxonomy|ReportingTaxonomies
677 +|Process|Processes
678 +|ProvisionAgreement|ProvisionAgreements
685 685  
686 686  From version 3.0, collections can appear in any order within a structure message.
687 687