Domänen-API: Unterschied zwischen den Versionen

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche
Zeile 1: Zeile 1:
 
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|AnlageDatenManagement (ADM)]] betreiben.)
 
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|AnlageDatenManagement (ADM)]] betreiben.)
  
Daher ist die D
+
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.
 
 
harmonisert den Zugriff auf die Quellsysteme des Netzbetreibers. Sie ist in ihren Abfragemöglichkeiten bewusst einfach gehalten, um die Integration zu vereinfachen und die Komplexität bei der Bereitstellung der Quellssystemdaten zu minimieren. Gleichzeitig sollen die datenliefernden Quellsysteme entlastet werden. Die Bereitstellung komfortabler, fachlicher Abfragen sowie umfassender Selektions- und Filtermöglichkeiten geschieht wiederverwendbar in den nachgelagerten Domänen-Modulen.
 
 
 
Im Folgenden werden die unterschiedlichen Schnittstellen-Methoden der Quellsystem-API vorgestellt:
 
  
 +
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|TopologieDatenManagement (TDM)]], [[MessDatenManagement|MessDatenManagement (MDM)]]:
  
 
__TOC__
 
__TOC__

Version vom 21. Juli 2017, 10:59 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 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):

Inhaltsverzeichnis

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