Domänen-API: Unterschied zwischen den Versionen
FKorb (Diskussion | Beiträge) (→basePath: /domain/dynamic-topology) |
FKorb (Diskussion | Beiträge) (→basePath: /domain/dynamic-topology) |
||
Zeile 64: | Zeile 64: | ||
|? | |? | ||
|power-transformer | |power-transformer | ||
− | |<< | + | |<<eindeutige Kennung des Transformators>> |
|Normal | |Normal | ||
|Behind | |Behind | ||
Zeile 88: | Zeile 88: | ||
!fetch-type | !fetch-type | ||
|- | |- | ||
− | |<i>Abfrage | + | |<i>Abfrage der topologischen Elemente (Entitäten)</i> |
|1 | |1 | ||
|? | |? | ||
Zeile 95: | Zeile 95: | ||
|? | |? | ||
|? | |? | ||
− | | | + | |<<Liste der abzufragenden Elementtypen>> |
− | | | + | |<<eindeutige Kennung des Element-Containers>> |
| | | | ||
| | | |
Version vom 24. Oktober 2017, 19:51 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 |
|
|