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/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
|
Topologie
|
http-Methode: |
GET |
Bezeichnung: |
topology |
aktuelle Version: |
2 |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
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 Elemente
|
Eigenschaften
|
http-Methode: |
GET |
Bezeichnung: |
elements |
aktuelle Version: |
1 |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
|
Anwendungsfall
|
revision
|
timestamp
|
source
|
user-id
|
message-id
|
topology-id
|
element-types
|
entry-point-id
|
connection-state
|
selector
|
fetch-type
|
Abfrage der topologischen Elemente (Entitäten)
|
1
|
?
|
?
|
?
|
?
|
?
|
<<Liste der abzufragenden Elementtypen>>
|
<<eindeutige Kennung des Element-Containers>>
|
|
|
?
|
|
topologische Elementtypen
|
Eigenschaften
|
http-Methode: |
GET |
Bezeichnung: |
element-types |
aktuelle Version: |
1 |
Sprache (ISO 639-1): |
de |
Quelltext: |
api.openk.de |
Spezifikation: |
Swagger UI |
|
Anwendungsfall
|
revision
|
timestamp
|
source
|
user-id
|
message-id
|
topology-id
|
element-types
|
entry-point-id
|
connection-state
|
selector
|
fetch-type
|
Abfrage aller topologischen Elementtypen
|
1
|
?
|
?
|
?
|
?
|
?
|
|
|
|
|
|
|