Domänen-API

Aus Wiki openKONSEQUENZ
Version vom 31. Juli 2017, 10:22 Uhr von FKorb (Diskussion | Beiträge) (basePath: /domain/measurement)

Wechseln zu: Navigation, Suche

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/measurement

Bezeichnung Typ Beschreibung
Schalterstellungen Messwert
http-Methode: GET
Bezeichnung: switch-states
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI

basePath: /domain/topology

Bezeichnung Typ Beschreibung
Topologie (Teil-)Topologie
http-Methode: GET
Bezeichnung: geographical-regions
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
topologische Elemente Eigenschaften
http-Methode: GET
Bezeichnung: sub-geographical-regions
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
topologische Elementtypen Eigenschaften
http-Methode: GET
Bezeichnung: sub-geographical-regions
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI