Changes for page SDMX 3.0 Standards. Summary of Major Changes and New Functionality

Last modified by Helena on 2025/09/10 11:19

From 16.3 to 16.2 From 19.3 to 19.2

From version 19.2

edited by Helena
on 2025/05/16 15:50

Change comment: There is no comment for this version

To version 16.3

edited by Helena
on 2025/05/16 13:18

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Tags

...	...	@@ -1,1 +1,0 @@
1		-Artefact\|Code\|Code list\|Hierarchy\|Reference metadata\|SDMX-EDI\|SDMX-JSON\|SDMX-ML\|Statistical data and metadata exchange\|Structural metadata

Content

@@ -11,55 +11,55 @@
  = 1 Overview =
--[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#2ecc71" %)version(%%) 3.0 introduces new features, improvements and changes to the Standard in the following key areas:
++SDMX version 3.0 introduces new features, improvements and changes to the Standard in the following key areas:
  **Information Model**
--* Simplification and improvement of the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] model
++* Simplification and improvement of the reference metadata model
  * Support for microdata
  * Support for geospatial data
--* Support for [[code list>>doc:xwiki:Glossary.Code list.WebHome]] extension and discriminated union of [[code>>doc:xwiki:Glossary.Code.WebHome]] lists
++* Support for code list extension and discriminated union of code lists
  * Improvements to structure mapping
--* Improvements to [[code>>doc:xwiki:Glossary.Code.WebHome]] [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] for data discovery
++* Improvements to code hierarchies for data discovery
  * Improvements to constraints
  **Versioning of Structural Metadata Artefacts**
