Versions Compared

Old Version 1

changes.mady.by.user Stefanie Domzig

Saved on

compared with

New Version Current

changes.mady.by.user Stefanie Domzig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With the Advanced package the user can request data from all to the user assigned plants and their components. The Advanced package also contains the complete range of functions of the PortalAPI Basic package

Available Calls

Info

Some of the calls can be specified with parameters which allows the user to request specific data.

...

Description

...

API Call

...

Parameters required

...

Mit dem Advanced-Paket kann der Benutzer Daten von allen dem Benutzer zugewiesenen Anlagen und deren Komponenten anfordern. Das Advanced-Paket enthält auch das vollständige Funktionsspektrum des Portal API Basic-Pakets.

Verfügbare Aufrufe

Info

Einige der Aufrufe können mit Parametern spezifiziert werden, die es dem Benutzer ermöglichen, spezifische Daten anzufordern.

‌

(i.e. name, size, firmware version, fleet affiliation, adress

Beschreibung

API-Aufruf

Benötigte Parameter

Alle zugewiesenen Anlagen abrufen

GET /administration/plants

➖

Get general data from one plant

Allgemeine Daten von einer Anlage abrufen (z. B. Name, Größe, Firmware-Version, Flotte Zugehörigkeit, Adresse)

GET /administration/plant/{plantId}

➖

Get the adress of one plant

Die Adresse einer Anlage abrufen

GET /administration/plants/{plantId}/address

➖

Get the contact details of one plant

Die Kontaktdaten einer Anlage abrufen

GET /administration/plants/{plantId}/contacts

➖

Get the basic informations from one fleet

Die grundlegenden Informationen von einer Flotte abrufen

GET /administration/fleet/{fleetId}

➖

Get all plants from one fleet

Alle Anlagen von einer Flotte abrufen

GET /administration/fleet/{fleetId}/plants

➖

Get components for one plant

Komponenten für eine Anlage abrufen

GET /datasource/plant/{plantId}/components/{date}

➖

Get epoch for one plant

Epoch für eine Anlage abrufen

GET /datasource/plant/{plantId}/epochrange

➖

Get inverter data for one plant

Wechselrichterdaten für eine Anlage abrufen

GET /datasource/plant/{plantId}/inverters

➖

Get general plant data

Allgemeine Anlagen Daten abrufen

GET /visualization/plant/{plantId}

➖

Get data from different channels for one plant

Daten von verschiedenen Kanälen für eine Anlage abrufen

GET /visualization/plant/{plantId}/channels

(tick)

Get the list of available channels for one plant

Die Liste der verfügbaren Kanäle für eine Anlage abrufen

GET /visualization/plant/{plantId}/channels/list

➖

Get data from different channels for one plant regarding the epoch

Daten von verschiedenen Kanälen für eine Anlage in Bezug auf die Epoch abrufen

GET /visualization/plant/{plantId}/cross-epoch/channels

(tick)

Get data from different channels for one plant over the lifetime

Daten von verschiedenen Kanälen für eine Anlage über die Lebensdauer abrufen

GET /visualization/plant/{plantId}/lifetime

(tick)

Get data from different channels for one plant over one year

Daten von verschiedenen Kanälen für eine Anlage über ein Jahr abrufen

GET /visualization/plant/{plantId}/year/{year}

(tick)

Get data from different channels for one plant over one month

Daten von verschiedenen Kanälen für eine Anlage über einen Monat abrufen

GET /visualization/plant/{plantId}/year/{year}/month/{month}

(tick)

‌

...

Verfügbare Parameter

Parameter

Type

Typ

Value

Wert

dateFrom

single

any Date “YYYY

einzel

jedes Datum „YYYY-MM-DD“,

“today”any Date “YYYY

„heute“

dateTo

single

einzel

jedes Datum „YYYY-MM-DD“,

“today”

„heute“

componentIds[]

array

“XXXXXXXX

„XXXXXXXX-XXXX-XXXX-XXXX-

XXXXXXXXXXXX”

XXXXXXXXXXXX“

xComponentIds[]

array

“XXXXXXXX

„XXXXXXXX-XXXX-XXXX-XXXX-

XXXXXXXXXXXX”

XXXXXXXXXXXX“

mppTrackerIds[]

array

“XXXXXXXX

„XXXXXXXX-XXXX-XXXX-XXXX-

XXXXXXXXXXXX”

XXXXXXXXXXXX“

ModuleStringIds[]

array

“XXXXXXXX

„XXXXXXXX-XXXX-XXXX-XXXX-

XXXXXXXXXXXX”

XXXXXXXXXXXX“

channelNames[]

array

“ProdEtotal”

“ProdPac”

“ProdPdc”

„ProdEtotal“ „ProdPac“ „ProdPdc“