Child pages
  • API SDMX 2.1 - Requête sur les données

Il est important de se rappeler que seule la dernière version de chaque observation statistique est rendue disponible dans le système. Lors de la mise à jour d’une observation statistique, la valeur précédente de l’observation est perdue et ne peut pas être renvoyée.

En fonction de la demande soumise, une requête portant sur les données peut renvoyer une réponse potentiellement très conséquente, auquel cas les données sont délivrées en mode asynchrone. Pour davantage d’informations à ce sujet, merci de consulter la section "Points de terminaison ASYNC pour réception de réponses asynchrones" de la page 'API - Démarrage'

La syntaxe de la requête REST SDMX 2.1 pour les données est la suivante:

https://<api_base_uri>/sdmx/2.1/<resource>/<flowRef>/<key>/<parameters>

Paramètre

Description

api_base_uri

Voir définition de api_base_uri

resource

La ressource suivante est supportée: data

flowRef

L’identifiant de la référence du flux de données.
Exécuter une requête de découverte de données sur les métadonnées pour tous les flux de données pour obtenir une liste de toutes les références du flux de données.

Optionnel

Description

key

La clé dans la requête est construite comme une liste de valeurs filtrées des dimensions, chaque valeur étant séparée des autres valeurs par un point ('.').
Voir aussi Filtrage des données sur les dimensions

Paramètres

De multiples paramètres peuvent être combinés en utilisant le caractère '&'.


Format
format=<value>
Permet d’obtenir les réponses dans un format autre que le format générique SDMX-ML 2.1, qui est le format par défaut.
Les valeurs supportées sont:
SDMX_2.1_STRUCTURED for SDMX-ML 2.1 Structure Specific Data
SDMX-CSV pour le format plat SDMX-CSV
JSON pour le format JSON-stat
TSV pour le format TSV (Valeurs séparées par une tabulation)


Filtrage des données sur le temps
startPeriod=<value>&endPeriod=<value>
Voir aussi filtrage des données sur le temps


Filtrage des données sur les premières N et les dernières X observations
firstNObservations=<value>&lastNObservations=<value>
Voir aussi filtrage des données sur les premières N et les dernières N observations


Détails
detail=<value>
Pour obtenir les réponses avec les détails.
Les valeurs supportées sont:
dataonly pour chaque série, seules les observations sont renvoyées, les attributs ne le sont pas.
serieskeysonly pour chaque série, seules les clés des séries sont renvoyées, ni les données ni les attributs ne le sont
nodata pour chaque série, seul les attributs applicables au niveau de la série sont renvoyés
Voir aussi détails sur les données


Compression
compressed=true
Pour obtenir les réponses au format .gz

Point de terminaison SDMX 2.1 - REST - Format SDMX-ML 2.1 (données génériques)

Pour retrouver les données au format de données générique SDMX-ML avec REST via le point de terminaison SDMX 2.1:

Habituellement, dans toute requête SDMX REST Data, il existe un paramètre dimensionAtObservation, qui peut avoir l’une de ces deux valeurs:

  • TIME_PERIOD: Ceci renverra une vue chronologique des données, c’est-à-dire des données pivotées (en coupe transversale).

  • AllDimensions: Ceci retournera une vue "à plat" des données, sans regroupement.

Cependant, cette API définit automatiquement dimensionAtObservation sur TIME_PERIOD. Dès lors, s’il est nécessaire d’obtenir les données dans un format plat, il convient d’utiliser le format SDMX-CSV disponible dans l’API.

Point de terminaison SDMX 2.1 - REST - Format SDMX-ML 2.1 (données spécifiques à la structure)

Le schéma spécifique à la structure est la meilleure option pour traiter de grandes quantités de données.

Pour retrouver les données au format spécifique à la structure SDMX-ML avec REST via le point de terminaison SDMX 2.1:

Habituellement, dans toute requête SDMX REST Data, il existe un paramètre dimensionAtObservation, qui peut avoir l’une de ces deux valeurs:

  • TIME_PERIOD: Ceci renverra une vue chronologique des données, c’est-à-dire des données pivotées (en coupe transversale).

  • AllDimensions: Ceci retournera une vue "à plat" des données, sans regroupement.

Cependant, cette API définit automatiquement dimensionAtObservation sur TIME_PERIOD. Dès lors, s’il est nécessaire d’obtenir les données dans un format plat, il convient d’utiliser le format SDMX-CSV disponible dans l’API.

Point de terminaison SDMX 2.1 - REST - Format SDMX-CSV

En SDMX-CSV, la réponse contient les données affichées dans un format plat. Il inclut les codes, et non les libellés, des positions des dimensions. Les libellés correspondant aux codes peuvent être obtenus en requérant le flux de données ou la définition de la structure de données grâce à la résolution de références.

Pour retrouver les données au format SDMX-CSV en utilisant REST via le point de terminaison SDMX 2.1.

Point de terminaison SDMX 2.1 - REST - Format JSON-stat

En JSON-stat, la réponse inclut les libellés, et pas les codes, des positions des dimensions

Il est obligatoire de spécifier la langue lorsqu’il est fait appel au format JSON-stat pour les données

Pour retrouver les données au format JSON-stat en anglais, en utilisant REST via le point de terminaison SDMX 2.1:

Point de terminaison SDMX 2.1 - REST - Format TSV

En TSV, la réponse inclut les codes, et non les libellés, des positions des dimensions. Les libellés correspondant aux codes peuvent être obtenus en requérant le flux de données ou la définition de la structure de données grâce à la résolution des références.

Pour retrouver les données au format TSV en utilisant REST via le point de terminaison SDMX 2.1.

_