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ö…“)
 
(→‎basePath: /domain/electricity/dynamic-topology)
 
(136 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
=Topologiedaten=
+
Die Domänen-API (Domain API) bildet die Gesamtheit aller angebotenen Schnittstellen der fachlichen Domänen-Module. Da der Einsatz der Domänen-Module pro Netzbetreiber individuell sein kann, können die jeweils unterstützten Anwendungsfälle und Schnittstellen-Methoden varieren (z. B.: Wer Anlagestammdaten abfragen möchte, muss das Domänen-Modul [[AnlageDatenManagement|AnlageDatenManagement (ADM)]] betreiben.)
−
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:
+
Grundsätzlich bieten Domänen-Module fachlich wiederverwendbare Funktionen an. Im Gegensatz zur [[Quellsystem-API]] ermöglichen die Schnittellen der Domänen-Module komfortable, fachliche Abfragen sowie umfassende Selektions- und Filtermöglichkeiten.
−
* 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.
+
Es ist grundsätzlich denkbar, dass auf Ebene der Domänen-Module Software eingesetzt wird, die nicht im Standard-oK-Portfolie enthalten ist. An dieser Stelle wird daher ausschließlich die Domänen-API (Domain API) definiert, die als gemeinsamer oK-Standard Verwendung findet.
−
{{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.}}
+
Im Folgenden werden die Schnittstellen-Methoden vorgestellt, die durch die Domänen-Module des oK-CIM-Caches (1. Ausbaustufe) ([[TopologieDatenManagement|TopologieDatenManagement (TDM)]], [[MessDatenManagement|MessDatenManagement (MDM)]]) implementiert werden:
−
==allgemeine Topologieelemente==
+
 
 +
 
 +
__TOC__
 +
 
 +
 
 +
==basePath: /domain/common/contact-data==
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Bezeichnung
−
!Typ
 
 
!Beschreibung
 
!Beschreibung
 +
!bereitstellendes System
 
|-
 
|-
−
|[[Nennspannung]]
+
|Unternehmen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|Kategorisierung
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/common/contact-data|name = organisations|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.common.contact-data.organisations_GET_1_de.open-api.yaml|revision = 1}}
−
|{{REST-GET|cim-version = 17.7|name = base-voltages|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
+
|<ul><li>asset-data v2.2</li></ul>
−
|-
 
−
|[[Netzgebiet]]
 
−
|Gruppierung
 
−
|{{REST-GET|cim-version = 17.7|name = geographical-regions|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
−
|-
 
−
|[[Teilnetzgebiet]]
 
−
|Gruppierung
 
−
|{{REST-GET|cim-version = 17.7|name = sub-geographical-regions|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
 
|}
 
|}
  
−
==Erzeugung==
+
==basePath: /domain/electricity/asset-data==
−
[[Datei:CIM-Model Generation.svg|490px]]
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Bezeichnung
−
!Typ
 
 
!Beschreibung
 
!Beschreibung
 +
!bereitstellendes System
 
|-
 
|-
−
|[[Asynchrongenerator|Asynchrongenerator]]
+
|Anlagen-Eigentumsverhältnisse<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|topologisches Basiselement
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/asset-data|name = asset-ownerships|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.asset-data.asset-ownerships_GET_3_de.open-api.yaml|revision = 3}}
−
|{{REST-GET|cim-version = 17.7|name = asynchronous-machines|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
+
|<ul><li>asset-data v2.2</li></ul>
−
|-
 
−
|[[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]]
+
|Einspeiserstammdaten<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|topologisches Basiselement
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/asset-data|name = energy-sources|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.asset-data.energy-sources_GET_1_de.open-api.yaml|revision = 1}}
−
|{{REST-GET|cim-version = 17.7|name = non-rotating-energies|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
+
|<ul><li>asset-data v2.2</li></ul>
 
|-
 
|-
−
|[[Synchrongenerator|Synchrongenerator]]
+
|Einspeiserstandorte<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|topologisches Basiselement
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/asset-data|name = energy-source-locations|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.asset-data.energy-source-locations_GET_1_de.open-api.yaml|revision = 1}}
−
|{{REST-GET|cim-version = 17.7|name = synchronous-machines|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
+
|<ul><li>asset-data v2.2</li></ul>
−
|-
 
−
|[[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==
+
==basePath: /domain/electricity/dynamic-topology==
−
[[Datei:CIM-Model Line.svg|568px]]
+
{{Information|text=Bei der Ausprägung der folgenden Schnittstellen wurde bewusst darauf geachtet, diese möglichst allgemeingültig und für eine Vielzahl künftiger Anwendungsfälle zu konzipieren. Damit unterstützen die im Rahmen des Projektes "CIM-Cache Ertüchtigung Stufe 1" entstandenen Schnittstellen eine Obermenge der definierten Anwendungsfälle, Selektions- bzw. Filterkriterien. Die Spalte "Ertüchtigung Stufe 1" der jeweiligen Schnittstellendefinition beschreibt die bereits jetzt durch den CIM-Cache ermöglichten Abfragen.
 +
<p>Hierbei gelten folgende Konventionen:
 +
*<b>"?"</b> frei wählbar gemäß Schnittstellendefinition
 +
*<b>" "</b> Parameter nicht unterstützt
 +
*<b>"<< >>"</b> Beschreibung des zu ersetzenden Wertes
 +
</p>}}
 +
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
|-class="hintergrundfarbe6"
Zeile 70: Zeile 55:
 
!Typ
 
!Typ
 
!Beschreibung
 
!Beschreibung
 +
!unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1"
 
|-
 
|-
−
|[[Leitung]]
+
|Topologie
−
|Gruppierung
+
|Topologie
−
|{{REST-GET|cim-version = 17.7|name = lines|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
+
|{{REST-GET_2|name = topology|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.dynamic-topology.topology_GET_2_de.open-api.yaml|revision =  2}}
 +
|
 +
{| class="wikitable sortable"
 +
!Anwendungsfall
 +
!revision
 +
!timestamp
 +
!source
 +
!user-id
 +
!message-id
 +
!topology-id
 +
!entry-point-id
 +
!connection-state
 +
!selector
 +
!fetch-type
 +
|-
 +
|<i>[https://169.50.13.150/domain/electricity/dynamic-topology/topology?revision=2&connection-state=Ignore&selector=All Abfrage der gesamten statischen Topologie]</i>
 +
|2
 +
|?
 +
|?
 +
|?
 +
|?
 +
|?
 +
|
 +
|Ignore
 +
|All
 +
|
 +
|-
 +
|<i>[https://169.50.13.150/domain/electricity/dynamic-topology/topology?revision=2&entry-point-id=abddaf44-13e6-46a3-8f87-0d675ea78659&connection-state=Normal&selector=Behind Abfrage statischer Teilnetze (unter Schalternormalstellung) unterhalb eines Transformators]</i>
 +
|2
 +
|?
 +
|?
 +
|?
 +
|?
 +
|?
 +
|<<eindeutige Kennung des Transformators>>
 +
|Normal
 +
|Behind
 +
|
 +
|}
 
|-
 
|-
−
|[[Leitungsabschnitt]]
+
|topologische Ressourcen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|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}}
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/static-topology|name = topological-resources|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.static-topology.topological-resources_GET_2_de.open-api.yaml|revision = 2}}
 +
|
 +
|
 +
|
 
|-
 
|-
−
|[[Leitungsart]]
+
|topologische Ressourcen
−
|Kategorisierung
+
|
−
|{{REST-GET|cim-version = 17.7|name = line-types|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
+
|{{REST-GET_2|name = power-system-resources|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.dynamic-topology.power-system-resources_GET_1_de.open-api.yaml|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="wikitable sortable"
−
|-class="hintergrundfarbe6"
+
!Anwendungsfall
−
!Bezeichnung
+
!revision
−
!Beschreibung
+
!timestamp
 +
!source
 +
!user-id
 +
!message-id
 +
!topology-id
 +
!power-system-resource-types
 +
!entry-point-id
 +
!connection-state
 +
!selector
 +
!fetch-type
 +
|-
 +
|<i>[https://169.50.13.150/domain/electricity/dynamic-topology/power-system-resources?revision=1&power-system-resource-types=power-transformer Abfrage der topologischen Elemente (Entitäten)]</i>
 +
|1
 +
|?
 +
|?
 +
|?
 +
|?
 +
|?
 +
|<<Liste der abzufragenden Ressourcentypen>>
 +
|<<eindeutige Kennung des Element-Containers>>
 +
|
 +
|
 +
|?
 +
|}
 
|-
 
|-
−
|[[Wirkleistung|aktuelle Wirkleistung]]
+
|topologische Ressourcentypen
−
|{{REST-GET|cim-version = 17.7|name = active-power|protocol = http|host = api.openk.de|base-path = source-system/measurement|revision = 0}}
+
|Eigenschaften
 +
|{{REST-GET_2|name = power-system-resource-types|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.dynamic-topology.power-system-resource-types_GET_1_de.open-api.yaml|revision = 1}}
 +
|
 +
{| class="wikitable sortable"
 +
!Anwendungsfall
 +
!revision
 +
!timestamp
 +
!source
 +
!user-id
 +
!message-id
 +
!topology-id
 +
!entry-point-id
 +
!connection-state
 +
!selector
 +
!fetch-type
 +
|-
 +
|<i>[https://169.50.13.150/domain/electricity/dynamic-topology/power-system-resource-types?revision=1 Abfrage aller topologischen Elementtypen]</i>
 +
|1
 +
|?
 +
|?
 +
|?
 +
|?
 +
|?
 +
|
 +
|
 +
|
 +
|
 +
|}
 
|-
 
|-
−
|[[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==
+
==basePath: /domain/electricity/measurement==
−
[[Datei:CIM-Model Substation.svg|817px]]
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Bezeichnung
−
!Typ
 
 
!Beschreibung
 
!Beschreibung
 +
!bereitstellendes System
 
|-
 
|-
−
|[[Feld|Feld]]
+
|aktuelle Messwerte<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|Gruppierung
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/measurement|name = measurement-values|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.measurement.measurement-values_GET_1_de.open-api.yaml|revision = 1}}
−
|{{REST-GET|cim-version = 17.7|name = bays|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
+
|<ul><li>measurement v2.2</li></ul>
−
|-
 
−
|[[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]]
+
|Messpunkte<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|topologisches Basiselement
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/measurement|name = measurement-points|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.measurement.measurement-points_GET_1_de.open-api.yaml|revision = 1}}
−
|{{REST-GET|cim-version = 17.7|name = disconnectors|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
+
|<ul><li>measurement v2.2</li></ul>
−
|-
 
−
|[[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==
+
==basePath: /domain/electricity/static-topology==
−
[[Datei:CIM-Model Load.svg|489px]]
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Bezeichnung
−
!Typ
 
 
!Beschreibung
 
!Beschreibung
 +
!bereitstellendes System
 
|-
 
|-
−
|[[Lasten mit Standardlastprofil|Lasten mit Standardlastprofil]]
+
|Nennspannungen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|topologisches Basiselement
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/static-topology|name = base-voltages|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.static-topology.base-voltages_GET_2_de.open-api.yaml|revision = 2}}
−
|{{REST-GET|cim-version = 17.7|name = conform-loads|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 0}}
+
|<ul><li>static-topology v2.2</li></ul>
−
|-
 
−
|[[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]]
+
|Topologiekennung<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|Kategorisierung
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/static-topology|name = topology-id|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.static-topology.topology-id_GET_1_de.open-api.yaml|revision = 1}}
−
|{{REST-GET|cim-version = 17.7|name = load-types|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
+
|<ul><li>static-topology v2.2</li></ul>
 
|-
 
|-
−
|[[Standardlastprofilart|Standardlastprofilart]]
+
|Inhalt topologischer Container<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|Kategorisierung
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/static-topology|name = equipment-container-content|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.static-topology.equipment-container-content_GET_1_de.open-api.yaml|revision = 1}}
−
|{{REST-GET|cim-version = 17.7|name = conform-load-types|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
+
|<ul><li>static-topology v2.2</li></ul>
 
|}
 
|}
  
−
=Anlagenstammdaten=
+
==basePath: /domain/electricity/topology-state==
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Bezeichnung
 
!Beschreibung
 
!Beschreibung
 +
!bereitstellendes System
 
|-
 
|-
−
|[[Anlagen]]
+
|aktueller Betriebszustand der Einspeiser<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|{{REST-GET|cim-version = 17.7|name = assets|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 1}}
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/topology-state|name = operating-states|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.topology-state.operating-states_GET_2_de.open-api.yaml|revision = 2}}
 +
|<ul><li>topology-state v2.2</li></ul>
 
|-
 
|-
−
|[[Anlagenbetreiber]]
+
|aktueller Kommunikationsstatus der Einspeiser<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|{{REST-GET|cim-version = 17.7|name = asset-owners|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 1}}
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/topology-state|name = communication-states|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.topology-state.communication-states_GET_1_de.open-api.yaml|revision = 1}}
 +
|<ul><li>topology-state v2.2</li></ul>
 
|-
 
|-
−
|[[Aufteilungen und Zuordnungen des Anlagenbetriebs]]
+
|aktuelle Regelstufe der Einspeiser<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|{{REST-GET|cim-version = 17.7|name = ownerships|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 1}}
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/topology-state|name = control-stages|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.topology-state.control-stages_GET_1_de.open-api.yaml|revision = 1}}
 +
|<ul><li>topology-state v2.2</li></ul>
 
|-
 
|-
−
|[[Anlagenstandort]]
+
|aktuelle Schalterstellungen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|{{REST-GET|cim-version = 17.7|name = asset-locations|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 0}}
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/topology-state|name = switch-states|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.topology-state.switch-states_GET_1_de.open-api.yaml|revision = 1}}
 +
|<ul><li>topology-state v2.2</li></ul>
 
|-
 
|-
−
|[[Anlagenverantwortlicher]]
+
|aktuelle Stellung der Transformatorstufenschalter<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font>
−
|{{REST-GET|cim-version = 17.7|name = asset-operators|protocol = http|host = api.openk.de|base-path = source-system/assets|revision = 0}}
+
|{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/electricity/topology-state|name = tap-changer-states|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.electricity.topology-state.tap-changer-states_GET_1_de.open-api.yaml|revision = 1}}
 +
|<ul><li>topology-state v2.2</li></ul>
 
|}
 
|}
−
''Kursiver Text''
 

