Domänen-API: Unterschied zwischen den Versionen
Aus Wiki openKONSEQUENZ
FKorb (Diskussion | Beiträge) (→basePath: /domain/electricity/dynamic-topology) |
FKorb (Diskussion | Beiträge) (→basePath: /domain/electricity/topology-state) |
||
| Zeile 177: | Zeile 177: | ||
|{{REST-GET_2|name = measurement-points|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/measurement/domain.electricity.measurement.measurement-points_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}} | |{{REST-GET_2|name = measurement-points|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/measurement/domain.electricity.measurement.measurement-points_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}} | ||
|<ul><li>measurement v2.2</li></ul> | |<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|name = /base-voltages|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/static-topology/domain.electricity.static-topology.base-voltages_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}} | ||
| + | |<ul><li>static-topology v2.2</li></ul> | ||
| + | |- | ||
| + | |Topologiekennung<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
| + | |{{REST-GET_2|name = /topology-id|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/static-topology/domain.electricity.static-topology.topology-id_GET_1_de.open-api.yaml|revision = Revision 1 (CIM-Profile openKONSEQUENZ)}} | ||
| + | |<ul><li>static-topology v2.2</li></ul> | ||
|} | |} | ||
Version vom 19. September 2018, 12:03 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
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 (Neue Funktionen in CIM Cache Stufe II) |
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/static-topology
| Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Nennspannungen (neu in CIM Cache Stufe II) |
|
| ||||||||||||
| Topologiekennung (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) |
|
|
