Domänen-API: Unterschied zwischen den Versionen
FKorb (Diskussion | Beiträge) (→basePath: /domain/common/contact-data) |
FKorb (Diskussion | Beiträge) (→basePath: /domain/electricity/asset-data) |
||
Zeile 30: | Zeile 30: | ||
|- | |- | ||
|Anlagen-Eigentumsverhältnisse<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | |Anlagen-Eigentumsverhältnisse<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
− | |{{REST- | + | |{{REST-GET_2_with_link|link-host = asset-data.openk.de|path = domain/electricity/asset-data|name = asset-ownerships|language = de|protocol = http|host = api.openk.de|file = domain.electricity.asset-data.asset-ownerships_GET_1_de.open-api.yaml|revision = 2}} |
|<ul><li>asset-data v2.2</li></ul> | |<ul><li>asset-data v2.2</li></ul> | ||
|- | |- | ||
|Einspeiserstammdaten<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | |Einspeiserstammdaten<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
− | |{{REST- | + | |{{REST-GET_2_with_link|link-host = asset-data.openk.de|path = domain/electricity/asset-data|name = energy-sources|language = de|protocol = http|host = api.openk.de|file = domain.electricity.asset-data.energy-sources_GET_1_de.open-api.yaml|revision = 1}} |
|<ul><li>asset-data v2.2</li></ul> | |<ul><li>asset-data v2.2</li></ul> | ||
|- | |- | ||
|Einspeiserstandorte<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | |Einspeiserstandorte<br/><font color="MediumSeaGreen">(neu in CIM Cache Stufe II)</font> | ||
− | |{{REST- | + | |{{REST-GET_2_with_link|link-host = asset-data.openk.de|path = domain/electricity/asset-data|name = energy-source-locations|language = de|protocol = http|host = api.openk.de|file = domain.electricity.asset-data.energy-source-locations_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 1. Oktober 2018, 10:44 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 (Neue Funktionen in CIM Cache Stufe II) |
Topologie |
|
| |||||||||||||||||||||||||||||||||||||||||||||
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) |
|
|
basePath: /domain/electricity/topology-state
Bezeichnung | Beschreibung | bereitstellendes System | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aktueller Betriebszustand 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) |
|
|