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 umfassender Selektions- und Filtermöglichkeiten.
Da es denkbar ist, dass auf Ebene der Domänen-Module Software eingesetzt wird, die nicht im Standard-oK-Portfolie vorhanden ist, kann die Domänen-API (Domain API) nicht vollständig umrissen werden.
Im Folgenden werden die Schnittstellen-Methoden vorgestellt, die durch die Domänen-Module des oK-CIM-Caches (1. Ausbaustufe) (TopologieDatenManagement (TDM), MessDatenManagement (MDM):
basePath: /domain/topology
| Bezeichnung
|
Typ
|
Beschreibung
|
| Nennspannung
|
Kategorisierung
|
| http-Methode: |
GET |
| Bezeichnung: |
base-voltages |
| aktuelle Version: |
1 |
| Sprache (ISO 639-1): |
de |
| Quelltext: |
api.openk.de |
| Spezifikation: |
Swagger UI |
|
| Netzgebiet
|
Gruppierung
|
| http-Methode: |
GET |
| Bezeichnung: |
geographical-regions |
| aktuelle Version: |
1 |
| Sprache (ISO 639-1): |
de |
| Quelltext: |
api.openk.de |
| Spezifikation: |
Swagger UI |
|
| Teilnetzgebiet
|
Gruppierung
|
| http-Methode: |
GET |
| Bezeichnung: |
sub-geographical-regions |
| aktuelle Version: |
1 |
| Sprache (ISO 639-1): |
de |
| Quelltext: |
api.openk.de |
| Spezifikation: |
Swagger UI |
|
