Estructura Jerarquica

Aurora Vision permite al usuario identificar de forma única los activos registrados (organization, portfolio, plant or device ) a través de un número secuencial único, asignado automáticamente, que toma el nombre de EntityID (EID ).

Dada la presencia de múltiples tipos de activos, Aurora Vision define una estructura jerárquica que permite al usuario identificar los recursos de interés de forma sencilla y rápida. Esta estructura se refleja directamente en las suites y llamadas a APIs que se ofrecen, con el fin de brindar una herramienta que permita escalar dinámicamente la jerarquía a partir del mero conocimiento de uno o más EntityIDs (EIDs ).

Veamos la estructura jerárquica completa:

  • LVL 1 - ORGANIZATION: entidad lógica que identifica de forma única a una Organization, ue permite gestionar una flota de portfolios;
  • LVL 2 - PORTFOLIO: entidad lógica que identifica de manera única un Portfolio, que permite administrar una flota de plantas;
  • LVL 3 - PLANT: entidad lógica que identifica de manera única una Plant (siempre contenida en un portfolio), que permite administrar y registrar dispositivos compatibles;
  • LVL 4 - LOGGER: entidad lógica que identifica de forma única un Data Logger (externo o integrado), que gestiona las funciones de logging de datos y la comunicación con Aurora Vision;
  • LVL 5 - DEVICE: entidad lógica que identifica de forma única un Device (eg: inversor, medidor, batería, estación meteorológica, caja de pared de carga, string combiners etc…) monitoreados por un logger;

NOTA: la existencia de una Organization en Aurora Vision actualmente se limita a casos de uso específicos y solo puede configurarla el servicio de atención al cliente de FIMER

Dentro de la oferta de las API, hay una suite que identifica cada nivel jerárquico único visto anteriormente y, dentro de cada una de las suites, hay una API que conecta los niveles jerárquicos y le permite escalar hacia arriba o hacia abajo a través de la jerarquía conociendo el Id. de entidad del padre jerárquico.

Observando el siguiente esquema jerárquico, echemos un vistazo a algunos casos de uso para comprender mejor cómo obtener información sobre los activos que pertenecen a diferentes niveles de jerarquía:

Ejemplo de Esquema Jerárquico

Caso de Uso 1

Quiero saber el EID del Portfolio 1 perteneciente a mi Organization. Para hacer eso, necesito escalar hacia abajo de LVL 1 a LVL 2 de la jerarquía.

Organizations Suite
GET Portfolios in Organization

Permite recuperar información sobre la Organización (PortfolioGroup) a la que está asociado el usuario, junto con la lista de carteras activas contenidas en la Organización (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   ➜

Caso de Uso 2

Quiero saber el EID de la Plant 1 perteneciente a Portfolio 1. Para hacer eso, necesito escalar hacia abajo de LVL 2 a LVL 3 de la jerarquía.

Portfolios Suite
GET Plants in Portfolio

Permite recuperar la lista paginada de plantas en un portafolio. Para cada planta se proporcionan los detalles principales, tales como: 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   ➜

Caso de Uso 3

Quiero saber el EID del Logger 1 perteneciente a Plant 1. Para hacer eso, necesito escalar hacia abajo de LVL 3 a LVL 4 de la jerarquía.

Plants Suite
GET Loggers in Plant

Permite recuperar la lista de loggers en una planta. Para cada registrador se proporcionan los detalles principales, como: 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   ➜

Caso de Uso 4

I want to know the devices monitored by Logger 1 en Plant 1. Para hacer eso, necesito escalar hacia abajo de LVL 4 a LVL 5 de la jerarquía.

Loggers Suite
GET List of Devices

Permite recuperar la lista de dispositivos monitoreados por un logger, registrados en una planta. Para cada dispositivo se proporcionan los detalles principales, tales como: 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   ➜