Versions Compared

Old Version 1

changes.mady.by.user Stefanie Domzig

Saved on

compared with

New Version 2

changes.mady.by.user Stefanie Domzig

Saved on

Key

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

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

Available Calls

Info

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

...

Description

...

API Call

...

Parameters required

...

Das Basic Paket der Portal-API umfasst alle allgemeinen Anlagendaten, die mit den folgenden Aufrufen angefordert werden können.

Verfügbare Aufrufe

Info

Einige der Aufrufe müssen mit Parametern angegeben werden, die es dem Benutzer ermöglichen, spezifische Daten anzufordern.

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

Beschreibung

API-Aufruf

Erforderliche Parameter

Alle zugewiesenen Anlagen abrufen

GET /administration/plants

➖

Get general data from one plant

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

GET /administration/plant/{plantId}

➖

Get components for one plant

Komponenten für eine Anlage abrufen

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

➖

Get epoch for one plant(i.e. ID´s of the fleets assigned, plant size, component classes

Epoch für eine Anlage abrufen

GET /datasource/plant/{plantId}/epochrange

➖

Get specific plant data

Spezifische Anlagen Daten abrufen (d.h. IDs der zugewiesenen Flotten, Anlagengröße, Komponentenklassen)

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)

ProdEtotal, ProdPac, ProdPdc

Get data from different channels for a specific month for one plant

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

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

(tick) (

only

nur ProdEtotal)

Get data for a specific year for one plant

Daten für ein bestimmtes Jahr für eine Anlage abrufen

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

(tick) (

only

nur ProdEtotal)

Get data over the livetime for one plant

Daten über die Lebensdauer für eine Anlage abrufen

GET /visualization/plant/{plantId}/lifetime

(tick) (

only

nur ProdEtotal)

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 bezüglich der Epoch abrufen

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

(tick)

ProdEtotal, ProdPac, ProdPdc

...

Verfügbare Parameter

Parameter

Type

Typ

Value

Wert

dateFrom

single

einzel

any Date

jedes Datum “YYYY-MM-DD“, “today”

dateTo

single

einzel

any Date

jedes Datum “YYYY-MM-DD“, “today”

componentIds[]

array

“XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

channelNames[]

array

ProdEtotal, ProdPac, ProdPdc