04 Epochen und CrossEpochen

1 Epochen
- 1.1 Beispiel
2 ComponentIds und CrossEpochIds
- 2.1 Beispiel aus API Call
  - 2.1.1 Epoche 1
  - 2.1.2 Epoche 2
  - 2.1.3 Epoche 3
3 Daten abfragen mit CrossEpochIds
4 Call
5 Parameter

Epochen

Epochen sind Zeitabschnitte, die eine Anlagenkonfiguration beschreiben. Bei Änderungen z.B. durch den Tausch eines angeschlossenen Gerätes, wird eine neue Epoche für Ihre Anlage angelegt.

Beispiel

Epoche 2: “WR 3” wurde hinzugefügt
Epoche 3: “WR 2” wurde durch “WR 2B” ersetzt

ComponentIds und CrossEpochIds

ComponentIds (id) werden pro Epoche neu erzeugt.
CrossEpochIds bleiben über die Lebenszeit der Komponente gleich.

Beispiel aus API Call

GET {{baseURL}}/api/v1/{{portal}}/datasource/plant/{{plantId}}/components/YYYY-MM-DD

Epoche 1

[
    {
        "id": "a2a62c37-...",
        "mpptrackers": [
            {...}
        ],
        "moduleStrings": [],
        "moduleField": null,
        "crossEpochId": "abcd123...",
    }
]

Epoche 2

[
    {
        "id": "e1bb9e02-...",
        "mpptrackers": [
            {...}
        ],
        "moduleStrings": [],
        "moduleField": null,
        "crossEpochId": "abcd123...",
    }
]

Epoche 3

[
    {
        "id": "0eb47529-...",
        "mpptrackers": [
            {...}
        ],
        "moduleStrings": [],
        "moduleField": null,
        "crossEpochId": "xyz789...",
    }
]

CrossEpochIds sind nur für Komponenten notwendig.
Momentan sind diese nicht für MPP-Tracker oder Wechselrichter-Strings verfügbar.

Für Werte auf Anlagen-Level sind diese IDs nicht notwendig.

Daten abfragen mit CrossEpochIds

Um die Daten der einzelnen Komponenten der Epoche abzurufen wird der folgende API Call verwendet:

GET {{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plantId}}/cross-epoch/channels?....

Hier wird als Parameter die xComponentIds[]= als Channel eingesetzt. Diese wird über den oben genannten Call geliefert und findet sich unter der Variable "crossEpochId".

Außerdem wird der Channel benötigt der angibt welche Daten abgefragt werden sollen.

Beispiel:

Call

{{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plant}}/cross-epoch/channels?dateFrom={{dateFrom}}&dateTo={{dateTo}}&channelNames[]={{channelName}}&xComponentIds[]=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/visualization/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/cross-epoch/channels?dateFrom=2024-01-01&dateTo=2024-01-01&channelNames[]=ProdPac&xComponentIds[]=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

baseURL = https://api.enerest.world
- Ändern Sie das NICHT! Das ist für jeden Benutzer immer dasselbe
portal = solarCompanyXYZ
- Hier sollten Sie den ersten Teil der Portal-URLhinzufügen.
- Ohne .enerest.world
plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
- Fügen Sie hier die ID Ihrer Anlage hinzu
- Diese ID finden Sie
  - im administration/plants call oder
  - im letzten Teil der URL, wenn Sie die Anlage im Portal auswählen
    - Bsp. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
dateFrom = 2024-01-01
- Das Datum kann sein
  - today oder
  - jedes Datum im Format YYYY-MM-DD
dateTo = 2024-01-01
- Das Datum kann sein
  - today oder
  - jedes Datum im Format YYYY-MM-DD
channelName = ProdPac
- Die Channels können in einem Call kombiniert werden
- In der Channelliste werden alle verfügbaren Channels aufgelistet
xComponentIds = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
- Die Epoch-Komponenten-ID kann im Komponentenaufruf gefunden werden.
- Mit der xComponentId kann die gesamte Lebensdauer der Komponente angefordert werden und nicht nur die aktuelle Epoche.