Domänen-API: Unterschied zwischen den Versionen
FKorb (Diskussion | Beiträge) (→basePath: /domain/dynamic-topology) |
FKorb (Diskussion | Beiträge) (→basePath: /domain/dynamic-topology) |
||
Zeile 81: | Zeile 81: | ||
|{{REST-GET|cim-version = 17v07|name = element-types|language = de|protocol = http|host = api.openk.de|base-path = domain/dynamic-topology|revision = 1}} | |{{REST-GET|cim-version = 17v07|name = element-types|language = de|protocol = http|host = api.openk.de|base-path = domain/dynamic-topology|revision = 1}} | ||
| | | | ||
+ | {| class="wikitable sortable" | ||
+ | !Anwendungsfall | ||
+ | !revision | ||
+ | !timestamp | ||
+ | !source | ||
+ | !user-id | ||
+ | !message-id | ||
+ | !topology-id | ||
+ | !element-types | ||
+ | !entry-point-id | ||
+ | !connection-state | ||
+ | !selector | ||
+ | !fetch-type | ||
+ | |- | ||
+ | |<i>Abfrage der gesamten statischen Topologie</i> | ||
+ | |2 | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | |Ignore | ||
+ | |All | ||
+ | | | ||
+ | |- | ||
+ | |<i>Abfrage statischer Teilnetze (unter Schalternormalstellung) unterhalb eines Transformators</i> | ||
+ | |2 | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | |? | ||
+ | | | ||
+ | |power-transformer | ||
+ | |<<Id des Transformators>> | ||
+ | |Normal | ||
+ | |Behind | ||
+ | | | ||
+ | |} | ||
|} | |} |
Version vom 24. Oktober 2017, 19:40 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/dynamic-topology
Hierbei gelten folgende Konventionen:
- "?" frei wählbar gemäß Schnittstellendefinition
- " " Parameter nicht unterstützt
- "<< >>" Beschreibung des zu ersetzenden Wertes
Bezeichnung | Typ | Beschreibung | Ertüchtigung Stufe 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Topologie | Topologie |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
topologische Elemente | Eigenschaften |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
topologische Elementtypen | Eigenschaften |
|
|