Mesures

Création d'un stream mesures par API

La 1ère étape avant tout envoi de données est la création d’un stream (flux de données) de type metrics.

Requête

 API data v1.0 
POST api/data/v1/streams

Paramètres

Un flux de mesures a toujours un type metrics et le champ intent_dataType snapshot, average ou delta.
Title
Title
Title
Description
champ
valeur
Référence du stream
reference
vous êtes libre de fixer la référence de votre choix.
Type du stream
type
metrics
Type de données
intent_dataType
snapshot, average ou delta
Référence de patrimoine lié
intent_assetReference
Référence du client
Référence du contrat lié
intent_contractReference
Votre référence de contrat
Libellé du flux
label
Compréhensible par un être humain
Description
description
Activités
intent_activityKey
 Liste des activités disponibles  
Unité
intent_unit
 Liste des unités disponibles  
Fréquence de mesure des données
intent_frequency
en minutes
tag libre
tag
La référence ne peut pas contenir de "/"

Nous déconseillons l'utilisation de caractères spéciaux (@;#;&;^;*,etc.) et d'espace.
La référence d'un stream doit être unique pour toute votre entité sur intentPlatform.

  • Le type de données publiées sur ce flux intent_dataType
3 valeurs sont disponibles :
  • snapshot : désigne une mesure instantanée. Par exemple, un index de compteur de consommation électrique, ou la température intérieure d'un logement.
  • delta : désigne les valeurs mesurant la différence entre deux instants, comme une consommation ou une différence (ex: consommation d’eau entre deux mois)
  • average : désigne les valeurs présentant une moyenne sur une durée définie, comme une moyenne (ex: température moyenne sur un mois)

Publication de données sur un stream de type metrics

Requête

 API data v1.0 
POST api/data/v1/metrics

Envoi des données via API

Une fois que les flux ont été créés, vous pouvez envoyer vos données par API.
Pour cela il faudra poster sur la streamReference; qui est la référence du flux qui a été créée auparavant.
Le champ timestamp indique le moment où la mesure a été réalisée (au format  Unix timestamps (milliseconds) )
Le champ value indique la mesure (l'unité de cette mesure doit correspondre à celle indiquée lors de la création du flux).

Vous pouvez transmettre plusieurs mesures en 1 appel API.