Aller au contenu principal
CloudStudio

Obtenir la dernière donnée de plusieurs endpoints

Ce service permet d'interroger la dernière donnée enregistrée de 5 appareils au maximum en même temps, en un seul appel.

Son utilisation est surtout recommandée lorsque vous devez afficher en temps réel les informations de plusieurs capteurs simultanément, en évitant un appel spécifique pour chacun, ce qui se traduit par un gain de temps et une réduction du trafic réseau.

Pour utiliser cette fonction, appelez l'API à une adresse spécifique avec la méthode GET.

GET /api/v2/endpointData/multiple

Pour des raisons de sécurité, une clé d'accès identifiant l'utilisateur à l'origine de la requête est requise. Cette clé correspond au token d'accès et doit être incluse dans l'adresse.

GET https://gear-dev.cloud.studio/api/v2/endpointData/multiple?accessToken=123456789-1110-0022-3333-987654321012&endpointIds=351031,151040,252340,511088,720510

Si la clé d'accès est absente ou invalide, l'API renvoie une erreur 500 avec le code 8001 dans le champ FaultCode. Consultez la section Erreurs pour connaître le format de la réponse.

Les paramètres requis sont :

  • Clé d'accès (Access Token) : clé identifiant un utilisateur autorisé.
  • Elle est de type String et est obligatoire.
  • EndpointsIDs : ID des capteurs de l'appareil, séparés par des virgules, dont les données doivent être récupérées.
  • Il est de type List et est obligatoire.
  • REMARQUE : la limite est de 5 (cinq) endpoints par appel.

Si plus de 5 endpointIds sont envoyés dans la requête, l'API renvoie un 500 avec le code 100004 dans le champ FaultCode, ce qui signifie que la limite d'endpoints a été dépassée. Consultez la section Erreurs pour plus d'informations.

Une fois la requête correctement effectuée, on reçoit une liste d'objets (JSON). Chaque objet de la liste représente les informations de l'un des capteurs demandés.

Réponse JSON listant chaque endpoint avec sa description, son numéro de séquence, son horodatage UTC et sa valeur

Les informations de la liste sont les suivantes :

  • EndpointID : numéro d'identification du capteur interrogé
  • Description : nom du capteur interrogé
  • SequenceNumber : numéro séquentiel indiquant l'ordre dans lequel les données ont été enregistrées (utile pour le suivi et l'historique)
  • TimeStamp_UTC : date et heure exactes de l'enregistrement de lastValue
  • Value : dernière valeur signalée par le capteur

Si un endpoint n'a aucune donnée, les champs Value et timeStamp valent null.

Remarque : l'ajout de cette fonctionnalité concerne toutes les méthodes de requête de données d'endpoints, qui incluent désormais un champ description supplémentaire.

L'endpoint Camera est exclu.

Dernière mise à jour le