Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

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

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

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 the adress of one plant

GET /administration/plants/{plantId}/address

➖

Get the contact details of one plant

GET /administration/plants/{plantId}/contacts

➖

Get the basic informations from one fleet

GET /administration/fleet/{fleetId}

➖

Get all plants from one fleet

GET /administration/fleet/{fleetId}/plants

➖

Get basic informations from the requested portal

GET /administration/portals

➖

Get components for one plant

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

➖

Get epoch for one plant

GET /datasource/plant/{plantId}/epochrange

➖

Get inverter data for one plant

GET /datasource/plant/{plantId}/inverters

➖

Get general plant data

GET /visualization/plant/{plantId}

➖

Get data from different channels for one plant

GET /visualization/plant/{plantId}/channels

(tick)

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

(tick)

Get data from different channels for one plant over the lifetime

GET /visualization/plant/{plantId}/lifetime

(tick)

Get data from different channels for one plant over one year

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

(tick)

Get data from different channels for one plant over one month

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

(tick)

Available Parameters

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”

xComponentIds[]

array

“XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

mppTrackerIds[]

array

“XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

ModuleStringIds[]

array

“XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

channelNames[]

array

“ProdEtotal”

“ProdPac”

“ProdPdc”

  • No labels