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

From version 9.1
edited by Helena
on 2025/05/14 13:42
Change comment: There is no comment for this version
To version 13.4
edited by Helena
on 2025/05/14 15:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -65,7 +65,7 @@
65 65  
66 66  Version 3.0 introduces breaking changes into the web services API, transmission formats and information model. A summary is given in the table below.
67 67  
68 -== //2.1 Web Services API// ==
68 +== 2.1 Web Services API ==
69 69  
70 70  (% style="width:948.039px" %)
71 71  |**REST API**|(% style="width:818px" %)(((
... ... @@ -86,7 +86,7 @@
86 86  )))
87 87  |**SOAP API**|(% style="width:818px" %)The SOAP API has been deprecated.
88 88  
89 -== //2.2 Transmission Formats// ==
89 +== 2.2 Transmission Formats ==
90 90  
91 91  (((
92 92  (% style="width:952.039px" %)
... ... @@ -122,7 +122,7 @@
122 122  |(% 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 123  )))
124 124  
125 -== //2.3 Information Model// ==
125 +== 2.3 Information Model ==
126 126  
127 127  (((
128 128  (% style="width:955.039px" %)
... ... @@ -177,7 +177,7 @@
177 177  
178 178  = 3 Information Model =
179 179  
180 -== //3.1 Version 3.0 Information Model// ==
180 +== 3.1 Version 3.0 Information Model ==
181 181  
182 182  [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_6fc573fe.png||height="404" width="718"]]
183 183  
... ... @@ -187,7 +187,7 @@
187 187  
188 188  A number of ancillary structures including organisation schemes, process and reporting taxonomy are unchanged and have not been shown. Similarly, Organisation Scheme Map and Reporting Taxonomy Map have been omitted for simplicity. A schematic of the 2.1 model is given in Appendix A for comparison purposes.
189 189  
190 -== //3.2 Key Changes from Version 2.1// ==
190 +== 3.2 Key Changes from Version 2.1 ==
191 191  
192 192  New Maintainable Artefacts
193 193  
... ... @@ -230,7 +230,7 @@
230 230  
231 231  * GeospatialInformation – a string type where the value is an expression defining a set of geographical features using a purpose-designed syntax
232 232  
233 -== //3.3 Areas Unchanged from Version 2.1// ==
233 +== 3.3 Areas Unchanged from Version 2.1 ==
234 234  
235 235  The following areas of the information model are unchanged from version 2.1:
236 236  
... ... @@ -243,7 +243,7 @@
243 243  * Reporting taxonomy
244 244  * Process
245 245  
246 -== //3.4 Reference Metadata// ==
246 +== 3.4 Reference Metadata ==
247 247  
248 248  Reference metadata has been substantially re-designed for version 3.0 to simplify the model and better support practical use cases.
249 249  
... ... @@ -271,86 +271,47 @@
271 271  * TITLE – a multi-lingual data attribute
272 272  * SOURCE_AGENCY – a multi-value data attribute
273 273  
274 -<Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09">
274 +> <Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09">
275 +> <!—- complex multi-value and multi-lingual data attributes ~-~->
276 +> <Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE">
277 +> <Value>
278 +> <common:Text xml:lang="en">Some English Text</common:Text>
279 +> <common:Text xml:lang="fr">Quelques textes en anglais</common:Text>
280 +> </Value>
281 +> </Comp>
282 +> <Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE">
283 +> <Value>4F0</Value>
284 +> <Value>4D0</Value>
285 +> <Value>CZ2</Value>
286 +> </Comp>
287 +> <!—- metadata attributes are reported like in metadata messages ~-~->
288 +> <Metadata>
289 +> <Attribute id="COLLECTION">
290 +> <Attribute id="METHOD">
291 +> <Text lang="en">AAA</Text>
292 +> </Attribute>
293 +> </Attribute>
294 +> <Attribute id="CONTACT">
295 +> <Value>CONTACT 1</Value>
296 +> <Attribute id="NAME">
297 +> <Value>Contact 1 Name 1</Value>
298 +> </Attribute>
299 +> <Attribute id="NAME">
300 +> <Value>Contact 1 Name 2</Value>
301 +> </Attribute>
302 +> </Attribute>
303 +> <Attribute id="CONTACT">
304 +> <Value>CONTACT 2</Value>
305 +> <Attribute id="NAME">
306 +> <Value>Contact 2 Name 1</Value>
307 +> </Attribute>
308 +> <Attribute id="NAME">
309 +> <Value>Contact 2 Name 2</Value>
310 +> </Attribute>
311 +> </Attribute>
312 +> </Metadata>
313 +> </Obs>
275 275  
276 -<!—- complex multi-value and multi-lingual data attributes ~-~->
277 -
278 -<Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE">
279 -
280 -<Value>
281 -
282 -<common:Text xml:lang="en">Some English Text</common:Text>
283 -
284 -<common:Text xml:lang="fr">Quelques textes en anglais</common:Text>
285 -
286 -</Value>
287 -
288 -</Comp>
289 -
290 -<Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE">
291 -
292 -<Value>4F0</Value>
293 -
294 -<Value>4D0</Value>
295 -
296 -<Value>CZ2</Value>
297 -
298 -</Comp>
299 -
300 -<!—- metadata attributes are reported like in metadata messages ~-~->
301 -
302 -<Metadata>
303 -
304 -<Attribute id="COLLECTION">
305 -
306 -<Attribute id="METHOD">
307 -
308 -<Text lang="en">AAA</Text>
309 -
310 -</Attribute>
311 -
312 -</Attribute>
313 -
314 -<Attribute id="CONTACT">
315 -
316 -<Value>CONTACT 1</Value>
317 -
318 -<Attribute id="NAME">
319 -
320 -<Value>Contact 1 Name 1</Value>
321 -
322 -</Attribute>
323 -
324 -<Attribute id="NAME">
325 -
326 -<Value>Contact 1 Name 2</Value>
327 -
328 -</Attribute>
329 -
330 -</Attribute>
331 -
332 -<Attribute id="CONTACT">
333 -
334 -<Value>CONTACT 2</Value>
335 -
336 -<Attribute id="NAME">
337 -
338 -<Value>Contact 2 Name 1</Value>
339 -
340 -</Attribute>
341 -
342 -<Attribute id="NAME">
343 -
344 -<Value>Contact 2 Name 2</Value>
345 -
346 -</Attribute>
347 -
348 -</Attribute>
349 -
350 -</Metadata>
351 -
352 -</Obs>
353 -
354 354  === New - Metadata Provision Agreement ===
355 355  
356 356  In version 2.1 a Provision Agreement could be used to report information against a Dataflow or Metadataflow. From version 3.0 this is managed by two separate structures, the Data Provision Agreement and the Metadata Provision Agreement.
... ... @@ -363,7 +363,7 @@
363 363  
364 364  A Metadataset now has mandatory identification information, (owner id, id, version) enabling metadata providers to uniquely identify their reports for create, update or delete maintenance operations.
365 365  
366 -== //3.5 Microdata Exchange// ==
327 +== 3.5 Microdata Exchange ==
367 367  
368 368  Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series.
369 369  
... ... @@ -376,31 +376,18 @@
376 376  MeasureDimension behaviour as illustrated in the SDMX-ML example below:
377 377  
378 378  <str:MeasureList id=”MeasureDescriptor”>
379 -
380 380  <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
381 -
382 382  <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
383 -
384 384  </str:ConceptIdentity>
385 -
386 386  <str:LocalRepresentation>
387 -
388 388  <str:TextFormat textType=”String” isMultiLingual=”true” />
389 -
390 390  </str:LocalRepresentation>
391 -
392 392  <str:ConceptRole>
393 -
394 394  <Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
395 -
396 396  </str:ConceptRole>
397 -
398 398  </str:Measure>
399 -
400 400  ...
401 -
402 402  <str:Measure>
403 -
404 404  </str:MeasureList>
405 405  
406 406  === Multi-value measures and attributes ===
... ... @@ -421,7 +421,7 @@
421 421  
422 422  That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but 208 also means they are not identifiable.
423 423  
424 -== //3.6 Geospatial Data Exchange// ==
372 +== 3.6 Geospatial Data Exchange ==
425 425  
426 426  The version 3.0 model has been extended to provide explicit support for geospatial data.
427 427  
... ... @@ -436,13 +436,13 @@
436 436  * GeographicCodelist – each item includes an element to represent a specific Geo Feature Set which is described using the same expression syntax as for GeospatialInformation type.
437 437  * GeoGridCodelist – A code list defining a geographical grid composed of cells representing regular squared portions of the Earth. Each item references a cell within the grid.
438 438  
439 -=== //3.7 Structure Mapping// ===
387 +== 3.7 Structure Mapping ==
440 440  
441 441  The Structure Set in version 2.1 is a container for many mapping structures including Data Structure Map, Codelist Map and Concept Map. For version 3.0 the Structure Set artefact has been deprecated and replaced with a number of new maintainables giving better flexibility and reusability, specifically: Structure Map, Concept Scheme Map, Representation Map, Reporting Taxonomy Map, Category Scheme Map and Organisation Scheme Map.
442 442  
443 443  The version 2.1 Codelist Map been replaced with Representation Map which allows mappings to be defined between any combination of Code Lists, Value Lists and noncoded representations such as text strings and numbers.
444 444  
445 -==== Many-to-many source and target components ====
393 +=== Many-to-many source and target components ===
446 446  
447 447  Structure mapping rules may be defined with both multiple source components and multiple target components in contrast to version 2.1 where only one source and target was allowed. That supports many-to-many (n-n) mapping use cases where the output of a mapping rule may be dependent on the combination of a number of input components. For instance:
448 448  
... ... @@ -456,19 +456,19 @@
456 456  
457 457  The Structure Map may now define input or output components which have a fixed value.
458 458  
459 -==== Time representations mapping ====
407 +=== Time representations mapping ===
460 460  
461 461  Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats.
462 462  
463 -==== Regular expression and substring mappings ====
411 +=== Regular expression and substring mappings ===
464 464  
465 465  All item maps allow the use of regular expressions and substrings to match source values, specifically: Concept Scheme Map, Reporting Taxonomy Map, Category Scheme Map and Organisation Scheme Map.
466 466  
467 -==== Item maps validity period ====
415 +=== Item maps validity period ===
468 468  
469 469  Item maps may further define the period for which the mapping is valid, meaning the mapping rule will only be applied if the row of information being mapped is within the period.
470 470  
471 -=== //3.8 Constraints// ===
419 +== 3.8 Constraints ==
472 472  
473 473  Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint:
474 474  
... ... @@ -483,17 +483,17 @@
483 483  
484 484  Attachment constraints have been deprecated due to a lack of use cases.
485 485  
486 -=== //3.9 Code List Extension// ===
434 +== 3.9 Code List Extension ==
487 487  
488 488  In addition to the two new specialised geospatial forms, the option has been added to define a code list as an extension of, or by inheriting codes from, other lists. An optional prefix can be added to inherited codes to disambiguate duplicates.
489 489  
490 490  This feature allows new code lists to be easily derived from existing lists without the need to make and manually maintain copies. When querying for extended code list structures using the REST API, the option has been added to retrieve either the definition or the materialised list. Traditional literal lists of codes continue to be supported.
491 491  
492 -=== //3.10 Discriminated Union of Code Lists// ===
440 +== 3.10 Discriminated Union of Code Lists ==
493 493  
494 494  Combining code list extension with wildcarded constraints solves the discriminated union of code lists problem where a classification or breakdown has multiple “variants” which are all valid but mutually exclusive. A common example is economic activity where several alternative classification schemes are in use including ISIC revisions 1 to 4 and NACE as used in the European Community.
495 495  
496 -=== //3.11 Code Hierarchies// ===
444 +== 3.11 Code Hierarchies ==
497 497  
498 498  Code hierarchies allow the definition of complex hierarchies of codes from potentially multiple lists for data discovery purposes. Hierarchical Codelist has been deprecated and replaced by two new artefacts: Hierarchy – the actual hierarchy of codes, and Hierarchy Association links hierarchies directly to any other identifiable object, a capability missing 312 from the version 2.1 model. Further, the linkage can be within a particular context, for instance linking a hierarchy to a dimension within the context of a specific Dataflow (dimension REF_AREA in the context of the ECB:EXR Dataflow).
499 499  
... ... @@ -541,7 +541,7 @@
541 541  
542 542  = 5 REST Web Services API =
543 543  
544 -== //5.1 Simplified list of resources// ==
492 +== 5.1 Simplified list of resources ==
545 545  
546 546  The version 3.0 REST API has just five main resources:
547 547  
... ... @@ -555,7 +555,7 @@
555 555  
556 556  This and changes in the URLs and query parameters on the data, availability and metadata resources means that, with the exception of schema queries, the version 3.0 API is not backwardly compatible.
557 557  
558 -== //5.2 Improved data queries// ==
506 +== 5.2 Improved data queries ==
559 559  
560 560  Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
561 561  
... ... @@ -594,7 +594,7 @@
594 594  
595 595  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
596 596  
597 -== //5.3 Improved reference metadata queries// ==
545 +== 5.3 Improved reference metadata queries ==
598 598  
599 599  Reference metadata queries have been improved with a number of new options to retrieve metadata reports.
600 600  
... ... @@ -610,7 +610,7 @@
610 610  
611 611  /metadata/structure/datastructure/BIS/BIS_CBS/1.0
612 612  
613 -== //5.4 Structural metadata maintenance// ==
561 +== 5.4 Structural metadata maintenance ==
614 614  
615 615  Support has been added for maintenance of structural metadata.
616 616  
... ... @@ -618,7 +618,7 @@
618 618  
619 619  = 6 XML, JSON, CSV and EDI Transmission formats =
620 620  
621 -== //6.1 SDMX-ML// ==
569 +== 6.1 SDMX-ML ==
622 622  
623 623  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.
624 624  
... ... @@ -704,7 +704,7 @@
704 704  
705 705  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.
706 706  
707 -== //6.2 SDMX-JSON// ==
655 +== 6.2 SDMX-JSON ==
708 708  
709 709  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.
710 710  
... ... @@ -724,7 +724,7 @@
724 724  
725 725  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.
726 726  
727 -== //6.3 SDMX-CSV// ==
675 +== 6.3 SDMX-CSV ==
728 728  
729 729  CSV in SDMX is used transmission of data and reference metadata only.
730 730  
... ... @@ -742,7 +742,7 @@
742 742  
743 743  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.
744 744  
745 -=== //6.4 EDI deprecation// ===
693 +=== 6.4 EDI deprecation ===
746 746  
747 747  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.
748 748