Domänen-API: Unterschied zwischen den Versionen

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche
(→‎basePath: /domain/dynamic-topology)
(→‎basePath: /domain/dynamic-topology)
Zeile 23: Zeile 23:
 
|
 
|
 
  {| class="wikitable sortable"
 
  {| class="wikitable sortable"
−
  !Parameter
+
  !Anwendungsfall
−
  !Werte
+
  !revision
 +
!timestamp
 +
!source
 +
!user-id
 +
!message-id
 +
!topology-id
 +
!element-types
 +
!entry-point-id
 +
!connection-state
 +
!selector
 +
!fetch-type
 
  |-
 
  |-
−
  | Zelle A
+
  |gesamte statische Topologie
 +
|2
 +
|
 +
|
 +
|
 +
|
 +
|
 +
|
 +
|
 +
|
 +
|Ignore
 +
|All
 
  |
 
  |
 
  |-
 
  |-
−
  | Zelle B
+
  |statische Teilnetze (unter Schalternormalstellung) unterhalb einer Station
 +
|2
 +
|
 +
|
 +
|
 +
|
 +
|
 +
|
 +
|power-transformer
 +
|Id des Transformators
 +
|Normal
 +
|Behind
 
  |
 
  |
 
  |}
 
  |}

Version vom 24. Oktober 2017, 18: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:



basePath: /domain/dynamic-topology

Bezeichnung Typ Beschreibung Ertüchtigung Stufe 1
Topologie Topologie
http-Methode: GET
Bezeichnung: topology
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Anwendungsfall revision timestamp source user-id message-id topology-id element-types entry-point-id connection-state selector fetch-type
gesamte statische Topologie 2 Ignore All
statische Teilnetze (unter Schalternormalstellung) unterhalb einer Station 2 power-transformer Id des Transformators Normal Behind
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
Abgerufen von „http://wiki.openkonsequenz.de/index.php?title=Domänen-API&oldid=850“