Web Services - Les valeurs d'une donnée stockée

View the English version.

Description

Chaque donnée stockée est constituée d’une collection de valeurs.

URI	<uri_donnee>/valeurs
Catégorie	http://schemas.holydis.com/tsq/2010#valeur
Disponible en écriture	Oui

Paramètres spécifiques

Paramètre	Description
datetime-min	Filtre les valeurs de données saisies qui concernent des périodes après la date spécifiée ou le même jour.
datetime-max	Filtre les valeurs de données saisies qui concernent des périodes avant la date spécifiée ou le même jour.

Eléments

Elément	Description	En écriture
periode	La période de temps couverte par la valeur. Par défaut, la lecture des valeurs se fait sur la période de saisie des valeurs de la donnée stockée intégrant la date de jour. Si une période de restriction est apposée à la requête, la lecture des valeurs se fait sur la ou les périodes de saisie des valeurs de la donnée stockée intégrant cette période de restriction.	Obligatoire
timeZoneId	L’identifiant de fuseau horaire. Exemple : Europe/Paris. Pour lire les données en fonction du fuseau horaire de Europe/Lisbonne, il faut ajouter en en-tête de la requête le paramètre User-TimeZoneId avec comme valeur l’identifiant du fuseau de Lisbonne, en l’occurrence Europe/Lisbonne. En l’absence du paramètre en en-tête, les données sont renvoyées brutes (dans le fuseau horaire de la ressource).	L'écriture se fait toujours dans le fuseau horaire de la ressource.
valeur	La valeur.	Obligatoire

Exemples de requêtes

Lecture

Lire toutes les valeurs d’une donnée stockée dont l’identifiant en base est 2009

GET /[URI_de_base]/api/feed/donnees/2009/valeurs

Lire les valeurs d’une donnée stockée dont l’identifiant en base est 2009 pour une période donnée (du 01/12/2020 au 31/12/2020)

GET /[URI_de_base]/api/feed/donnees/2009/valeurs?datetime-min=2020-12-01&datetime-max=2020-12-31

Lire la valeur d’une donnée stockée (avec un mode de saisie GRANULARITE) dont l’identifiant en base est 2009 pour une date et une tranche données (30/12/2020 sur la tranche 19:30-19:45)

GET /[URI_de_base]/api/feed/donnees/2009/valeurs/2020-12-30 19:30

Exemple de résultat XML de la requête

Exemple de résultat JSON de la requête

Lire la valeur d’une donnée stockée (avec un mode de saisie 5 minutes) dont l’identifiant en base est 47001 pour une date et une tranche données (30/12/2020 sur la tranche 19:05-19:10)

GET /[URI_de_base]/api/feed/donnees/47001/valeurs/2020-12-30 19:05

Lire la valeur d’une donnée stockée (avec un mode de saisie 10 minutes) dont l’identifiant en base est 47002 pour une date et une tranche données (30/12/2020 sur la tranche 19:00-19:10)

GET /[URI_de_base]/api/feed/donnees/47002/valeurs/2020-12-30 19:00

Lire la valeur d’une donnée stockée (avec un mode de saisie 15 minutes) dont l’identifiant en base est 47003 pour une date et une tranche données (30/12/2020 sur la tranche 18:00-18:15)

GET /[URI_de_base]/api/feed/donnees/47003/valeurs/2020-12-30 18:00

Lire la valeur d’une donnée stockée (avec un mode de saisie 30 minutes) dont l’identifiant en base est 47004 pour une date et une tranche données (30/12/2020 sur la tranche 17:30-18:00)

GET /[URI_de_base]/api/feed/donnees/47004/valeurs/2020-12-30 17:30

Lire la valeur d’une donnée stockée (avec un mode de saisie CRENEAU) dont l’identifiant en base est 47000 pour une date et un créneau donnés (30/12/2020 sur le créneau 09:00-12:00)

GET /[URI_de_base]/api/feed/donnees/47000/valeurs/2020-12-30 09:00

