...
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
...
Usage of wildcard '*' is not allowed for the artefactType parameter and the version parameter
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
...
none | no references will be returned | default | |
---|---|---|---|
parents | the artefacts that use the artefact matching the query | CS +DS | |
parentsandsiblings | the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts | CS +DS + CL CL := children(DS) union children(CD) | |
children | artefacts referenced by the artefact to be returned | ||
descendants | references of references, up to any level, will also be returned | ||
all | the combination of parentsandsiblings and descendants |
...
Reference | Description | Supported | Explanation |
---|
For Concept scheme
none | no references will be returned | default | |
---|---|---|---|
parents | the artefacts that use the artefact matching the query | CS +DS | |
parentsandsiblings | the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts | CS +DS + CL CL := children(DS) union children(CD) | |
children | artefacts referenced by the artefact to be returned | ||
descendants | references of references, up to any level, will also be returned | ||
all | the combination of parentsandsiblings and descendants | ||
Reference | Description | Supported | Explanation |
For datastructure
Reference | Description | Supported | Explanation |
---|---|---|---|
none | no references will be returned | default | |
parents | the artefacts that use the artefact matching the query | DS +DF | |
parentsandsiblings | the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts | DS +DF | |
children | artefacts referenced by the artefact to be returned | DS + CS + CL | |
descendants | references of references, up to any level, will also be returned | DS + CS + CL:X, CL:GEO, CL:Y CL := children(DS) union children(CS) | |
all | the combination of parentsandsiblings and descendants | DS + DF+ CS + CL:X, CL:GEO, CL:Y |
...