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: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://asset-data.openk.de/domain/common/contact-data/organisations?revision=1 asset-data.openk.de] |
|
|
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: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://asset-data.openk.de/domain/electricity/asset-data/asset-ownerships?revision=3 asset-data.openk.de] |
|
|
Einspeiserstammdaten (neu in CIM Cache Stufe II)
|
http-Methode: |
GET |
Bezeichnung: |
energy-sources |
aktuelle Version: |
1 |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://asset-data.openk.de/domain/electricity/asset-data/energy-sources?revision=1 asset-data.openk.de] |
|
|
Einspeiserstandorte (neu in CIM Cache Stufe II)
|
http-Methode: |
GET |
Bezeichnung: |
energy-source-locations |
aktuelle Version: |
1 |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://asset-data.openk.de/domain/electricity/asset-data/energy-source-locations?revision=1 asset-data.openk.de] |
|
|
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
|
http-Methode: |
GET |
Bezeichnung: |
topology |
aktuelle Version: |
Revision 2 (CIM 17v07) |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
|
|
topologische Ressourcen (neu in CIM Cache Stufe II)
|
|
http-Methode: |
GET |
Bezeichnung: |
topology |
aktuelle Version: |
Revision 2 (CIM 17v07) |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
|
|
|
topologische Ressourcen
|
|
http-Methode: |
GET |
Bezeichnung: |
power-system-resources |
aktuelle Version: |
Revision 1 (CIM 17v07) |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
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: |
Revision 1 (CIM 17v07) |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
|
|
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: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://measurement.openk.de/domain/electricity/measurement/measurement-values?revision=1 measurement.openk.de] |
|
|
Messpunkte (neu in CIM Cache Stufe II)
|
http-Methode: |
GET |
Bezeichnung: |
measurement-points |
aktuelle Version: |
1 |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://measurement.openk.de/domain/electricity/measurement/measurement-points?revision=1 measurement.openk.de] |
|
|
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: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://dynamic-topology.openk.de/domain/electricity/static-topology/base-voltages?revision=2 dynamic-topology.openk.de] |
|
|
Topologiekennung (neu in CIM Cache Stufe II)
|
http-Methode: |
GET |
Bezeichnung: |
topology-id |
aktuelle Version: |
1 |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://dynamic-topology.openk.de/domain/electricity/static-topology/topology-id?revision=1 dynamic-topology.openk.de] |
|
|
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: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://topology-state.openk.de/domain/electricity/topology-state/operating-states?revision=2 topology-state.openk.de] |
|
|
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: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://topology-state.openk.de/domain/electricity/topology-state/communication-states?revision=1 topology-state.openk.de] |
|
|
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: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://topology-state.openk.de/domain/electricity/topology-state/control-stages?revision=1 topology-state.openk.de] |
|
|
aktuelle Schalterstellungen (neu in CIM Cache Stufe II)
|
http-Methode: |
GET |
Bezeichnung: |
switch-states |
aktuelle Version: |
1 |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://topology-state.openk.de/domain/electricity/topology-state/switch-states?revision=1 topology-state.openk.de] |
|
|
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: |
api.openk.de |
Spezifikation: |
Swagger UI |
Testen: |
[{{{link-protocol}}}://topology-state.openk.de/domain/electricity/topology-state/tap-changer-states?revision=1 topology-state.openk.de] |
|
|