Aktuelle Version vom 22. Juni 2020, 09:25 Uhr

Die Domänen-API (Domain API) bildet die Gesamtheit aller angebotenen Schnittstellen der fachlichen Domänen-Module. Da der Einsatz der Domänen-Module pro Netzbetreiber individuell sein kann, können die jeweils unterstützten Anwendungsfälle und Schnittstellen-Methoden varieren (z. B.: Wer Anlagestammdaten abfragen möchte, muss das Domänen-Modul AnlageDatenManagement (ADM) betreiben.)

Grundsätzlich bieten Domänen-Module fachlich wiederverwendbare Funktionen an. Im Gegensatz zur Quellsystem-API ermöglichen die Schnittellen der Domänen-Module komfortable, fachliche Abfragen sowie umfassende Selektions- und Filtermöglichkeiten.

Es ist grundsätzlich denkbar, dass auf Ebene der Domänen-Module Software eingesetzt wird, die nicht im Standard-oK-Portfolie enthalten ist. An dieser Stelle wird daher ausschließlich die Domänen-API (Domain API) definiert, die als gemeinsamer oK-Standard Verwendung findet. Im Folgenden werden die Schnittstellen-Methoden vorgestellt, die durch die Domänen-Module des oK-CIM-Caches (1. Ausbaustufe) (TopologieDatenManagement (TDM), MessDatenManagement (MDM)) implementiert werden:



