The Basic package of the User API includes all general Plant data which can be requested with the following calls.
Available Calls
Info |
---|
Some of the calls can must be specified with parameters which allows the user to request specific data. |
Description | API Call | Parameters possiblerequired |
---|---|---|
Get all assigned plants |
| ✖️ ➖ |
Get general data from one plant (i.e. name, size, firmware version, fleet affiliation, adress) |
| ✖️ ➖ |
Get components for one plant |
| ✖️ ➖ |
| ✖️ ➖ | |
Get specific plant data (i.e. ID´s of the fleets assigned, plant size, component classes) |
| ✖️ ➖ |
Get data from different channels for one plant |
|
|
Get the list of available channels for one plant |
| ✖️ ➖ |
Get data from different channels for one plant regarding the epoch |
|
|
...
Parameter | Type | Value |
---|---|---|
dateFrom | single | any Date “YYYY-MM-DD“, “today” |
dateTo | single | any Date “YYYY-MM-DD“, “today” |
componentIds[] | array | “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX” |
channelNames[] | array | ConsEtotal“ConsEtotal” ProdPac“ProdPac” ProdEtotal“ProdEtotal” BattLoad“BattLoad” ChargePac“ChargePac” DischargePac“DischargePac” ConsPac“ConsPac” ConsPacCov“ConsPacCov” ConsPacUncov“ConsPacUncov” ProdPacFeed“ProdPacFeed” ProdEtotalFeed“ProdEtotalFeed” ProdEtotalNorm“ProdEtotalNorm” |