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|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|TopologieDatenManagement (TDM)]], [[MessDatenManagement|MessDatenManagement (MDM)]]) implementiert werden:

__TOC__

==basePath: /domain/common/contact-data==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|Unternehmen (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = organisations|language = de|protocol = http|host = api.openk.de|relative-path = domain/common/contact-data/domain.common.contact-data.organisations_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>asset-data v2.2</li></ul>
|}

==basePath: /domain/electricity/asset-data==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|Anlagen-Eigentumsverhältnisse (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = asset-ownerships|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/asset-data/domain.electricity.asset-data.asset-ownerships_GET_1_de.open-api.yaml|revision = Revision 2 (cim-profile openkonsequenz)}}
|<ul><li>asset-data v2.2</li></ul>
|-
|Einspeiserstammdaten (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = energy-sources|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/asset-data/domain.electricity.asset-data.energy-sources_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>asset-data v2.2</li></ul>
|-
|Einspeiserstandorte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = energy-source-locations|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/asset-data/domain.electricity.asset-data.energy-source-locations_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>asset-data v2.2</li></ul>
|}

==basePath: /domain/electricity/dynamic-topology==
{{Information|text=Bei der Ausprägung der folgenden Schnittstellen wurde bewusst darauf geachtet, diese möglichst allgemeingültig und für eine Vielzahl künftiger Anwendungsfälle zu konzipieren. Damit unterstützen die im Rahmen des Projektes "CIM-Cache Ertüchtigung Stufe 1" entstandenen Schnittstellen eine Obermenge der definierten Anwendungsfälle, Selektions- bzw. Filterkriterien. Die Spalte "Ertüchtigung Stufe 1" der jeweiligen Schnittstellendefinition beschreibt die bereits jetzt durch den CIM-Cache ermöglichten Abfragen.
Hierbei gelten folgende Konventionen:
*"?" frei wählbar gemäß Schnittstellendefinition
*" " Parameter nicht unterstützt
*"<< >>" Beschreibung des zu ersetzenden Wertes
}}

