Telemetriai Adatok

Aggregated APIs

Aggregated APIs főként akkor használják, ha egy bizonyos típusú adathoz egyetlen értéket szeretne kapni válaszként, amely lehetővé teszi egy bizonyos trend és/vagy eredmény összegzését egy testreszabott időablakra vonatkozóan.

Az ilyen típusú APIs felépítése mindig a következő:

Az path út, amely lehetővé teszi, hogy a kívánt erőforrásokra mutasson, mindig a következő paramétereket igényli:

• {power,frequency,wind,temperature,voltage,current,energy,kpis}: az erőforrás típusa, amelyre mutatni kell. Ez a paraméter nem a ténylegesen beszerezni kívánt adatokat határozza meg, hanem azt az általános kategóriát, amelyhez a kívánt adat tartozik (kérjük, vegye figyelembe, hogy egy API hívás egyszerre csak egy kategóriát fogad el, jelenleg nem lehetséges BULK hívások kezdeményezése);
• {entityID}: lehet üzem vagy eszköz EID. Az első esetben a kapott érték figyelembe veszi azon eszközök összesítését, amelyeknél ez az érték létezik, üzemi szinten; a második esetben a kapott érték az egyetlen érdeklődésre számot tartó eszközre vonatkozott;
• {dataType}: a ténylegesen beszerezendő adatokat jelöli. A rendelkezésre álló dataTypes a megjelölt erőforrásoktól függően változik, a részletes leírás közvetlenül a OpenAPIs Swagger;
• {valuetype}: az összesítési feltétel típusát jelöli, amellyel a kért adatok megfelelnek megszerezni.

A queries adatok szűrését lehetővé tevő lekérdezésekhez mindig a következő paraméterekre van szükség:

• {startDate}: az alsó korlát, amely lehetővé teszi a kívánt időablak kezdetének meghatározását. A formátuma mindig YYYYMMGG (eg: 20220321);
• {endDate}: a felső korlát, amely lehetővé teszi határozza meg az érdeklődésre számot tartó időablak végét. A formátuma mindig YYYYMMGG (eg: 20220322) és ideiglenesen a {startDate} után kell lennie;
• {timezone}: lehetővé teszi, hogy az API hívást a kért időzóna szerinti helyes adat-helyreállításhoz irányítsa.

Az összesített hívás mindig egyetlen értéket ad válaszként, amelyet a rendszer az időablaknak és a jelzett időzónának megfelelően kezel. Ebben az összefüggésben a {valuetype} paraméter nagy jelentőséggel bír, mert az erőforrás-kategóriától, tehát a beszerezendő {dataType}, tól függően változik.

A {dataType} kategóriába tartozó {power,frequency,wind,temperature,voltage,current,kpis}, esetén a {valueType} három különböző értéket vehet fel:

• Maximum: a definiált mintában található összes minta közül a maximális értéket adja vissza {startDate} és a {endDate} időablak a kért {dataType} hoz;
• Minimum: a definiált mintában található összes minta közül a minimális értéket adja vissza {startDate} és a {endDate} időablak a kért {dataType} hoz;
• Average: a definiált mintában található összes minta közül a átlagértékét adja vissza {startDate} és a {endDate} időablak a kért {dataType} hoz;

---

MEGJEGYZÉS: kpis kategória esetében a fenti szempontok csak akkor érvényesek, ha Power-Based KPIs hívják. További részletekért tekintse meg a következőt OpenAPIs Swagger.

---

Vegyünk egy pillantást néhány felhasználási esetre, amikor egy üzemet ( entityID: 12345678 ) egyetlen regisztrált inverteres eszközzel tekintünk ( entityID : 87654321 ):

A {dataType} kategóriába tartozó {energy,kpis}, esetén a {valueType} két különböző értéket vehet fel:

• Cumulative: időablakban elérhető utolsó kumulatív értéket adja vissza a kért {startDate} és a {endDate} időablakban elérhető utolsó kumulatív értéket adja vissza a kért {dataType};
• Delta: egutolsó és első összesített értéke közötti különbséget adja vissza {startDate} és a {endDate} időablakban elérhető utolsó kumulatív értéket adja vissza a kért {dataType};

---

MEGJEGYZÉS: kpis kategória esetében a fenti szempontok csak akkor érvényesek, ha Energy-Based KPIs hívják. További részletekért tekintse meg a következőt OpenAPIs Swagger.

---

Vegyünk egy pillantást néhány felhasználási esetre, amikor egy üzemet ( entityID: 12345678 ) egyetlen regisztrált inverteres eszközzel tekintünk ( entityID : 87654321 ):