--* Adoption of the three-number semantic versioning standard for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] ([[https:~~/~~/semver.org/>>https://semver.org/||rel="noopener noreferrer" target="_blank"]])
++* Adoption of the three-number semantic versioning standard for structural metadata artefacts ([[https:~~/~~/semver.org/>>https://semver.org/||rel="noopener noreferrer" target="_blank"]])
  **REST Web Services Application Programming Interface (API)**
  * Change to a single ‘structure’ resource for structure queries simplifying the REST API specification by reducing the number of resources to five
  * Improvements to data queries
--* Improvements to [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] queries
--* Support for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] maintenance using HTTP PUT, POST and DELETE verbs
++* Improvements to reference metadata queries
++* Support for structural metadata maintenance using HTTP PUT, POST and DELETE verbs
  **SOAP Web Services API**
--* The SOAP web services API has been deprecated with (% style="color:#2ecc71" %)version(%%) 3.0 standardising on REST**;**
++* The SOAP web services API has been deprecated with version 3.0 standardising on REST**;**
  **XML, JSON, CSV and EDI Transmission formats**
--* The [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] and [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-CSV specifications have been extended and modified where needed to support the new features and changes such as [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] and microdata
--* Obsolete [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] data message variants including Generic, Compact, Utility and Cross-sectional have been deprecated standardising on Structure Specific Data as the sole XML format for data exchange
--* The [[SDMX-EDI>>doc:xwiki:Glossary.SDMX-EDI.WebHome]] transmission format for structures and data has been deprecated
--* The organisation of structures into ‘collections’ in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] structure messages has been flattened and simplified
--* The option to reference structures in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] messages using Agency, ID and (% style="color:#2ecc71" %)Version(%%) has been deprecated with URN now exclusively used for all non-local referencing purpose
++* The SDMX-ML, SDMX-JSON and SDMX-CSV specifications have been extended and modified where needed to support the new features and changes such as reference metadata and microdata
++* Obsolete SDMX-ML data message variants including Generic, Compact, Utility and Cross-sectional have been deprecated standardising on Structure Specific Data as the sole XML format for data exchange
++* The SDMX-EDI transmission format for structures and data has been deprecated
++* The organisation of structures into ‘collections’ in SDMX-ML and SDMX-JSON structure messages has been flattened and simplified
++* The option to reference structures in SDMX-ML and SDMX-JSON messages using Agency, ID and Version has been deprecated with URN now exclusively used for all non-local referencing purpose
  **Breaking Changes**
--Many of the changes made are ‘breaking’ meaning that, while conversion between (% style="color:#2ecc71" %)versions(%%) may be possible in certain circumstances, the 3.0 specification is not directly backwardly compatible with earlier (% style="color:#2ecc71" %)versions(%%) of the Standard.
++Many of the changes made are ‘breaking’ meaning that, while conversion between versions may be possible in certain circumstances, the 3.0 specification is not directly backwardly compatible with earlier versions of the Standard.
  A summary of the main breaking changes is given in chapter 2.
  **Content of the Document**
--The remainder of the document provides a summary of the main changes. More detailed information can be found the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Technical Specifications, in particular:
++The remainder of the document provides a summary of the main changes. More detailed information can be found the SDMX 3.0 Technical Specifications, in particular:
  * Section 2 – Information Model
  * Section 5 – Registry Specification
  * Section 6 – Technical Notes
--* [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-TWG GitHub for the REST API and the XML, JSON and CSV formats
++* SDMX-TWG GitHub for the REST API and the XML, JSON and CSV formats
  = 2 Summary of Breaking Changes in 3.0 =
@@ -94,10 +94,13 @@
  The following legacy XML data messages have been deprecated:
  SDMX-ML 1.0/2.0 Generic (time-series) data message
++
  SDMX-ML 1.0/2.0 Compact (time-series) data message
++
  SDMX-ML 1.0/2.0 Utility (time-series) data message
--SDMX-ML 1.0/2.0 Cross-Sectional data message SDMX-ML 2.1 Generic data messages (for observations, time-series and cross-sectional data)
++SDMX-ML 1.0/2.0 Cross-Sectional data message SDMX-ML 2.1 Generic data messages (for observations, time-series and cross-sectional data)
++
  Structure Specific is the only data message option in version 3.0 but is not backwardly compatible with version 2.1 due to several changes including deprecation of the option to reference structures like the DSD, Dataflow and Provision Agreement using their Agency, ID and Version. The time series variant of the message has also been deprecated.
  The SDMX-ML structure message is not backwardly compatible primarily due to:
@@ -454,8 +454,8 @@
  Additional constructs are possible for dependency management when referencing structures. For instance:
--2.3+.1               Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
--2+.3.1               Means the currently latest available version >= “2.3.1” (even if not backwards compatible).
++2.3+.1 Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
++2+.3.1 Means the currently latest available version >= “2.3.1” (even if not backwards compatible).
  == Draft structures ==
@@ -463,10 +463,12 @@
  MAJOR.MINOR.PATCH-EXTENSION
--1.10.0-draft                Means that version 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in SDMX 2.1.
--1.10.0-unstable          Alternative to -draft.
--1.10.0-notfinal            Alternative to -draft.
++1.10.0-draft Means that version 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in SDMX 2.1.
++1.10.0-unstable Alternative to -draft.
++
++1.10.0-notfinal Alternative to -draft.
++
  The SDMX 2.1 isFinal property is deprecated in 3.0.
  = 5 REST Web Services API =
@@ -489,8 +489,8 @@
  Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
--(% class="wikigeneratedid" id="HExtendthecontextofdataretrieval" %)
--**Extend the context of data retrieval**
++=== Extend the context of data retrieval ===
++
  Version 2.1 data queries always retrieved data from a single specific Dataflow. In version 3.0, the query context may be specified as:
  * Dataflow;
@@ -499,20 +499,18 @@
  Data queries may also search across datasets, for instance “retrieve all data about a country”.
--(% class="wikigeneratedid" id="HComponent-basedfilters" %)
--**Component-based filters**
++=== Component-based filters ===
++
  Expressions filtering on individual components can now be included as part of the data query URL.
  /data/dataflow/ESTAT/ICP?c[REF_AREA]=CH&c[CONF_STATUS]=F
--(% class="wikigeneratedid" id="HSupportforoperators" %)
--**Support for operators**
++=== Support for operators ===
++
  Filter expressions can also include operators.
--/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015
++/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include:
--Operators include:
--
  (% style="width:531.039px" %)
  |(% style="width:151px" %)eq|(% style="width:378px" %)Equals
  |(% style="width:151px" %)ne|(% style="width:378px" %)Not equal to
@@ -520,11 +520,10 @@
  |(% style="width:151px" %)ge|(% style="width:378px" %)Greater than or equal to
  |(% style="width:151px" %)sw|(% style="width:378px" %)Starts with
--(% class="wikigeneratedid" id="HSupportformultiplekeys" %)
--**Support for multiple keys**
++=== Support for multiple keys ===
++
  Queries can now specify multiple series keys.
--(% class="wikigeneratedid" %)
  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
  == 5.3 Improved reference metadata queries ==
@@ -555,8 +555,8 @@
  The SDMX-ML XML messages have been modified and updated for version 3.0. While they broadly follow the same principles, there have been significant changes which break backward compatibility.
--(% class="wikigeneratedid" id="HStructuremessage" %)
--**Structure message**
++=== Structure message ===
++
  The SDMX-ML structure message is used for transmission of structural metadata. It closely reflects the SDMX information model and has therefore been significantly updated for version 3.0 with the addition of new structures, modifications where structures have changed, and removal of deprecated structures like Structure Set.
  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:
@@ -607,8 +607,8 @@
  From version 3.0, collections can appear in any order within a structure message.
--(% class="wikigeneratedid" id="HDatamessages" %)
--**Data messages**
++=== Data messages ===
++
  All legacy SDMX-ML data messages have been deprecated with the exception of Structure Specific Data which becomes the sole standard format for transmission of SDMX data in XML in version 3.0.
  Specifically, the following data messages are not supported in version 3.0:
@@ -625,16 +625,16 @@
  The time series variant of the Structure Specific Data message is no longer used.
--(% class="wikigeneratedid" id="HReferencemetadatamessage" %)
--**Reference metadata message**
++=== Reference metadata message ===
++
  The Generic Metadata message remains the standard format for transmission of reference metadata sets in XML but has been modified to support the revised version 3.0 reference metadata model.
--(% class="wikigeneratedid" id="HRegistrystructuralmetadata2018query2019messages" %)
--**Registry structural metadata ‘query’ messages**
++=== Registry structural metadata ‘query’ messages ===
++
  As a consequence of the deprecation of the SOAP API and standardisation on REST, the structural metadata ‘query’ messages have all been removed. In version 3.0, querying an SDMX Registry for structural metadata is performed solely using REST GET.
--(% class="wikigeneratedid" id="HStructurereferencing" %)
--**Structure referencing**
++=== Structure referencing ===
++
  The option to reference structures using Agency, ID and Version has been removed. From SDMX version 3.0 URN is used for all referencing purposes with the exception of local references such as where groups reference dimensions within a DSD.
  == 6.2 SDMX-JSON ==
@@ -641,20 +641,20 @@
  Like SDMX-ML, the SDMX-JSON messages have been significantly modified and updated for version 3.0. They are not backwardly compatible with version 2.1.
--(% class="wikigeneratedid" id="HStructuremessage-1" %)
--**Structure message**
++=== Structure message ===
++
  The SDMX-JSON structure message closely replicates the SDMX-ML equivalent. Like that of SDMX-ML it has been updated to align it with the version 3.0 information model with addition, deletion and modification of artefacts as required. The organisation of the structure collections has also been revised as detailed in paragraph 6.1.
--(% class="wikigeneratedid" id="HDatamessage" %)
--**Data message**
++=== Data message ===
++
  The SDMX-JSON data message has similarly be updated. Additional changes have been made to allow a single message to carry data from multiple datasets with potentially different Data Structure Definitions to support REST data queries of the form “retrieve all data about a country”. For this reason, the version 3.0 SDMX-JSON is not backwardly compatible with version 2.1 data messages. Support has been added for the transmission of microdata and reporting of reference metadata on data as an integral part of the dataset.
--(% class="wikigeneratedid" id="HReferencemetadatamessage-1" %)
--**Reference metadata message**
++=== Reference metadata message ===
++
  The SDMX-JSON metadata message has also been updated to support the version 3.0 reference metadata and Metadataset specifications.
--(% class="wikigeneratedid" id="HStructurereferencing-1" %)
--**Structure referencing**
++=== Structure referencing ===
++
  As for SDMX-ML, the option to reference structures using Agency, ID and Version has been removed with URN used for all non-local referencing purposes.
  == 6.3 SDMX-CSV ==
@@ -661,8 +661,8 @@
  CSV in SDMX is used transmission of data and reference metadata only.
--(% class="wikigeneratedid" id="HDatamessage-1" %)
--**Data message**
++=== Data message ===
++
  The SDMX-CSV data message has been modified to align with the version 3.0 information model, support the enhanced REST API and ensure that data can be freely converted to and from the XML and JSON formats without loss. These changes include:
  * An additional column identifying the type if the artefact defining the structure of the data: “dataflow”, “datastructure” or “dataprovision”; • A column for the structure artefact’s identification of the form
@@ -671,11 +671,11 @@
  * A column for the dataset action: information, append, replace or delete, which is consistent with both the the SDMX-ML and SDMX-JSON data messages.
--(% class="wikigeneratedid" id="HReferencemetadatamessage-2" %)
--**Reference metadata message**
++=== Reference metadata message ===
++
  The SDMX-CSV metadata message is new for version 3.0 and, like the SDMX-ML and SDMX-JSON equivalents, is used for the transmission reference metadata sets.
--== 6.4 EDI deprecation ==
++=== 6.4 EDI deprecation ===
  The EDI format for transmission of both structures and data has been deprecated. Version 3.0 is therefore not backwardly compatible with legacy EDI messages.