{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Typ
!Beschreibung
!unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1"
|-
|Topologie (Neue Funktionen in CIM Cache Stufe II)
|Topologie
|{{REST-GET_2|name = topology|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/dynamic-topology/domain.electricity.dynamic-topology.topology_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}}
|
{| class="wikitable sortable"
!Anwendungsfall
!revision
!timestamp
!source
!user-id
!message-id
!topology-id
!entry-point-id
!connection-state
!selector
!fetch-type
|-
|[http://dynamic-topology.openk.de/domain/electricity/dynamic-topology/topology?revision=2&connections-state=Ignore&selector=All Abfrage der gesamten statischen Topologie]
|2
|?
|?
|?
|?
|?
|
|Ignore
|All
|
|-
|[http://dynamic-topology.openk.de/domain/electricity/dynamic-topology/topology?revision=2&entry-point-id=abddaf44-13e6-46a3-8f87-0d675ea78659&connection-state=Normal&selector=Behind Abfrage statischer Teilnetze (unter Schalternormalstellung) unterhalb eines Transformators]
|2
|?
|?
|?
|?
|?
|<<eindeutige Kennung des Transformators>>
|Normal
|Behind
|
|}
|-
|topologische Ressourcen
|
|{{REST-GET_2|name = power-system-resources|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/dynamic-topology/domain.electricity.dynamic-topology.power-system-resources_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}

|
{| class="wikitable sortable"
!Anwendungsfall
!revision
!timestamp
!source
!user-id
!message-id
!topology-id
!power-system-resource-types
!entry-point-id
!connection-state
!selector
!fetch-type
|-
|[http://dynamic-topology.openk.de/domain/electricity/dynamic-topology/power-system-resources?revision=1&power-system-resource-types=power-transformer Abfrage der topologischen Elemente (Entitäten)]
|1
|?
|?
|?
|?
|?
|<<Liste der abzufragenden Ressourcentypen>>
|<<eindeutige Kennung des Element-Containers>>
|
|
|?
|}
|-
|topologische Ressourcentypen
|Eigenschaften
|{{REST-GET_2|name = power-system-resource-types|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/dynamic-topology/domain.electricity.dynamic-topology.power-system-resource-types_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|
{| class="wikitable sortable"
!Anwendungsfall
!revision
!timestamp
!source
!user-id
!message-id
!topology-id
!entry-point-id
!connection-state
!selector
!fetch-type
|-
|[http://dynamic-topology.openk.de/domain/electricity/dynamic-topology/power-system-resource-types?revision=1 Abfrage aller topologischen Elementtypen]
|1
|?
|?
|?
|?
|?
|
|
|
|
|}
|}

==basePath: /domain/electricity/measurement==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|aktuelle Messwerte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = measurements|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/measurement/domain.electricity.measurement.measurements_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>measurement v2.2</li></ul>
|-
|Messpunkte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = measurement-points|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/measurement/domain.electricity.measurement.measurement-points_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>measurement v2.2</li></ul>
|}

==basePath: /domain/electricity/static-topology==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|Nennspannungen (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /base-voltages|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/static-topology/domain.electricity.static-topology.base-voltages_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}}
|<ul><li>static-topology v2.2</li></ul>
|-
|Topologiekennung (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /topology-id|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/static-topology/domain.electricity.static-topology.topology-id_GET_1_de.open-api.yaml|revision = Revision 1 (CIM-Profile openKONSEQUENZ)}}
|<ul><li>static-topology v2.2</li></ul>
|}

==basePath: /domain/electricity/topology-state==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|aktueller Betriebszustand der Einspeiser (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /operating-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.operating-states_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>topology-state v2.2</li></ul>
|-
|aktuelle Regelstufe der Einspeiser (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /control-stage|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.control-stages_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>topology-state v2.2</li></ul>
|-
|aktuelle Schalterstellungen (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /switch-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.switch-states_GET_1_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>topology-state v2.2</li></ul>
|-
|aktuelle Stellung der Transformatorstufenschalter (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /tap-changer-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.tap-changer-states_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>topology-state v2.2</li></ul>
|}

Domänen-API

2018-09-19T10:58:47Z

FKorb: /* basePath: /domain/electricity/dynamic-topology */

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|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|TopologieDatenManagement (TDM)]], [[MessDatenManagement|MessDatenManagement (MDM)]]) implementiert werden:

__TOC__

==basePath: /domain/common/contact-data==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|Unternehmen (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = organisations|language = de|protocol = http|host = api.openk.de|relative-path = domain/common/contact-data/domain.common.contact-data.organisations_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>asset-data v2.2</li></ul>
|}

==basePath: /domain/electricity/asset-data==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|Anlagen-Eigentumsverhältnisse (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = asset-ownerships|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/asset-data/domain.electricity.asset-data.asset-ownerships_GET_1_de.open-api.yaml|revision = Revision 2 (cim-profile openkonsequenz)}}
|<ul><li>asset-data v2.2</li></ul>
|-
|Einspeiserstammdaten (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = energy-sources|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/asset-data/domain.electricity.asset-data.energy-sources_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>asset-data v2.2</li></ul>
|-
|Einspeiserstandorte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = energy-source-locations|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/asset-data/domain.electricity.asset-data.energy-source-locations_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>asset-data v2.2</li></ul>
|}

==basePath: /domain/electricity/dynamic-topology==
{{Information|text=Bei der Ausprägung der folgenden Schnittstellen wurde bewusst darauf geachtet, diese möglichst allgemeingültig und für eine Vielzahl künftiger Anwendungsfälle zu konzipieren. Damit unterstützen die im Rahmen des Projektes "CIM-Cache Ertüchtigung Stufe 1" entstandenen Schnittstellen eine Obermenge der definierten Anwendungsfälle, Selektions- bzw. Filterkriterien. Die Spalte "Ertüchtigung Stufe 1" der jeweiligen Schnittstellendefinition beschreibt die bereits jetzt durch den CIM-Cache ermöglichten Abfragen.
Hierbei gelten folgende Konventionen:
*"?" frei wählbar gemäß Schnittstellendefinition
*" " Parameter nicht unterstützt
*"<< >>" Beschreibung des zu ersetzenden Wertes
}}

{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Typ
!Beschreibung
!unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1"
|-
|Topologie (Neue Funktionen in CIM Cache Stufe II)
|Topologie
|{{REST-GET_2|name = topology|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/dynamic-topology/domain.electricity.dynamic-topology.topology_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}}
|
{| class="wikitable sortable"
!Anwendungsfall
!revision
!timestamp
!source
!user-id
!message-id
!topology-id
!entry-point-id
!connection-state
!selector
!fetch-type
|-
|[http://dynamic-topology.openk.de/domain/electricity/dynamic-topology/topology?revision=2&connections-state=Ignore&selector=All Abfrage der gesamten statischen Topologie]
|2
|?
|?
|?
|?
|?
|
|Ignore
|All
|
|-
|[http://dynamic-topology.openk.de/domain/electricity/dynamic-topology/topology?revision=2&entry-point-id=abddaf44-13e6-46a3-8f87-0d675ea78659&connection-state=Normal&selector=Behind Abfrage statischer Teilnetze (unter Schalternormalstellung) unterhalb eines Transformators]
|2
|?
|?
|?
|?
|?
|<<eindeutige Kennung des Transformators>>
|Normal
|Behind
|
|}
|-
|topologische Ressourcen
|
|{{REST-GET_2|name = power-system-resources|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/dynamic-topology/domain.electricity.dynamic-topology.power-system-resources_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}

|
{| class="wikitable sortable"
!Anwendungsfall
!revision
!timestamp
!source
!user-id
!message-id
!topology-id
!power-system-resource-types
!entry-point-id
!connection-state
!selector
!fetch-type
|-
|[http://dynamic-topology.openk.de/domain/electricity/dynamic-topology/power-system-resources?revision=1&power-system-resource-types=power-transformer Abfrage der topologischen Elemente (Entitäten)]
|1
|?
|?
|?
|?
|?
|<<Liste der abzufragenden Ressourcentypen>>
|<<eindeutige Kennung des Element-Containers>>
|
|
|?
|}
|-
|topologische Ressourcentypen
|Eigenschaften
|{{REST-GET_2|name = power-system-resource-types|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/dynamic-topology/domain.electricity.dynamic-topology.power-system-resource-types_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|
{| class="wikitable sortable"
!Anwendungsfall
!revision
!timestamp
!source
!user-id
!message-id
!topology-id
!entry-point-id
!connection-state
!selector
!fetch-type
|-
|[http://dynamic-topology.openk.de/domain/electricity/dynamic-topology/power-system-resource-types?revision=1 Abfrage aller topologischen Elementtypen]
|1
|?
|?
|?
|?
|?
|
|
|
|
|}
|}

==basePath: /domain/electricity/measurement==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|aktuelle Messwerte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = measurements|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/measurement/domain.electricity.measurement.measurements_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>measurement v2.2</li></ul>
|-
|Messpunkte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = measurement-points|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/measurement/domain.electricity.measurement.measurement-points_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>measurement v2.2</li></ul>
|}

==basePath: /domain/electricity/topology-state==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|aktueller Betriebszustand der Einspeiser (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /operating-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.operating-states_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>topology-state v2.2</li></ul>
|-
|aktuelle Regelstufe der Einspeiser (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /control-stage|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.control-stages_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>topology-state v2.2</li></ul>
|-
|aktuelle Schalterstellungen (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /switch-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.switch-states_GET_1_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>topology-state v2.2</li></ul>
|-
|aktuelle Stellung der Transformatorstufenschalter (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = /tap-changer-states|language = de|protocol = http|host = api.openk.de|relative-path = domain/electricity/topology-state/domain.electricity.topology-state.tap-changer-states_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>topology-state v2.2</li></ul>
|}

Quellsystem-API

2018-09-19T10:51:46Z

FKorb: /* Umspannwerk */

Die Quellsystem-API (Source System API) harmonisert den Zugriff auf die Quellsysteme des Netzbetreibers. Sie ist in ihren Abfragemöglichkeiten bewusst einfach gehalten, um die Integration zu vereinfachen und die Komplexität bei der Bereitstellung der Quellssystemdaten zu minimieren. Gleichzeitig sollen die datenliefernden Quellsysteme entlastet werden. Die Bereitstellung komfortabler, fachlicher Abfragen sowie umfassender Selektions- und Filtermöglichkeiten geschieht wiederverwendbar in den nachgelagerten Domänen-Modulen.

Im Folgenden werden die unterschiedlichen Schnittstellen-Methoden der Quellsystem-API vorgestellt:

__TOC__

==basePath: /source-system/common/contact-data==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|Unternehmen (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = organisations|language = de|protocol = http|host = api.openk.de|relative-path = source-system/common/contact-data/source-system.common.contact-data.organisations_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>mock-up-asset-data v2.2</li></ul>
|}

==basePath: /source-system/electricity/asset-data==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|Anlagen-Eigentumsverhältnisse (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = asset-ownerships|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/asset-data/source-system.electricity.asset-data.asset-ownerships_GET_2_de.open-api.yaml|revision = Revision 2 (cim-profile openkonsequenz)}}
|<ul><li>mock-up-asset-data v2.2</li></ul>
|-
|Einspeiserstammdaten (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = energy-sources|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/asset-data/source-system.electricity.asset-data.energy-sources_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>mock-up-asset-data v2.2</li></ul>
|-
|Einspeiserstandorte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = energy-source-locations|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/asset-data/source-system.electricity.asset-data.energy-source-locations_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>mock-up-asset-data v2.2</li></ul>
|}

==basePath: /source-system/electricity/measurement==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|aktuelle Messwerte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = measurements|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/measurement/source-system.electricity.measurement.measurements_GET_4_de.open-api.yaml|revision = Revision 4 (CIM 17v07)}}
|<ul><li>mock-up-measurement v2.2</li></ul>
|-
|Messpunkte (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = measurement-points|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/measurement/source-system.electricity.measurement.measurement-points_GET_4_de.open-api.yaml|revision = Revision 4 (CIM 17v07)}}
|<ul><li>mock-up-measurement v2.2</li></ul>
|}

==basePath: /source-system/electricity/static-topology==
Um ein vollständiges Topologiemodell flexibel aufbauen zu können, stellt die Quellsystem-API prinzipiell drei Arten von Abfragen zur Verfügung:
* topologische Basiselemente: Topologische Basiselemente stellen die elektrisch leitenden Elemente in der Topologie dar. Hierzu zählen u. A. Tranformatoren, Leistungsschalter, Sammelschienen. Die Verbindung zwischen den einzelnen Basiselementen erfolgt über spezielle Knoten (im CIM <code>ConnectivityNode</code>). Jedes Basiselement besitzt hierzu einen Verweis auf mindestens einen Verbindungsknoten. Über den Vergleich der Verbindungsknoten können die Zusammenhänge und Verknüpfungen der Basiselemente hergestellt werden.
* Kategorisierung: Hinter "Kategorisierung" verbirgt sich die Einteilung in bestimmte Arten von Elementen, die modellierungstechnisch gleich sind. Netzbetreiber haben hierüber die Möglichkeit, eigene Einteilung, die unternehmensspezifisch sind, vorzunehmen. Als Beispiel können hier Leitungsarten ("Hauptleitung", "Abzweig", ...) oder Umspannwerkarten ("Umspannwerk", "Ortsnetztrafo", ...) genannt werden.
* Gruppierung: Mit Hilfe von Gruppierungen können topologische Basiselemente zu größeren Einheiten zusammengefasst werden. Dies sind zum Beispiel Umspannwerke, Leitungen, Felder.

Im Folgenden werden die Schnittstellen vorgestellt, die zum Aufbau einer Topologie verwendet werden können:

===allgemeine Topologieelemente===
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Typ
!Beschreibung
!bereitstellendes System
|-
|Nennspannungen
|Kategorisierung
|{{REST-GET_2|name = base-voltages|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.base-voltages_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Netzgebiete
|Gruppierung
|{{REST-GET_2|name = geographical-regions|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.geographical-regions_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Teilnetzgebiete
|Gruppierung
|{{REST-GET_2|name = sub-geographical-regions|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.sub-geographical-regions_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Topologiekennung (neu in CIM Cache Stufe II)
|
|{{REST-GET_2|name = topology-id|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.topology-id_GET_1_de.open-api.yaml|revision = Revision 1 (CIM-Profile openKONSEQUENZ)}}
|<ul><li>mock-up-static-topology v2.2</li></ul>
|}

===Erzeugung===
[[Datei:CIM-Model Generation.svg|490px]]
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Typ
!Beschreibung
!bereitstellendes System
|-
|Einspeiser
|topologisches Basiselement
|{{REST-GET_2|name = energy-sources|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.energy-sources_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Kraftwerke
|Gruppierung
|{{REST-GET_2|name = plants|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.plants_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|}

===Leitungen und Leitungselemente===
[[Datei:CIM-Model Line.svg|568px]]
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Typ
!Beschreibung
!bereitstellendes System
|-
|Leitungen
|Gruppierung
|{{REST-GET_2|name = lines|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.lines_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Leitungsabschnitte
|topologisches Basiselement
|{{REST-GET_2|name = ac-line-segments|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.ac-line-segments_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Leitungsarten
|Kategorisierung
|{{REST-GET_2|name = line-types|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.line-types_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Muffen
|topologisches Basiselement
|{{REST-GET_2|name = junctions|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.junctions_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|}

===Umspannwerk===
[[Datei:CIM-Model Substation.svg|817px]]
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Typ
!Beschreibung
!bereitstellendes System
|-
|Erdschlussdrossel
|topologisches Basiselement
|{{REST-GET_2|name = grounding-impedances|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.grounding-impedances_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Erdungswiderstände
|topologisches Basiselement
|{{REST-GET_2|name = earth-fault-compensators|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.earth-fault-compensators_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Felder
|Gruppierung
|{{REST-GET_2|name = bays|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.bays_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Lastgangschalter
|topologisches Basiselement
|{{REST-GET_2|name = load-break-switches|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.load-break-switches_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Leistungsschalter
|topologisches Basiselement
|{{REST-GET_2|name = breakers|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.breakers_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Petersenspulen
|topologisches Basiselement
|{{REST-GET_2|name = petersen-coils|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.petersen-coils_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Sammelschienen
|topologisches Basiselement
|{{REST-GET_2|name = busbar-sections|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.busbar-sections_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Schalter (neu in CIM Cache Stufe II)
|topologisches Basiselement
|{{REST-GET_2|name = switches|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.switches_GET_2_de.open-api.yaml|revision = Revision 2 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.2</li></ul>
|-
|Spannungsebenen
|Kategorisierung
|{{REST-GET_2|name = voltage-levels|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.voltage-levels_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Stationen
|Gruppierung
|{{REST-GET_2|name = substations|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.substations_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Stationsarten
|Kategorisierung
|{{REST-GET_2|name = substation-types|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.substation-types_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Transformatoren
|topologisches Basiselement
|{{REST-GET_2|name = power-transformers|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.power-transformers_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|-
|Trennschalter
|topologisches Basiselement
|{{REST-GET_2|name = disconnectors|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.disconnectors_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|}

===Verbrauch===
[[Datei:CIM-Model Load.svg|489px]]
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Typ
!Beschreibung
!bereitstellendes System
|-
|Verbraucher
|topologisches Basiselement
|{{REST-GET_2|name = energy-consumers|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/static-topology/source-system.electricity.static-topology.energy-consumers_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-static-topology v2.1</li><li>mock-up-static-topology v2.2</li></ul>
|}

==basePath: /source-system/electricity/topology-state==
{| class="wikitable sortable"
|-class="hintergrundfarbe6"
!Bezeichnung
!Beschreibung
!bereitstellendes System
|-
|aktueller Betriebszustand der Einspeiser (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = operating-states|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/topology-state/source-system.electricity.topology-state.operating-states_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>mock-up-topology-state v2.2</li></ul>
|-
|aktuelle Regelstufe der Einspeiser (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = control-stage|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/topology-state/source-system.electricity.topology-state.control-stages_GET_1_de.open-api.yaml|revision = Revision 1 (cim-profile openkonsequenz)}}
|<ul><li>mock-up-topology-state v2.2</li></ul>
|-
|aktuelle Schalterstellungen (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = switch-states|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/topology-state/source-system.electricity.topology-state.switch-states_GET_3_de.open-api.yaml|revision = Revision 3 (CIM 17v07)}}
|<ul><li>mock-up-topology-state v2.2</li></ul>
|-
|aktuelle Stellung der Transformatorstufenschalter (neu in CIM Cache Stufe II)
|{{REST-GET_2|name = tap-changer-states|language = de|protocol = http|host = api.openk.de|relative-path = source-system/electricity/topology-state/source-system.electricity.topology-state.tap-changer-states_GET_1_de.open-api.yaml|revision = Revision 1 (CIM 17v07)}}
|<ul><li>mock-up-topology-state v2.2</li></ul>
|}