Domänen-API: Unterschied zwischen den Versionen

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche
(basePath: /domain/topology)
(basePath: /domain/measurement)
Zeile 9: Zeile 9:
 
__TOC__
 
__TOC__
  
 
==basePath: /domain/measurement==
 
{| class="wikitable sortable"
 
|-class="hintergrundfarbe6"
 
!Bezeichnung
 
!Typ
 
!Beschreibung
 
|-
 
|[[Schalterstellungen]]
 
|Messwert
 
|{{REST-GET|cim-version = 17v07|name = switch-states|language = de|protocol = http|host = api.openk.de|base-path = domain/measurement|revision = 1}}
 
|}
 
  
 
==basePath: /domain/topology==
 
==basePath: /domain/topology==

Version vom 31. Juli 2017, 20:13 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:


Inhaltsverzeichnis


basePath: /domain/topology

Bezeichnung Typ Beschreibung
Topologie (Teil-)Topologie
http-Methode: GET
Bezeichnung: topology
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
topologische Elemente Eigenschaften
http-Methode: GET
Bezeichnung: elements
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
topologische Elementtypen Eigenschaften
http-Methode: GET
Bezeichnung: element-types
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI