Estrutura Hierárquica

O Aurora Vision permite ao usuário identificar de forma exclusiva os ativos cadastrados (organization, portfolio, plant or device ) por meio de um número sequencial único, atribuído automaticamente, que leva o nome de EntityID (EID ).

Dada a presença de vários tipos de ativos, o Aurora Vision define uma estrutura hierárquica que permite ao usuário identificar os recursos de interesse de forma simples e rápida. Essa estrutura se reflete diretamente nas suítes e chamadas de APIs oferecidas, a fim de fornecer uma ferramenta que permite dimensionar dinamicamente a hierarquia a partir do mero conhecimento de um ou mais EntityIDs (EIDs ).

Vamos dar uma olhada na estrutura hierárquica completa:

  • LVL 1 - ORGANIZATION: entidade lógica que identifica exclusivamente uma Organization, o que permite gerenciar uma frota de portfólios;
  • LVL 2 - PORTFOLIO: entidade lógica que identifica de forma única um Portfolio, que permite gerenciar uma frota de plantas;
  • LVL 3 - PLANT: entidade lógica que identifica exclusivamente um Plant (sempre contida em um portfólio), que permite gerenciar e registrar dispositivos compatíveis;
  • LVL 4 - LOGGER: entidade lógica que identifica exclusivamente um Data Logger (externo ou incorporado), que gerencia as funções de registro de dados e comunicação com o Aurora Vision;
  • LVL 5 - DEVICE: entidade lógica que identifica exclusivamente um Device (eg: inversor, medidor, bateria, estação meteorológica, wallbox de carregamento , combinadores de strings etc…) monitorados por um logger;

OBSERVAÇÃO: a existência de uma Organization no Aurora Vision está atualmente limitada a casos de uso específicos e só pode ser configurada pelo Suporte ao Cliente FIMER

Dentro da oferta das APIs existe uma suite que identifica cada nível hierárquico visto acima e, dentro de cada uma das suites, existe uma API que liga os níveis hierárquicos e permite aumentar ou diminuir através a hierarquia sabendo o ID da entidade do pai hierárquico.

Observando o esquema hierárquico abaixo, vejamos alguns casos de uso para entender melhor como obter informações sobre ativos pertencentes a diferentes níveis hierárquicos:

Exemplo de Esquema Hierárquico

Caso de Uso 1

Quero saber o EID do Portfolio 1 pertencente à minha Organization. Para fazer isso, preciso reduzir de LVL 1 para LVL 2 da hierarquia.

Organizations Suite
GET Portfolios in Organization

Permite recuperar informações sobre a Organização (PortfolioGroup) à qual o usuário está associado, juntamente com a lista de portfólios ativos contidos na Organização (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

Quero saber o EID do Plant 1 pertencente ao Portfolio 1. Para fazer isso, preciso reduzir de LVL 2 para LVL 3 da hierarquia.

Portfolios Suite
GET Plants in Portfolio

Permite recuperar a lista paginada de plantas em um portfólio. Para cada planta são fornecidos os principais detalhes 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

Quero saber o EID do Logger 1 pertencente à Plant 1 monitorada. Para fazer isso, preciso reduzir de LVL 3 para LVL 4 da hierarquia.

Plants Suite
GET Loggers in Plant

Permite recuperar a lista de madeireiros em uma planta. Para cada logger, os principais detalhes são fornecidos, 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

Quero conhecer os dispositivos monitorados pelo Logger 1 em Plant 1. Para fazer isso, preciso reduzir de LVL 4 para LVL 5 da hierarquia.

Loggers Suite
GET List of Devices

Permite recuperar a lista de dispositivos monitorados por um logger, cadastrados em uma planta. Para cada dispositivo, os principais detalhes são fornecidos, 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   ➜