Child pages
  • API - Detailed guidelines - SDMX3.0 API - structure queries

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Structure queries in SDMX allow you to retrieve structural metadata at various levels of granularity, from all structural metadata available in the source to a single code from a particular version of a particular codelist maintained by a particular agency.

Query URL syntax

Generic syntax is the following

...

Usage of multiple values is not supported, please make one request per resource

Main usage of wildcard '*' is with the resourceID parameter to retrieve a "catalog" of content.

Main query is about getting the dataset catalog by requesting the list of all dataflows with the following query

...

(warning) Usage of wildcard '*' is not allowed for the artefactType parameter and the version parameter(warning) Usage of wildcard '*' is not allowed for the version artefactType parameter

Info

For non versioned artefacts (dataflow, dataconstraints) the version value "1.0", "*" or "~" are equivalents

...

Reference parameter support

For Code list

...

noneno references will be returned(tick) supporteddefault
parents the artefacts that use the artefact matching the query(tick) supportedCS +DS
parentsandsiblingsthe artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts(tick) supported

CS +DS + CL

CL := children(DS) union children(CD)

childrenartefacts referenced by the artefact to be returned(warning) not supported
descendantsreferences of references, up to any level, will also be returned(warning) not supported
allthe combination of parentsandsiblings and descendants(warning) not supported

...


Reference DescriptionSupportedExplanation

For Concept scheme

noneno references will be returned(tick) supporteddefault
parents the artefacts that use the artefact matching the query(tick) supportedCS +DS
parentsandsiblingsthe artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts(tick) supported

CS +DS + CL

CL := children(DS) union children(CD)

childrenartefacts referenced by the artefact to be returned(warning) not supported
descendantsreferences of references, up to any level, will also be returned(warning) not supported
allthe combination of parentsandsiblings and descendants(warning) not supported
Reference DescriptionSupportedExplanation

For datastructure


Reference DescriptionSupportedExplanation
noneno references will be returned(tick) supporteddefault
parents the artefacts that use the artefact matching the query(tick) supportedDS +DF
parentsandsiblingsthe artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts(tick) supportedDS +DF
childrenartefacts referenced by the artefact to be returned(tick) supportedDS + CS + CL
descendantsreferences of references, up to any level, will also be returned(tick) supported

DS + CS +

CL:X, CL:GEO, CL:Y

CL := children(DS) union children(CS)

allthe combination of parentsandsiblings and descendants(tick) supported

DS + DF+  CS +

CL:X, CL:GEO, CL:Y

...