Domänen-API: Unterschied zwischen den Versionen
FKorb (Diskussion | Beiträge) (→basePath: /domain/electricity/measurement) |
FKorb (Diskussion | Beiträge) (→basePath: /domain/electricity/topology-state) |
||
Zeile 180: | Zeile 180: | ||
==basePath: /domain/electricity/topology-state== | ==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|name = /operating-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.operating-states_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}} | ||
+ | |<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|name = /control-stage|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.control-stages_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}} | ||
+ | |<ul><li>topology-state v2.2</li></ul> | ||
+ | |- | ||
+ | |aktuelle Schalterstellungen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
+ | |{{REST-GET_2|name = /switch-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.switch-states_GET_1_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}} | ||
+ | |<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|name = /tap-changer-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.tap-changer-states_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}} | ||
+ | |<ul><li>topology-state v2.2</li></ul> | ||
+ | |} |
Version vom 19. September 2018, 12:35 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 |
|
| ||||||||||||||||||||||||||||||||||||||||||||||
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/topology-state
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aktueller Betriebszustand 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) |
|
|