Domänen-API: Unterschied zwischen den Versionen
FKorb (Diskussion | Beiträge) (→basePath: /domain/dynamic-topology) |
FKorb (Diskussion | Beiträge) (→basePath: /domain/dynamic-topology) |
||
Zeile 25: | Zeile 25: | ||
!unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1" | !unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1" | ||
|- | |- | ||
− | | | + | |Topologie |
|Topologie | |Topologie | ||
|{{REST-GET|cim-version = 17v07|name = topology|language = de|protocol = http|host = api.openk.de|base-path = domain/dynamic-topology|revision = 2}} | |{{REST-GET|cim-version = 17v07|name = topology|language = de|protocol = http|host = api.openk.de|base-path = domain/dynamic-topology|revision = 2}} | ||
Zeile 70: | Zeile 70: | ||
|} | |} | ||
|- | |- | ||
− | | | + | |topologische Elemente |
|Eigenschaften | |Eigenschaften | ||
|{{REST-GET|cim-version = 17v07|name = elements|language = de|protocol = http|host = api.openk.de|base-path = domain/dynamic-topology|revision = 1}} | |{{REST-GET|cim-version = 17v07|name = elements|language = de|protocol = http|host = api.openk.de|base-path = domain/dynamic-topology|revision = 1}} | ||
Zeile 102: | Zeile 102: | ||
|} | |} | ||
|- | |- | ||
− | | | + | |topologische Elementtypen |
|Eigenschaften | |Eigenschaften | ||
|{{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}} |
Version vom 24. Oktober 2017, 19:53 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 | unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1" | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Topologie | Topologie |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||
topologische Elemente | Eigenschaften |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||
topologische Elementtypen | Eigenschaften |
|
|