Quellsystem-API: Unterschied zwischen den Versionen

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche
(→‎Umspannwerk)
(→‎Erzeugung)
Zeile 85: Zeile 85:
 
|{{REST-GET|name = asynchronous-machines|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
 
|{{REST-GET|name = asynchronous-machines|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
 
|-
 
|-
−
|[[Erzeuger|Erzeuger]]
+
|[[Einspeiser|Einspeiser]]
 
|topologisches Basiselement
 
|topologisches Basiselement
 
|{{REST-GET_with_link|name = energy-sources|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 3|link-host = mock-up-topology.openk.de}}
 
|{{REST-GET_with_link|name = energy-sources|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 3|link-host = mock-up-topology.openk.de}}

Version vom 21. Oktober 2017, 12:06 Uhr

Die Quellsystem-API (Source System API) harmonisert den Zugriff auf die Quellsysteme des Netzbetreibers. Sie ist in ihren Abfragemöglichkeiten bewusst einfach gehalten, um die Integration zu vereinfachen und die Komplexität bei der Bereitstellung der Quellssystemdaten zu minimieren. Gleichzeitig sollen die datenliefernden Quellsysteme entlastet werden. Die Bereitstellung komfortabler, fachlicher Abfragen sowie umfassender Selektions- und Filtermöglichkeiten geschieht wiederverwendbar in den nachgelagerten Domänen-Modulen.

Im Folgenden werden die unterschiedlichen Schnittstellen-Methoden der Quellsystem-API vorgestellt:



basePath: /source-system/asset

Bezeichnung Beschreibung
Anlagen
(veraltet)
http-Methode: GET
Bezeichnung: assets
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Anlagenbetreiber
(veraltet)
http-Methode: GET
Bezeichnung: asset-owners
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Aufteilungen und Zuordnungen des Anlagenbetriebs
(veraltet)
http-Methode: GET
Bezeichnung: ownerships
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Anlagenstandort
(veraltet)
http-Methode: GET
Bezeichnung: asset-locations
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Anlagenverantwortlicher
(veraltet)
http-Methode: GET
Bezeichnung: asset-operators
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI

basePath: /source-system/measurement

Bezeichnung Beschreibung
aktuelle Wirkleistung
(veraltet)
http-Methode: GET
Bezeichnung: active-power
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Messeinrichtung (aktuelle Wirkleistung)
(veraltet)
http-Methode: GET
Bezeichnung: active-power-measurements
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Schalterstellungen
http-Methode: GET
Bezeichnung: switch-states
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI

basePath: /source-system/topology

Um ein vollständiges Topologiemodell flexibel aufbauen zu können, stellt die Quellsystem-API prinzipiell drei Arten von Abfragen zur Verfügung:

  • topologische Basiselemente: Topologische Basiselemente stellen die elektrisch leitenden Elemente in der Topologie dar. Hierzu zählen u. A. Tranformatoren, Leistungsschalter, Sammelschienen. Die Verbindung zwischen den einzelnen Basiselementen erfolgt über spezielle Knoten (im CIM ConnectivityNode). Jedes Basiselement besitzt hierzu einen Verweis auf mindestens einen Verbindungsknoten. Über den Vergleich der Verbindungsknoten können die Zusammenhänge und Verknüpfungen der Basiselemente hergestellt werden.
  • Kategorisierung: Hinter "Kategorisierung" verbirgt sich die Einteilung in bestimmte Arten von Elementen, die modellierungstechnisch gleich sind. Netzbetreiber haben hierüber die Möglichkeit, eigene Einteilung, die unternehmensspezifisch sind, vorzunehmen. Als Beispiel können hier Leitungsarten ("Hauptleitung", "Abzweig", ...) oder Umspannwerkarten ("Umspannwerk", "Ortsnetztrafo", ...) genannt werden.
  • Gruppierung: Mit Hilfe von Gruppierungen können topologische Basiselemente zu größeren Einheiten zusammengefasst werden. Dies sind zum Beispiel Umspannwerke, Leitungen, Felder.

Im Folgenden werden die Schnittstellen vorgestellt, die zum Aufbau einer Topologie verwendet werden können:

allgemeine Topologieelemente

Bezeichnung Typ Beschreibung
Nennspannung Kategorisierung
http-Methode: GET
Bezeichnung: base-voltages
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/base-voltages?revision=3 mock-up-topology.openk.de]
Netzgebiet Gruppierung
http-Methode: GET
Bezeichnung: geographical-regions
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Teilnetzgebiet Gruppierung
http-Methode: GET
Bezeichnung: sub-geographical-regions
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI

Erzeugung

CIM-Model Generation.svg

Bezeichnung Typ Beschreibung
Asynchrongenerator
(veraltet) 		topologisches Basiselement
http-Methode: GET
Bezeichnung: asynchronous-machines
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Einspeiser topologisches Basiselement
http-Methode: GET
Bezeichnung: energy-sources
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/energy-sources?revision=3 mock-up-topology.openk.de]
Erzeugungsart
(veraltet) 		Kategorisierung
http-Methode: GET
Bezeichnung: generation-types
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Kraftwerk Gruppierung
http-Methode: GET
Bezeichnung: plants
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
nicht-rotierende Energiequelle
(veraltet) 		topologisches Basiselement
http-Methode: GET
Bezeichnung: non-rotating-energies
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Synchrongenerator
(veraltet) 		topologisches Basiselement
http-Methode: GET
Bezeichnung: synchronous-machines
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Windkraftanlage (Typ 3 oder 4)
(veraltet) 		topologisches Basiselement
http-Methode: GET
Bezeichnung: wind-turbines-type-3-or-4
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI

Leitungen und Leitungselemente

CIM-Model Line.svg

Bezeichnung Typ Beschreibung
Leitung Gruppierung
http-Methode: GET
Bezeichnung: lines
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/lines?revision=3 mock-up-topology.openk.de]
Leitungsabschnitt topologisches Basiselement
http-Methode: GET
Bezeichnung: ac-line-segments
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/ac-line-segments?revision=3 mock-up-topology.openk.de]
Leitungsart Kategorisierung
http-Methode: GET
Bezeichnung: line-types
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/line-types?revision=2 mock-up-topology.openk.de]
Muffe topologisches Basiselement
http-Methode: GET
Bezeichnung: junctions
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/junctions?revision=3 mock-up-topology.openk.de]

