Structure Hiérarchique

Aurora Vision permet à l’utilisateur d’identifier de manière unique les actifs enregistrés (organization, portfolio, plant or device ) grâce à un numéro séquentiel unique, attribué automatiquement, qui prend le nom de EntityID (EID ).

Compte tenu de la présence de plusieurs types d’actifs, Aurora Vision définit une structure hiérarchique qui permet à l’utilisateur d’identifier les ressources d’intérêt de manière simple et rapide. Cette structure se reflète directement dans les suites et les appels d’API proposés, afin de fournir un outil permettant de faire évoluer dynamiquement la hiérarchie à partir de la simple connaissance d’un ou plusieurs EntityIDs (EIDs ).

Examinons la structure hiérarchique complète:

  • LVL 1 - ORGANIZATION: entité logique qui identifie de manière unique un Organization, qui permet de gérer une flotte de portefeuilles;
  • LVL 2 - PORTFOLIO: entité logique qui identifie de manière unique un Portfolio, qui permet de gérer un parc de plantes;
  • LVL 3 - PLANT: entité logique qui identifie de manière unique un Plant (toujours contenu dans un portefeuille), qui permet de gérer et d’enregistrer des appareils compatibles;
  • LVL 4 - LOGGER: entité logique qui identifie de manière unique un Data Logger (external or embedded), qui gère les fonctions d’enregistrement des données et la communication avec Aurora Vision;
  • LVL 5 - DEVICE: entité logique qui identifie de manière unique un Device (eg: inverter, meter, battery, weather station, charging wallbox, string combiners etc…) surveillé par un enregistreur;

NOTE: l’existence d’un Organization sur Aurora Vision est actuellement limité à des cas d’utilisation spécifiques et ne peut être configuré que par le support client FIMER

Dans l’offre des API, il y a une suite qui identifie chaque niveau hiérarchique vu ci-dessus et, dans chacune des suites, il y a une API qui relie les niveaux hiérarchiques et vous permet d’augmenter ou de réduire la hiérarchie en connaissant Entity ID du parent hiérarchique.

En observant le schéma hiérarchique ci-dessous, examinons quelques cas d’utilisation pour mieux comprendre comment obtenir des informations sur les actifs appartenant à différents niveaux de hiérarchie :

Exemple de Schéma Hiérarchique

Use Case 1

Je veux connaître l’EID de Portfolio 1 appartenant à mon Organization. Pour ce faire, je dois passer du LVL 1 au LVL 2 de la hiérarchie.

Organizations Suite
GET Portfolios in Organization

Permet de récupérer des informations sur l’Organisation (PortfolioGroup) à laquelle l’utilisateur est associé, ainsi que la liste des portefeuilles actifs contenus dans l’Organisation (portfolioGroupPortfolios).

Request

GET   https://api.auroravision.net/api/rest/v1/portfolioGroup

Path

//

Header

X-AuroraVision-Token

Query

//

Curl

curl --request GET https://api.auroravision.net/api/rest/v1/portfolioGroup --header "X-AuroraVision-Token: 1/?abcde==2fgh/+3lmn4JoPqrSTuv"

OpenAPIs Swagger   ➜

Use Case 2

Je veux connaître l’EID de Plant 1 appartenant à mon Portfolio 1. Pour ce faire, je dois passer du LVL 2 to LVL 3 de la hiérarchie.

Portfolios Suite
GET Plants in Portfolio

Permet de récupérer la liste paginée des plantes d’un portefeuille. Pour chaque plante, les principaux détails sont fournis tels que: plantEntityID, plantName, plantDescription, plantState, plantStatus.

Request

GET   https://api.auroravision.net/api/rest/v1/portfolio/{entityID}/plants

Path

Portfolio entityID

Header

X-AuroraVision-Token

Query

page

Curl

curl --request GET https://api.auroravision.net/api/rest/v1/portfolio/123456/plants?page=0 --header "X-AuroraVision-Token: 1/?abcde==2fgh/+3lmn4JoPqrSTuv"

OpenAPIs Swagger   ➜

Use Case 3

Je veux connaître l’EID de Logger 1 appartenant à mon Plant 1. Pour ce faire, je dois passer du LVL 3 au LVL 4 de la hiérarchie.

Plants Suite
GET Loggers in Plant

Permet de récupérer la liste des loggers d’une usine. Pour chaque enregistreur, les principaux détails sont fournis tels que: loggerEntityID, loggerName, loggerDescription, loggerState, loggerMACAddress, loggerModel.

Request

GET   https://api.auroravision.net/api/rest/v1/plant/{entityID}/loggers

Path

entityID

Header

X-AuroraVision-Token

Query

//

Curl

curl --reqest GET https://api.auroravision.net/api/rest/v1/plant/123456/loggers --header "X-AuroraVision-Token: 1/?abcde==2fgh/+3lmn4JoPqrSTuv"

OpenAPIs Swagger   ➜

Use Case 4

Je veux connaître les appareils surveillés par Logger 1 appartenant à mon Plant 1. Pour ce faire, je dois passer du LVL 4 au LVL 5 de la hiérarchie.

Loggers Suite
GET List of Devices

Permet de récupérer la liste des appareils surveillés par un logger, enregistrés dans une usine. Pour chaque appareil, les principaux détails sont fournis tels que: deviceEntityID, deviceCategory, deviceName, deviceDescription, deviceState, deviceModel, deviceFWVersion, deviceFirstReporteDate.

Request

GET   https://api.auroravision.net/api/rest/v1/logger/{entityID}/devices

Path

entityID

Header

X-AuroraVision-Token

Query

//

Curl

curl --request GET https://api.auroravision.net/api/rest/v1/loggers/123456/devices --header "X-AuroraVision-Token: 1/?abcde==2fgh/+3lmn4JoPqrSTuv"

OpenAPIs Swagger   ➜