basePath: /domain/common/contact-data

Bezeichnung Beschreibung bereitstellendes System
Unternehmen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: organisations
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • asset-data v2.2

basePath: /domain/electricity/asset-data

Bezeichnung Beschreibung bereitstellendes System
Anlagen-Eigentumsverhältnisse
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: asset-ownerships
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • asset-data v2.2
Einspeiserstammdaten
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: energy-sources
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • asset-data v2.2
Einspeiserstandorte
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: energy-source-locations
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • asset-data v2.2

basePath: /domain/electricity/dynamic-topology

Information.icon.svg Bei der Ausprägung der folgenden Schnittstellen wurde bewusst darauf geachtet, diese möglichst allgemeingültig und für eine Vielzahl künftiger Anwendungsfälle zu konzipieren. Damit unterstützen die im Rahmen des Projektes "CIM-Cache Ertüchtigung Stufe 1" entstandenen Schnittstellen eine Obermenge der definierten Anwendungsfälle, Selektions- bzw. Filterkriterien. Die Spalte "Ertüchtigung Stufe 1" der jeweiligen Schnittstellendefinition beschreibt die bereits jetzt durch den CIM-Cache ermöglichten Abfragen.

Hierbei gelten folgende Konventionen:

  • "?" frei wählbar gemäß Schnittstellendefinition
  • " " Parameter nicht unterstützt
  • "<< >>" Beschreibung des zu ersetzenden Wertes


