User API Basic - Package description

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

Available Calls

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

Description

API Call

Parameters required

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

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

Available Parameter

Parameter

Type

Value

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”