Domänen-API: Unterschied zwischen den Versionen

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche
(basePath: /domain/topology)
Zeile 10: Zeile 10:
  
  
==basePath: /domain/topology==
+
==basePath: /domain/measurement==
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
|-class="hintergrundfarbe6"
Zeile 17: Zeile 17:
 
!Beschreibung
 
!Beschreibung
 
|-
 
|-
|[[Nennspannung]]
+
|[[Schalterstellungen]]
 
|Kategorisierung
 
|Kategorisierung
 
|{{REST-GET|cim-version = 17v07|name = base-voltages|language = de|protocol = http|host = api.openk.de|base-path = domain/topology|revision = 1}}
 
|{{REST-GET|cim-version = 17v07|name = base-voltages|language = de|protocol = http|host = api.openk.de|base-path = domain/topology|revision = 1}}
 +
|}
 +
 +
==basePath: /domain/topology==
 +
{| class="wikitable sortable"
 +
|-class="hintergrundfarbe6"
 +
!Bezeichnung
 +
!Typ
 +
!Beschreibung
 
|-
 
|-
|[[Netzgebiet]]
+
|[[Topologie]]
 
|Gruppierung
 
|Gruppierung
 
|{{REST-GET|cim-version = 17v07|name = geographical-regions|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|{{REST-GET|cim-version = 17v07|name = geographical-regions|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|-
 
|-
|[[Teilnetzgebiet]]
+
|[[topologische Elemente]]
 +
|Gruppierung
 +
|{{REST-GET|cim-version = 17v07|name = sub-geographical-regions|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 +
|-
 +
|[[topologische Elementtypen]]
 
|Gruppierung
 
|Gruppierung
 
|{{REST-GET|cim-version = 17v07|name = sub-geographical-regions|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|{{REST-GET|cim-version = 17v07|name = sub-geographical-regions|language = de|protocol = http|host = api.openk.de|base-path = source-system/topology|revision = 1}}
 
|}
 
|}

Version vom 31. Juli 2017, 10:20 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 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 Kategorisierung
http-Methode: GET
Bezeichnung: base-voltages
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI

basePath: /domain/topology

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