Cette page documente des fonctionnalités plus avancées pour les requêtes concernant les données. Il est recommandé de lire tout d’abord la page API SDMX 2.1 - Requête sur les données.
La syntaxe de la requête REST SDMX 2.1 pour les données est:
https://<api_base_uri>/sdmx/2.1/<resource>/<flowRef>/<key>?<parameters> |
Chaque section de cette page détaille les filtres utilisables avec cette syntaxe.
SDMX 2.1 - REST - Filtrage des données sur la dimension
Requête |
La clé est construite comme une liste de valeurs filtrées de dimensions, séparées par des points ('.').
Elle s’élabore comme suit:
Obtenir la liste des flux de données pour identifier le flux de données souhaité.
Ensuite, télécharger la structure des données avec la résolution des références pour les enfants pour le flux de données en question, et vérifier la liste des dimensions.
Chaque dimension supporte des valeurs issues de la définition de la liste de codes associée à la dimension.
Par exemple, la définition de la structure de donnée pour NAMA_10_GDP énumère 4 dimensions, dans cet ordre:
FREQ comprenant des valeurs issues de la liste de codes FREQ
UNIT comprenant des valeurs issues de la liste de codes UNIT
NA_ITEM comprenant des valeurs issues de la liste de codes NA_ITEM
GEO comprenant des valeurs issues de la liste de codes GEO
Pour NAMA_10_GDP, la clé [FREQ].[UNIT].[NA_ITEM].[GEO], dans l’ordre exact des dimensions tel que défini par la structure de définition des données (DSD), peut par exemple être A.CP_MEUR.B1GQ.LU, où :
Position | 1 | 2 | 3 | 4 |
|---|---|---|---|---|
Dimension | FREQ | UNIT | NA_ITEM | GEO |
Valeur de la clé | A | CP_MEUR | B1GQ | LU |
Signification | Données agrégées annuellement | Prix courants, en million d’euros | Produit intérieur brut aux prix du marché | Luxembourg |
Les dimensions qui ne devraient pas être filtrées sont laissées vides dans la requête. Pour NAMA_10_GDP, la clé sans filtre sur la dimension FREQ peut être: .CP_MEUR.B1GQ.LU
Il est possible d’utiliser une conjonction logique à l’aide du caractère '+'. Pour NAMA_10_GDP, la clé peut être: A.CP_MEUR.B1GQ.BE+LU
SDMX 2.1 - REST - Filtrage des données sur le temps
Cela permet le filtrage des données des observations issues d’une série temporelle sur base de dates de début et de fin.
Requête |
Le début et la fin de la période temporelle fournie dans le filtre sont les valeurs attribuées respectivement à startPeriod et à endPeriod. Les formats de périodes de temps suivantes sont supportées:
Dans le tableau qui suit, "YYYY" représente l’année civile, représentée sur 4 chiffres. Exemple: 2018
| Période | Format |
|---|---|
Annuel | YYYY-A1 ou YYYY |
Semestriel | YYYY-S[1-2] |
Trimestriel | YYYY-Q[1-4] |
Mensuel | YYYY-M[01-12] or YYYY-[01-12] |
Hebdomadaire | YYYY-W[01-53] |
Journalier | YYYY-D[001-366] |
Intervalle d’années | YYYY/P[01-99]Y |
comme illustré par:
Filtrer les observations annuelles de NAMA_10_GDP sur une période comprise entre 2012 et 2015 |
SDMX 2.1 - REST - Filtrage des données aux N premières et N dernières observations
Cela permet de filtrer les observations d’une série temporelle en limitant le nombre d’observations retournées.
Requête |
Ce filtre peut être appliqué à une donnée qui a été filtrée sur base des dimensions et/ou du temps
Les N premières observations: Renvoie les N premières observations de la série correspondante
Les N dernières observations: Renvoie les N dernières observations de la série correspondante
Ces deux restrictions peuvent être appliquées simultanément, par exemple afin de renvoyer les N premières et N dernières observations d’une série.
Si le filtre est incorrectement formulé, la réponse renvoyée ne comprendra aucune donnée.
Filtrer NAMA_10_GDP et conserver uniquement les 5 dernières observations annuelles |
SDMX 2.1 - REST - Détails relatifs aux données
Requête |
comme illustré par
NAMA_10_GDP avec uniquement les données |
SDMX 2.1 - REST - Filtrage des données basé sur la classification NUTS
Cette fonctionnalité n'est pas encore disponible.Le filtrage au niveau NUTS peut être fait pour des ensembles de données régionaux ; les ensembles de données dont la longeur du code de la dimension GEO est supérieur à 2.
Si le filtre est appliqué sur des ensembles de données non régionaux, la réponse à la requête contient toutes les valeurs de la dimension GEO, à l’exception des pays.
Cela permet de filtrer sur la dimension GEO en fonction des classifications des codes NUTS 2016 à différents niveaux, voir cette page pour référence.
Requête |