Domänen-API: Unterschied zwischen den Versionen
FKorb (Diskussion | Beiträge) |
(→basePath: /domain/electricity/dynamic-topology) |
||
(135 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | =basePath: /domain/topology= | + | 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.) |
+ | |||
+ | 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|TopologieDatenManagement (TDM)]], [[MessDatenManagement|MessDatenManagement (MDM)]]) implementiert werden: | ||
+ | |||
+ | |||
+ | __TOC__ | ||
+ | |||
+ | |||
+ | ==basePath: /domain/common/contact-data== | ||
+ | {| class="wikitable sortable" | ||
+ | |-class="hintergrundfarbe6" | ||
+ | !Bezeichnung | ||
+ | !Beschreibung | ||
+ | !bereitstellendes System | ||
+ | |- | ||
+ | |Unternehmen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>asset-data v2.2</li></ul> | ||
+ | |} | ||
+ | |||
+ | ==basePath: /domain/electricity/asset-data== | ||
+ | {| class="wikitable sortable" | ||
+ | |-class="hintergrundfarbe6" | ||
+ | !Bezeichnung | ||
+ | !Beschreibung | ||
+ | !bereitstellendes System | ||
+ | |- | ||
+ | |Anlagen-Eigentumsverhältnisse<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>asset-data v2.2</li></ul> | ||
+ | |- | ||
+ | |Einspeiserstammdaten<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>asset-data v2.2</li></ul> | ||
+ | |- | ||
+ | |Einspeiserstandorte<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>asset-data v2.2</li></ul> | ||
+ | |} | ||
+ | |||
+ | ==basePath: /domain/electricity/dynamic-topology== | ||
+ | {{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 5: | Zeile 55: | ||
!Typ | !Typ | ||
!Beschreibung | !Beschreibung | ||
+ | !unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1" | ||
+ | |- | ||
+ | |Topologie | ||
+ | |Topologie | ||
+ | |{{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 | ||
+ | | | ||
+ | |} | ||
+ | |- | ||
+ | |topologische Ressourcen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | | | ||
+ | |{{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}} | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |topologische Ressourcen | ||
+ | | | ||
+ | |{{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}} | ||
+ | |||
+ | | | ||
+ | {| class="wikitable sortable" | ||
+ | !Anwendungsfall | ||
+ | !revision | ||
+ | !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>> | ||
+ | | | ||
+ | | | ||
+ | |? | ||
+ | |} | ||
+ | |- | ||
+ | |topologische Ressourcentypen | ||
+ | |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 | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | |} | ||
+ | |- | ||
+ | |} | ||
+ | |||
+ | ==basePath: /domain/electricity/measurement== | ||
+ | {| class="wikitable sortable" | ||
+ | |-class="hintergrundfarbe6" | ||
+ | !Bezeichnung | ||
+ | !Beschreibung | ||
+ | !bereitstellendes System | ||
+ | |- | ||
+ | |aktuelle Messwerte<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>measurement v2.2</li></ul> | ||
+ | |- | ||
+ | |Messpunkte<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>measurement v2.2</li></ul> | ||
+ | |} | ||
+ | |||
+ | ==basePath: /domain/electricity/static-topology== | ||
+ | {| class="wikitable sortable" | ||
+ | |-class="hintergrundfarbe6" | ||
+ | !Bezeichnung | ||
+ | !Beschreibung | ||
+ | !bereitstellendes System | ||
+ | |- | ||
+ | |Nennspannungen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>static-topology v2.2</li></ul> | ||
+ | |- | ||
+ | |Topologiekennung<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>static-topology v2.2</li></ul> | ||
+ | |- | ||
+ | |Inhalt topologischer Container<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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}} | ||
+ | |<ul><li>static-topology v2.2</li></ul> | ||
+ | |} | ||
+ | |||
+ | ==basePath: /domain/electricity/topology-state== | ||
+ | {| class="wikitable sortable" | ||
+ | |-class="hintergrundfarbe6" | ||
+ | !Bezeichnung | ||
+ | !Beschreibung | ||
+ | !bereitstellendes System | ||
+ | |- | ||
+ | |aktueller Betriebszustand der Einspeiser<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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> | ||
+ | |- | ||
+ | |aktueller Kommunikationsstatus der Einspeiser<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{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> | ||
|- | |- | ||
− | | | + | |aktuelle Regelstufe der Einspeiser<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> |
− | + | |{{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}} | |
− | |{{REST- | + | |<ul><li>topology-state v2.2</li></ul> |
|- | |- | ||
− | | | + | |aktuelle Schalterstellungen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> |
− | + | |{{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}} | |
− | |{{REST- | + | |<ul><li>topology-state v2.2</li></ul> |
|- | |- | ||
− | | | + | |aktuelle Stellung der Transformatorstufenschalter<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> |
− | + | |{{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}} | |
− | |{{REST- | + | |<ul><li>topology-state v2.2</li></ul> |
|} | |} |
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:
Inhaltsverzeichnis
basePath: /domain/common/contact-data
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Unternehmen (neu in CIM Cache Stufe II) |
|
|
basePath: /domain/electricity/asset-data
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anlagen-Eigentumsverhältnisse (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Einspeiserstammdaten (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Einspeiserstandorte (neu in CIM Cache Stufe II) |
|
|
basePath: /domain/electricity/dynamic-topology
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 |
|
| |||||||||||||||||||||||||||||||||||||||||||||
topologische Ressourcen (neu in CIM Cache Stufe II) |
|
|||||||||||||||||||||||||||||||||||||||||||||||
topologische Ressourcen |
|
| ||||||||||||||||||||||||||||||||||||||||||||||
topologische Ressourcentypen | Eigenschaften |
|
|
basePath: /domain/electricity/measurement
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aktuelle Messwerte (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Messpunkte (neu in CIM Cache Stufe II) |
|
|
basePath: /domain/electricity/static-topology
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Nennspannungen (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Topologiekennung (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Inhalt topologischer Container (neu in CIM Cache Stufe II) |
|
|
basePath: /domain/electricity/topology-state
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aktueller Betriebszustand der Einspeiser (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
aktueller Kommunikationsstatus der Einspeiser (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
aktuelle Regelstufe der Einspeiser (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
aktuelle Schalterstellungen (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
aktuelle Stellung der Transformatorstufenschalter (neu in CIM Cache Stufe II) |
|
|