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

From version 13.4
edited by Helena
on 2025/05/14 15:06
Change comment: There is no comment for this version
To version 9.1
edited by Helena
on 2025/05/14 13:42
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,47 +271,86 @@
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">
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>
274 +<Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09">
314 314  
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 +
315 315  === New - Metadata Provision Agreement ===
316 316  
317 317  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.
... ... @@ -324,7 +324,7 @@
324 324  
325 325  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.
326 326  
327 -== 3.5 Microdata Exchange ==
366 +== //3.5 Microdata Exchange// ==
328 328  
329 329  Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series.
330 330  
... ... @@ -337,18 +337,31 @@
337 337  MeasureDimension behaviour as illustrated in the SDMX-ML example below:
338 338  
339 339  <str:MeasureList id=”MeasureDescriptor”>
379 +
340 340  <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
381 +
341 341  <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
383 +
342 342  </str:ConceptIdentity>
385 +
343 343  <str:LocalRepresentation>
387 +
344 344  <str:TextFormat textType=”String” isMultiLingual=”true” />
389 +
345 345  </str:LocalRepresentation>
391 +
346 346  <str:ConceptRole>
393 +
347 347  <Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
395 +
348 348  </str:ConceptRole>
397 +
349 349  </str:Measure>
399 +
350 350  ...
401 +
351 351  <str:Measure>
403 +
352 352  </str:MeasureList>
353 353  
354 354  === Multi-value measures and attributes ===
... ... @@ -369,7 +369,7 @@
369 369  
370 370  That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but 208 also means they are not identifiable.
371 371  
372 -== 3.6 Geospatial Data Exchange ==
424 +== //3.6 Geospatial Data Exchange// ==
373 373  
374 374  The version 3.0 model has been extended to provide explicit support for geospatial data.
375 375  
... ... @@ -384,13 +384,13 @@
384 384  * 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.
385 385  * 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.
386 386  
387 -== 3.7 Structure Mapping ==
439 +=== //3.7 Structure Mapping// ===
388 388  
389 389  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.
390 390  
391 391  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.
392 392  
393 -=== Many-to-many source and target components ===
445 +==== Many-to-many source and target components ====
394 394  
395 395  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:
396 396  
... ... @@ -404,19 +404,19 @@
404 404  
405 405  The Structure Map may now define input or output components which have a fixed value.
406 406  
407 -=== Time representations mapping ===
459 +==== Time representations mapping ====
408 408  
409 409  Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats.
410 410  
411 -=== Regular expression and substring mappings ===
463 +==== Regular expression and substring mappings ====
412 412  
413 413  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.
414 414  
415 -=== Item maps validity period ===
467 +==== Item maps validity period ====
416 416  
417 417  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.
418 418  
419 -== 3.8 Constraints ==
471 +=== //3.8 Constraints// ===
420 420  
421 421  Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint:
422 422  
... ... @@ -431,17 +431,17 @@
431 431  
432 432  Attachment constraints have been deprecated due to a lack of use cases.
433 433  
434 -== 3.9 Code List Extension ==
486 +=== //3.9 Code List Extension// ===
435 435  
436 436  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.
437 437  
438 438  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.
439 439  
440 -== 3.10 Discriminated Union of Code Lists ==
492 +=== //3.10 Discriminated Union of Code Lists// ===
441 441  
442 442  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.
443 443  
444 -== 3.11 Code Hierarchies ==
496 +=== //3.11 Code Hierarchies// ===
445 445  
446 446  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).
447 447  
... ... @@ -489,7 +489,7 @@
489 489  
490 490  = 5 REST Web Services API =
491 491  
492 -== 5.1 Simplified list of resources ==
544 +== //5.1 Simplified list of resources// ==
493 493  
494 494  The version 3.0 REST API has just five main resources:
495 495  
... ... @@ -503,7 +503,7 @@
503 503  
504 504  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.
505 505  
506 -== 5.2 Improved data queries ==
558 +== //5.2 Improved data queries// ==
507 507  
508 508  Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
509 509  
... ... @@ -542,7 +542,7 @@
542 542  
543 543  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
544 544  
545 -== 5.3 Improved reference metadata queries ==
597 +== //5.3 Improved reference metadata queries// ==
546 546  
547 547  Reference metadata queries have been improved with a number of new options to retrieve metadata reports.
548 548  
... ... @@ -558,7 +558,7 @@
558 558  
559 559  /metadata/structure/datastructure/BIS/BIS_CBS/1.0
560 560  
561 -== 5.4 Structural metadata maintenance ==
613 +== //5.4 Structural metadata maintenance// ==
562 562  
563 563  Support has been added for maintenance of structural metadata.
564 564  
... ... @@ -566,7 +566,7 @@
566 566  
567 567  = 6 XML, JSON, CSV and EDI Transmission formats =
568 568  
569 -== 6.1 SDMX-ML ==
621 +== //6.1 SDMX-ML// ==
570 570  
571 571  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.
572 572  
... ... @@ -652,7 +652,7 @@
652 652  
653 653  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.
654 654  
655 -== 6.2 SDMX-JSON ==
707 +== //6.2 SDMX-JSON// ==
656 656  
657 657  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.
658 658  
... ... @@ -672,7 +672,7 @@
672 672  
673 673  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.
674 674  
675 -== 6.3 SDMX-CSV ==
727 +== //6.3 SDMX-CSV// ==
676 676  
677 677  CSV in SDMX is used transmission of data and reference metadata only.
678 678  
... ... @@ -690,7 +690,7 @@
690 690  
691 691  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.
692 692  
693 -=== 6.4 EDI deprecation ===
745 +=== //6.4 EDI deprecation// ===
694 694  
695 695  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.
696 696