Domänen-API: Unterschied zwischen den Versionen

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „=Topologiedaten= Die Quellsystem-API (Source System API) stellt u. A. verschiedene Schnittstellen bereit, um topologische Elemente eines Netzes abfragen zu kö…“)
 
Zeile 1: Zeile 1:
=Topologiedaten=
+
=basePath: /domain/topology=
Die Quellsystem-API (Source System API) stellt u. A. verschiedene Schnittstellen bereit, um topologische Elemente eines Netzes abfragen zu können.
 
Die Aufgabe der Quellsystem-API ist darauf beschränkt, den Aufbau eines vollständigen Topologiemodells zu unterstützen. Umfassende Abfrage- und Selektionsmöglichkeiten werden nicht angeboten. Dies ist Aufgabe einer nachgelagerten Komponente ([[Topologiedatenmanagement]]). Diese Restriktion soll helfen, die datenliefernden Quellsysteme der Netzbetreiber zu entlasten und die Integration der Quellsystem-API zu erleichtern.
 
 
 
Um ein vollständiges Topologiemodell aufbauen zu können, stellt die Quellsystem-API prinzipiell drei Arten von Daten 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 <code>ConnectivityNode</code>). 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.
 
{{Warning|text = Bei der Betrachtung der Schnittstellendefinitionen im [http://editor.swagger.io Swagger Editor] werden u. U. Fehler angezeigt, da bestimmte Verweise [http://api.openk.de/source-system/source-system-classes_1.open-api.yaml gemeinsam genutzter Modellbeschreibungen] nicht aufgelöst werden können.<br/>Dies ist kein Fehler im Schnittstellendesign, sondern eine Eigenschaft des Editors.}}
 
==allgemeine Topologieelemente==
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
|-class="hintergrundfarbe6"
Zeile 29: Zeile 18:
 
|{{REST-GET|cim-version = 17.7|name = sub-geographical-regions|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|{{REST-GET|cim-version = 17.7|name = sub-geographical-regions|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|}
 
|}
 
==Erzeugung==
 
[[Datei:CIM-Model Generation.svg|490px]]
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Typ
 
!Beschreibung
 
|-
 
|[[Asynchrongenerator|Asynchrongenerator]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = asynchronous-machines|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
 
|-
 
|[[Erzeugungsart|Erzeugungsart]]
 
|Kategorisierung
 
|{{REST-GET|cim-version = 17.7|name = generation-types|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Kraftwerk|Kraftwerk]]
 
|Gruppierung
 
|{{REST-GET|cim-version = 17.7|name = plants|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[nicht-rotierende Energiequelle|nicht-rotierende Energiequelle]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = non-rotating-energies|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
 
|-
 
|[[Synchrongenerator|Synchrongenerator]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = synchronous-machines|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
 
|-
 
|[[Windkraftanlage|Windkraftanlage (Typ 3 oder 4)]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = wind-turbines-type-3-or-4|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
 
|}
 
 
==Leitungen und Leitungselemente==
 
[[Datei:CIM-Model Line.svg|568px]]
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Typ
 
!Beschreibung
 
|-
 
|[[Leitung]]
 
|Gruppierung
 
|{{REST-GET|cim-version = 17.7|name = lines|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Leitungsabschnitt]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = ac-line-segments|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Leitungsart]]
 
|Kategorisierung
 
|{{REST-GET|cim-version = 17.7|name = line-types|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Muffe]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = junctions|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|}
 
 
==Messung==
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Beschreibung
 
|-
 
|[[Wirkleistung|aktuelle Wirkleistung]]
 
|{{REST-GET|cim-version = 17.7|name = active-power|protocol = http|host = api.openk.de|base-path = source-system/measurement|revision = 0}}
 
|-
 
|[[Messeinrichtung|Messeinrichtung (aktuelle Wirkleistung)]]
 
|{{REST-GET|cim-version = 17.7|name = active-power-measurements|protocol = http|host = api.openk.de|base-path = source-system/measurement|revision = 1}}
 
|}
 
 
==Umspannwerk==
 
[[Datei:CIM-Model Substation.svg|817px]]
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Typ
 
!Beschreibung
 
|-
 
|[[Feld|Feld]]
 
|Gruppierung
 
|{{REST-GET|cim-version = 17.7|name = bays|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Lastgangschalter]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = load-break-switches|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Leistungsschalter]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = breakers|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Spannungsebene|Spannungsebene]]
 
|Gruppierung
 
|{{REST-GET|cim-version = 17.7|name = voltage-levels|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Sammelschiene]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = busbar-sections|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Transformator]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = power-transformers|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Trenner]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = disconnectors|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Umspannwerk|Umspannwerk]]
 
|Gruppierung
 
|{{REST-GET|cim-version = 17.7|name = substations|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Umspannwerkart|Umspannwerkart]]
 
|Kategorisierung
 
|{{REST-GET|cim-version = 17.7|name = substation-types|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|}
 
 
==Verbrauch==
 
[[Datei:CIM-Model Load.svg|489px]]
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Typ
 
!Beschreibung
 
|-
 
|[[Lasten mit Standardlastprofil|Lasten mit Standardlastprofil]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = conform-loads|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
 
|-
 
|[[Lasten ohne Standardlastprofil|Lasten ohne Standardlastprofil]]
 
|topologisches Basiselement
 
|{{REST-GET|cim-version = 17.7|name = non-conform-loads|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
 
|-
 
|[[Lasttyp|Lasttyp]]
 
|Kategorisierung
 
|{{REST-GET|cim-version = 17.7|name = load-types|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|[[Standardlastprofilart|Standardlastprofilart]]
 
|Kategorisierung
 
|{{REST-GET|cim-version = 17.7|name = conform-load-types|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|}
 
 
=Anlagenstammdaten=
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Beschreibung
 
|-
 
|[[Anlagen]]
 
|{{REST-GET|cim-version = 17.7|name = assets|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 1}}
 
|-
 
|[[Anlagenbetreiber]]
 
|{{REST-GET|cim-version = 17.7|name = asset-owners|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 1}}
 
|-
 
|[[Aufteilungen und Zuordnungen des Anlagenbetriebs]]
 
|{{REST-GET|cim-version = 17.7|name = ownerships|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 1}}
 
|-
 
|[[Anlagenstandort]]
 
|{{REST-GET|cim-version = 17.7|name = asset-locations|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 0}}
 
|-
 
|[[Anlagenverantwortlicher]]
 
|{{REST-GET|cim-version = 17.7|name = asset-operators|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 0}}
 
|}
 
''Kursiver Text''
 

Version vom 30. Juni 2017, 17:32 Uhr

basePath: /domain/topology

Bezeichnung Typ Beschreibung
Nennspannung Kategorisierung
http-Methode: GET
Bezeichnung: base-voltages
aktuelle Version: 1
Sprache (ISO 639-1): {{{language}}}
Quelltext: api.openk.de
Spezifikation: Swagger UI
Netzgebiet Gruppierung
http-Methode: GET
Bezeichnung: geographical-regions
aktuelle Version: 1
Sprache (ISO 639-1): {{{language}}}
Quelltext: api.openk.de
Spezifikation: Swagger UI
Teilnetzgebiet Gruppierung
http-Methode: GET
Bezeichnung: sub-geographical-regions
aktuelle Version: 1
Sprache (ISO 639-1): {{{language}}}
Quelltext: api.openk.de
Spezifikation: Swagger UI