Bezeichnung Typ Beschreibung unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1"
Topologie Topologie
http-Methode: GET
Bezeichnung: topology
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Anwendungsfall revision timestamp source user-id message-id topology-id entry-point-id connection-state selector fetch-type
Abfrage der gesamten statischen Topologie 2 ? ? ? ? ? Ignore All
Abfrage statischer Teilnetze (unter Schalternormalstellung) unterhalb eines Transformators 2 ? ? ? ? ? <<eindeutige Kennung des Transformators>> Normal Behind
topologische Ressourcen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: topological-resources
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
topologische Ressourcen
http-Methode: GET
Bezeichnung: power-system-resources
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI


Anwendungsfall revision timestamp source user-id message-id topology-id power-system-resource-types entry-point-id connection-state selector fetch-type
Abfrage der topologischen Elemente (Entitäten) 1 ? ? ? ? ? <<Liste der abzufragenden Ressourcentypen>> <<eindeutige Kennung des Element-Containers>> ?
topologische Ressourcentypen Eigenschaften
http-Methode: GET
Bezeichnung: power-system-resource-types
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Anwendungsfall revision timestamp source user-id message-id topology-id entry-point-id connection-state selector fetch-type
Abfrage aller topologischen Elementtypen 1 ? ? ? ? ?

