These API operations support requests for catalogues of data and SDMX lists of structural metadata and data.
SDMX 2.1 endpoint - SDMX lists of structural metadata and data
This is the REST request for retrieving the list of all structural metadata from the SDMX 2.1 endpoint:
https://<api_base_uri>/sdmx/2.1/<resource>/<agencyID>/all?detail=<details> |
where
Parameter | Description |
api_base_uri | |
resource | Following resources are supported: |
agencyID | |
Optional | Description |
details | Specify the scope: |
completestubs | true to return the name, description and annotations of each item |
as illustrated by
Examples |
SDMX 2.1 endpoint - SDMX lists i.e. tree of data for classification purposes
SDMX provides a metamodel for describing data in any statistical domain:
A category scheme is a container for categories, which can be organized in a tree hierarchy.
Categories in SDMX are used to classify Dataflows;
Each of the dataflows can be connected to one or more categories, and
Any one category can be connected to zero or more dataflows.
This connection supports data discovery by organised topics, e.g. Economy and finance, Population and social conditions, Industry, trade and services etc.
A categorisation links a category in a Category Scheme to any other Identifiable structure in SDMX. Typically in a dissemination environment a categorisation would link a Category to a Dataflow.
SDMX 2.1 - REST - All Category Schemes - All categorisations
The request is the same as for retrieving the list of all structural metadata:
https://<api_base_uri>/sdmx/2.1/<resource>/<agencyID>/all |
where
Parameter | Description |
api_base_uri | |
resource | Following resources are supported: |
agencyID |
Note that there is no detail parameter for resources 'categoryscheme' and 'categorisation'.
Examples |
SDMX 2.1 - REST - Category Scheme - Categorisation
The request is the same as for retrieving other structural metadata:
https://<api_base_uri>/sdmx/2.1/<resource>/<agencyID>/<resourceID> |
where
Parameter | Description |
api_base_uri | |
resource | Following resources are supported: |
agencyID | |
resourceID | The identifier of the resource |
as illustrated by
Examples |