Lire la valeur d’une donnée stockée (avec un mode de saisie HEURE) dont l’identifiant en base est 18004 pour une date donnée (30/12/2020 sur l'heure 09:00-10:00)

GET /[URI_de_base]/api/feed/donnees/18004/valeurs/2020-12-30 09:00

Lire la valeur d’une donnée stockée (avec un mode de saisie JOUR et une heure de changement de jour à 01:00) dont l’identifiant en base est 18000 pour une date donnée (30/12/2020)

GET /[URI_de_base]/api/feed/donnees/18000/valeurs/2020-12-30 01:00

Lire la valeur d’une donnée stockée (avec un mode de saisie SEMAINE et une heure de changement de jour à 02:00) dont l’identifiant en base est 18001 pour une semaine donnée (du 21/12/2020 au 27/12/2020)

GET /[URI_de_base]/api/feed/donnees/18001/valeurs/2020-12-21 02:00

Lire la valeur d’une donnée stockée (avec un mode de saisie MOIS et une heure de changement de jour à 03:00) dont l’identifiant en base est 18003 pour un mois donné (du 01/12/2020 au 31/12/2020)

GET /[URI_de_base]/api/feed/donnees/18003/valeurs/2020-12-01 03:00

Ecriture

Ajouter une valeur pour une donnée stockée dont l’identifiant en base est 2009 (mode de saisie GRANULARITE)

POST /[URI_de_base]/api/feed/donnees/2009/valeurs

Exemple de résultat XML de la requête

Exemple de résultat JSON de la requête

Ajouter une valeur pour une donnée stockée dont l’identifiant en base est 47000 (mode de saisie CRENEAU)

POST /[URI_de_base]/api/feed/donnees/47000/valeurs

Ajouter une valeur pour une donnée stockée dont l’identifiant en base est 18000 (mode de saisie JOUR)

POST /[URI_de_base]/api/feed/donnees/18000/valeurs

Modifier la valeur pour une donnée stockée dont l’identifiant en base est 2009 (mode de saisie GRANULARITE) pour une date et une tranche données (30/12/2020 sur la tranche 19:30-19:45)

PUT /[URI_de_base]/api/feed/donnees/2009/valeurs/2020-12-30 19:30

Supprimer la valeur pour une donnée stockée dont l’identifiant en base est 2009 (mode de saisie GRANULARITE) pour une date et une tranche données (30/12/2020 sur la tranche 19:30-19:45)

DELETE /[URI_de_base]/api/feed/donnees/2009/valeurs/2020-12-30 19:30

Suppression des valeurs

La suppression d'une valeur peut se faire à travers une requête HTTP DELETE ou HTTP POST en mettant une valeur vide.

Période de saisie

La période de saisie des valeurs d'une donnée stockée est une période qui dépend du mode de saisie de la donnée :

Mode de saisie de la donnée	Période de saisie des valeurs
Granularité	Jour
5/10/15/30 minutes	Jour
Heure	Jour
Créneau	Jour
Jour	Mois
Semaine	Semestre
Mois	Année

Contraintes pour l’insertion des valeurs

• Mode de saisie Créneau
  • Il faut renseigner les dates de début et de fin de la période, celles-ci vérifiant le pattern xsd:datetime.
  • La période ne doit pas excéder 24 heures et ne doit pas chevaucher d'autres périodes.
• Mode de saisie 5/10/15/30 min, Granularité, Heure
  • Seule la date de début peut être renseignée, celle-ci vérifiant le pattern xsd:datetime.
  • L'heure de la date de début saisie doit être un multiple de la granularité du mode de saisie.
• Mode de saisie Jour
  • Seule la date du jour avec l'heure de changement de jour peuvent être renseignées, celles-ci vérifiant le pattern xsd:dateTime.
  • La valeur est affectée au jour de la date de début renseignée pour la période.
• Mode de saisie Semaine
  • Seule la date du premier jour de la semaine avec l'heure de changement de jour peuvent être renseignées, celles-ci vérifiant le pattern xsd:dateTime.
  • La valeur est affectée à la semaine correspondant à la date de début renseignée pour la période.
• Mode de saisie Mois
  • Seule la date du premier jour du mois avec l'heure de changement de jour peuvent être renseignées, celles-ci vérifiant le pattern xsd:dateTime.
  • La valeur est affectée au mois correspondant à la date de début renseignée pour la période.

Contraintes sur la date mise en paramètre de la requête pour la modification et la suppression des valeurs

La date doit vérifier le pattern xsd:datetime.

Mode de saisie Créneau

La date doit correspondre à la date de début de la tranche horaire que l’on souhaite modifier.

Tous les autres modes de saisie

La date doit être un multiple de la granularité du mode de saisie.