basePath: /domain/electricity/measurement

Bezeichnung Beschreibung bereitstellendes System
aktuelle Messwerte
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: measurement-values
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • measurement v2.2
Messpunkte
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: measurement-points
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • measurement v2.2

basePath: /domain/electricity/static-topology

Bezeichnung Beschreibung bereitstellendes System
Nennspannungen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: base-voltages
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • static-topology v2.2
Topologiekennung
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: topology-id
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • static-topology v2.2
Inhalt topologischer Container
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: equipment-container-content
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • static-topology v2.2

basePath: /domain/electricity/topology-state

Bezeichnung Beschreibung bereitstellendes System
aktueller Betriebszustand der Einspeiser
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: operating-states
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • topology-state v2.2
aktueller Kommunikationsstatus der Einspeiser
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: communication-states
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • topology-state v2.2
aktuelle Regelstufe der Einspeiser
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: control-stages
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • topology-state v2.2
aktuelle Schalterstellungen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: switch-states
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • topology-state v2.2
aktuelle Stellung der Transformatorstufenschalter
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: tap-changer-states
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: demo.openkonsequenz.de/swagger-ui/doc
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • topology-state v2.2
Abgerufen von „http://wiki.openkonsequenz.de/index.php?title=Domänen-API&oldid=2042“