Umspannwerk

CIM-Model Substation.svg

Bezeichnung Typ Beschreibung
Erdungen
(noch nicht) 		topologisches Basiselement
http-Methode: GET
Bezeichnung: grounds
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Erdungswiderstände topologisches Basiselement
http-Methode: GET
Bezeichnung: earth-fault-compensators
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/earth-fault-compensators?revision=1 mock-up-topology.openk.de]
Erdschlussdrosseln topologisches Basiselement
http-Methode: GET
Bezeichnung: grounding-impedances
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/grounding-impedances?revision=1 mock-up-topology.openk.de]
Feld Gruppierung
http-Methode: GET
Bezeichnung: bays
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/bays?revision=2 mock-up-topology.openk.de]
Lastgangschalter topologisches Basiselement
http-Methode: GET
Bezeichnung: load-break-switches
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/load-break-switches?revision=3 mock-up-topology.openk.de]
Leistungsschalter topologisches Basiselement
http-Methode: GET
Bezeichnung: breakers
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/breakers?revision=3 mock-up-topology.openk.de]
Petersenspulen topologisches Basiselement
http-Methode: GET
Bezeichnung: petersen-coils
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/petersen-coils?revision=1 mock-up-topology.openk.de]
Spannungsebene Gruppierung
http-Methode: GET
Bezeichnung: voltage-levels
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Sammelschiene topologisches Basiselement
http-Methode: GET
Bezeichnung: busbar-sections
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/busbar-sections?revision=3 mock-up-topology.openk.de]
Transformator topologisches Basiselement
http-Methode: GET
Bezeichnung: power-transformers
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/power-transformers?revision=3 mock-up-topology.openk.de]
Trennschalter topologisches Basiselement
http-Methode: GET
Bezeichnung: disconnectors
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/disconnectors?revision=3 mock-up-topology.openk.de]
Station Gruppierung
http-Methode: GET
Bezeichnung: substations
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/substations?revision=3 mock-up-topology.openk.de]
Stationsart Kategorisierung
http-Methode: GET
Bezeichnung: substation-types
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/substation-types?revision=3 mock-up-topology.openk.de]

Verbrauch

CIM-Model Load.svg

Bezeichnung Typ Beschreibung
Lasten mit Standardlastprofil
(veraltet) 		topologisches Basiselement
http-Methode: GET
Bezeichnung: conform-loads
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Lasten ohne Standardlastprofil
(veraltet) 		topologisches Basiselement
http-Methode: GET
Bezeichnung: non-conform-loads
aktuelle Version: 0
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Lasttyp
(veraltet) 		Kategorisierung
http-Methode: GET
Bezeichnung: load-types
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Standardlastprofilart
(veraltet) 		Kategorisierung
http-Methode: GET
Bezeichnung: conform-load-types
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
allgemeine Verbraucher Kategorisierung
http-Methode: GET
Bezeichnung: energy-consumers
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Link: [{{{link-protocol}}}://mock-up-topology.openk.de/source-system/topology/energy-consumers?revision=3 mock-up-topology.openk.de]
Abgerufen von „http://wiki.openkonsequenz.de/index.php?title=Quellsystem-API&oldid=793“