Quellsystem-API

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche

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:



basePath: /source-system/common/contact-data

Bezeichnung Beschreibung bereitstellendes System
Unternehmen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: organisations
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-asset-data v2.2

basePath: /source-system/electricity/asset-data

Bezeichnung Beschreibung bereitstellendes System
Anlagen-Eigentumsverhältnisse
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: asset-ownerships
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-asset-data v2.2
Einspeiserstammdaten
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: energy-sources
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-asset-data v2.2
Einspeiserstandorte
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: energy-source-locations
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-asset-data v2.2

basePath: /source-system/electricity/measurement

Bezeichnung Beschreibung bereitstellendes System
aktuelle Messwerte
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: measurement-values
aktuelle Version: 4
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-measurement v2.2
Messpunkte
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: measurement-points
aktuelle Version: 4
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-measurement v2.2

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 ConnectivityNode). 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

Bezeichnung Typ Beschreibung bereitstellendes System
Nennspannungen Kategorisierung
http-Methode: GET
Bezeichnung: base-voltages
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Netzgebiete Gruppierung
http-Methode: GET
Bezeichnung: geographical-regions
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Teilnetzgebiete Gruppierung
http-Methode: GET
Bezeichnung: sub-geographical-regions
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Topologiekennung
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: topology-id
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.2

Erzeugung

CIM-Model Generation.svg

Bezeichnung Typ Beschreibung bereitstellendes System
Einspeiser topologisches Basiselement
http-Methode: GET
Bezeichnung: energy-sources
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Kraftwerke Gruppierung
http-Methode: GET
Bezeichnung: plants
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2

Leitungen und Leitungselemente

CIM-Model Line.svg

Bezeichnung Typ Beschreibung bereitstellendes System
Leitungen Gruppierung
http-Methode: GET
Bezeichnung: lines
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Leitungsabschnitte topologisches Basiselement
http-Methode: GET
Bezeichnung: ac-line-segments
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Leitungsarten Kategorisierung
http-Methode: GET
Bezeichnung: line-types
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Muffen topologisches Basiselement
http-Methode: GET
Bezeichnung: junctions
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2

Umspannwerk

CIM-Model Substation.svg

Bezeichnung Typ Beschreibung bereitstellendes System
Erdschlussdrossel topologisches Basiselement
http-Methode: GET
Bezeichnung: grounding-impedances
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Erdungswiderstände topologisches Basiselement
http-Methode: GET
Bezeichnung: earth-fault-compensators
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Felder Gruppierung
http-Methode: GET
Bezeichnung: bays
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Lastgangschalter topologisches Basiselement
http-Methode: GET
Bezeichnung: load-break-switches
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Leistungsschalter topologisches Basiselement
http-Methode: GET
Bezeichnung: breakers
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Petersenspulen topologisches Basiselement
http-Methode: GET
Bezeichnung: petersen-coils
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Sammelschienen topologisches Basiselement
http-Methode: GET
Bezeichnung: busbar-sections
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Schalter
(neu in CIM Cache Stufe II)
topologisches Basiselement
http-Methode: GET
Bezeichnung: switches
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.2
Spannungsebenen Kategorisierung
http-Methode: GET
Bezeichnung: voltage-levels
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Stationen Gruppierung
http-Methode: GET
Bezeichnung: substations
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Stationsarten Kategorisierung
http-Methode: GET
Bezeichnung: substation-types
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Transformatoren topologisches Basiselement
http-Methode: GET
Bezeichnung: power-transformers
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2
Trennschalter topologisches Basiselement
http-Methode: GET
Bezeichnung: disconnectors
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2

Verbrauch

CIM-Model Load.svg

Bezeichnung Typ Beschreibung bereitstellendes System
Verbraucher topologisches Basiselement
http-Methode: GET
Bezeichnung: energy-consumers
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-static-topology v2.1
  • mock-up-static-topology v2.2

basePath: /source-system/electricity/topology-state

Bezeichnung Beschreibung bereitstellendes System
aktueller Betriebszustand der Einspeiser
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: operating-states
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-topology-state v2.2
aktueller Kommunikationsstatus der Einspeiser
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: communication-states
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-topology-state v2.2
aktuelle Regelstufe der Einspeiser
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: control-stages
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-topology-state v2.2
aktuelle Schalterstellungen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: switch-states
aktuelle Version: 3
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-topology-state v2.2
aktuelle Stellung der Transformatorstufenschalter
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: tap-changer-states
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • mock-up-topology-state v2.2