Domänen-API: Unterschied zwischen den Versionen
EThume (Diskussion | Beiträge) (→basePath: /domain/electricity/dynamic-topology) |
|||
Zeile 18: | Zeile 18: | ||
|- | |- | ||
|Unternehmen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | |Unternehmen<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
− | |{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/common/contact-data|name = organisations|language = de|protocol = | + | |{{REST-GET_2_with_link|link-protocol = https|link-host = 169.50.13.150|path = domain/common/contact-data|name = organisations|language = de|protocol = https|host = demo.openkonsequenz.de/swagger-ui/doc|file = domain.common.contact-data.organisations_GET_1_de.open-api.yaml|revision = 1}} |
|<ul><li>asset-data v2.2</li></ul> | |<ul><li>asset-data v2.2</li></ul> | ||
|} | |} |
Version vom 22. Juni 2020, 08:46 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/common/contact-data
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Unternehmen (neu in CIM Cache Stufe II) |
|
|
basePath: /domain/electricity/asset-data
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anlagen-Eigentumsverhältnisse (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Einspeiserstammdaten (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Einspeiserstandorte (neu in CIM Cache Stufe II) |
|
|
basePath: /domain/electricity/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 Ressourcen (neu in CIM Cache Stufe II) |
|
|||||||||||||||||||||||||||||||||||||||||||||||
topologische Ressourcen |
|
| ||||||||||||||||||||||||||||||||||||||||||||||
topologische Ressourcentypen | Eigenschaften |
|
|
basePath: /domain/electricity/measurement
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aktuelle Messwerte (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Messpunkte (neu in CIM Cache Stufe II) |
|
|
basePath: /domain/electricity/static-topology
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Nennspannungen (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Topologiekennung (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
Inhalt topologischer Container (neu in CIM Cache Stufe II) |
|
|
basePath: /domain/electricity/topology-state
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aktueller Betriebszustand der Einspeiser (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
aktueller Kommunikationsstatus der Einspeiser (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
aktuelle Regelstufe der Einspeiser (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
aktuelle Schalterstellungen (neu in CIM Cache Stufe II) |
|
| ||||||||||||||
aktuelle Stellung der Transformatorstufenschalter (neu in CIM Cache Stufe II) |
|
|