Struktura Hierarchiczna

Aurora Vision pozwala użytkownikowi na jednoznaczną identyfikację zarejestrowanych aktywów (organization, portfolio, plant or device ) poprzez unikalny numer sekwencyjny, nadawany automatycznie, który przyjmuje nazwę EntityID (EID ) nevet veszi fel.

Biorąc pod uwagę obecność wielu rodzajów zasobów, Aurora Vision definiuje hierarchiczną strukturę, która pozwala użytkownikowi w prosty i szybki sposób zidentyfikować interesujące go zasoby. Ta struktura jest bezpośrednio odzwierciedlona w oferowanych pakietach i wywołaniach interfejsów API, aby zapewnić narzędzie, które pozwala dynamicznie skalować hierarchię, zaczynając od zwykłej wiedzy o jednym lub więcej EntityIDs (EIDs ).

Rzućmy okiem na pełną strukturę hierarchiczną:

  • LVL 1 - ORGANIZATION: jednostka logiczna, która jednoznacznie identyfikuje Organization, która pozwala zarządzać flotą portfeli;
  • LVL 2 - PORTFOLIO: logiczny byt, który jednoznacznie identyfikuje Portfolio, co pozwala na zarządzanie flotą roślin;
  • LVL 3 - PLANT: jednostka logiczna, która jednoznacznie identyfikuje Plant (zawsze zawarta w portfolio), która umożliwia zarządzanie i rejestrację kompatybilnych urządzeń;
  • LVL 4 - LOGGER: jednostka logiczna, która jednoznacznie identyfikuje Data Logger (zewnętrzny lub wbudowany), który zarządza funkcjami rejestrowania danych i komunikacją z Aurora Vision;
  • LVL 5 - DEVICE: jednostka logiczna, która jednoznacznie identyfikuje Device (eg: falownik, miernik, bateria, stacja pogodowa, ładująca stacja, string ombiners etc…) monitorowane przez rejestrator;

UWAGA: istnienie Organization w Aurora Vision jest obecnie ograniczone do określonych przypadków użycia i może być skonfigurowane tylko przez obsługę klienta FIMER

W ofercie interfejsów API znajduje się pakiet, który identyfikuje każdy pojedynczy poziom hierarchiczny przedstawiony powyżej, a w każdym z pakietów znajduje się interfejs API, który łączy poziomy hierarchiczne i umożliwia skalowanie w górę lub w dół hierarchii, znając identyfikator jednostki hierarchicznego rodzica.

Obserwując poniższy schemat hierarchiczny, przyjrzyjmy się niektórym przypadkom użycia, aby lepiej zrozumieć, jak uzyskać informacje o zasobach należących do różnych poziomów hierarchii:

Przykład Schematu Hierarchicznego

Przypadek Użycia 1

Chcę poznać EID Portfolio 1 należącego do mojej Organization. Aby to zrobić, muszę zmniejszyć hierarchię z LVL 1 do LVL 2.

Organizations Suite
GET Portfolios in Organization

Umożliwia pobieranie informacji o organizacji (PortfolioGroup) z którą użytkownik jest powiązany, wraz z listą aktywnych portfeli zawartych w organizacji (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   ➜

Przypadek Użycia 2

Chcę poznać EID Plant 1 należącego do Portfolio 1. Aby to zrobić, muszę zmniejszyć hierarchię z LVL 2 do LVL 3.

Portfolios Suite
GET Plants in Portfolio

Pozwala na pobranie podzielonej na strony listy roślin w portfolio. Dla każdego zakładu podane są główne dane, takie jak: 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   ➜

Przypadek Użycia 3

Chcę poznać EID Logger 1 należącego do monitorowanej Plant 1. Aby to zrobić, muszę zmniejszyć hierarchię z LVL 3 do LVL 4.

Plants Suite
GET Loggers in Plant

Pozwala pobrać listę rejestratorów w zakładzie. Dla każdego rejestratora podane są główne szczegóły, takie jak: 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   ➜

Przypadek Użycia 4

Chcę poznać urządzenia monitorowane przez Logger 1 w Plant 1. Aby to zrobić, muszę zmniejszyć hierarchię z LVL 4 do LVL 5.

Loggers Suite
GET List of Devices

Pozwala pobrać listę urządzeń monitorowanych przez rejestrator, zarejestrowanych w zakładzie. Dla każdego urządzenia podane są główne dane, takie jak: 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   ➜