Hierarchical Structure

Aurora Vision allows the user to uniquely identify the registered assets (organization, portfolio, plant or device ) through a unique sequential number, automatically assigned, which takes the name of EntityID (EID ).

Given the presence of multiple types of assets, Aurora Vision defines a hierarchical structure that allows the user to identify the resources of interest in a simple and fast way. This structure is directly reflected in the suites and APIs calls offered, in order to provide a tool that allows to dynamically scale the hierarchy starting from the mere knowledge of one or more EntityIDs (EIDs ).

Let’s take a look at the complete hierarchical structure:

  • LVL 1 - ORGANIZATION: logical entity that uniquely identifies an Organization, which allows to manage a fleet of portfolios;
  • LVL 2 - PORTFOLIO: logical entity that uniquely identifies a Portfolio, which allows to manage a fleet of plants;
  • LVL 3 - PLANT: logical entity that uniquely identifies a Plant (always contained in a portfolio), which allows to manage and register compatible devices;
  • LVL 4 - LOGGER: logical entity that uniquely identifies a Data Logger (external or embedded), which manages data logging functions and communication with Aurora Vision;
  • LVL 5 - DEVICE: logical entity that uniquely identifies a Device (eg: inverter, meter, battery, weather station, charging wallbox, string combiners etc…) monitored by a logger;

NOTE: the existence of an Organization on Aurora Vision is currently limited to specific use cases and can only be configured by FIMER Customer Support

Within the offer of the APIs there is a suite that identifies each single hierarchical level seen above and, within each of the suites, there is an API that connects the hierarchical levels and allows you to scale-up or scale-down through the hierarchy by knowing the Entity ID of the hierarchical parent.

Observing the hierarchical scheme below, let’s take a look at some use cases to better understand how to get information on assets belonging to different hierarchy levels:

Hierarchical Scheme Example

Use Case 1

I want to know the EID of Portfolio 1 belonging to my Organization. To do that, i need to scale down from LVL 1 to LVL 2 of the hierarchy.

Organizations Suite
GET Portfolios in Organization

Allows to retrieve info on the Organization (PortfolioGroup) the user is associated with, together with the list of active portfolios contained in the Organization (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

I want to know the EID of Plant 1 belonging to Portfolio 1. To do that, i need to scale down from LVL 2 to LVL 3 of the hierarchy.

Portfolios Suite
GET Plants in Portfolio

Allows to retrieve the paginated list of plants in a portfolio. For each plant the main details are provided such as: 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

I want to know the EID of Logger 1 belonging to the monitored Plant 1. To do that, i need to scale down from LVL 3 to LVL 4 of the hierarchy.

Plants Suite
GET Loggers in Plant

Allows to retrieve the list of loggers in a plant. For each loggers the main details are provided such as: 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

I want to know the devices monitored by Logger 1 under Plant 1. To do that, i need to scale down from LVL 4 to LVL 5 of the hierarchy.

Loggers Suite
GET List of Devices

Allows to retrieve the list of devices monitored by a logger, registered in a plant. For each device the main details are provided such as: 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   ➜