The Basic package of the User Portal API includes all general Plant data which can be requested with the following calls.

Description	API Call	Parameters required
Get all assigned plants	`GET /administration/plants`	➖
Get general data from one plant (i.e. name, size, firmware version, fleet affiliation, adress)	`GET /administration/plant/{plantId}`	➖
Get components for one plant	`GET /datasource/plant/{plantId}/components/{date}`	➖
Get epoch for one plant	`GET /datasource/plant/{plantId}/epochrange`	➖
Get specific plant data (i.e. ID´s of the fleets assigned, plant size, component classes)	`GET /visualization/plant/{plantId}`	➖
Get data from different channels for one plant	`GET /visualization/plant/{plantId}/channels`	`ProdEtotal, ProdPac, ProdPdc`
Get data from different channels for a specific month for one plant	`GET /visualization/plant/{plantId}/year/{year}/month/{month}`	(only `ProdEtotal`)
Get data for a specific year for one plant	`GET /visualization/plant/{plantId}/year/{year}`	(only `ProdEtotal`)
Get data over the livetime for one plant	`GET /visualization/plant/{plantId}/lifetime`	(only `ProdEtotal`)
Get the list of available channels for one plant	`GET /visualization/plant/{plantId}/channels/list`	➖
Get data from different channels for one plant regarding the epoch	`GET /visualization/plant/{plantId}/cross-epoch/channels`	`ProdEtotal, ProdPac, ProdPdc`

Available Parameter

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” “ProdPac” “ProdEtotal” “BattLoad” “ChargePac” “DischargePac” “ConsPac” “ConsPacCov” “ConsPacUncov” “ProdPacFeed” “ProdEtotalFeed”	“ProdEtotalNorm”`ProdEtotal, ProdPac, ProdPdc`

Versions Compared