Domänen-API

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche

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:



basePath: /domain/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
  • asset-data v2.2

basePath: /domain/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
  • 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
  • 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
  • asset-data v2.2

basePath: /domain/electricity/dynamic-topology

Information.icon.svg 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


Bezeichnung Typ Beschreibung unterstütze Anwendungsfälle aus "CIM-Cache Ertüchtigung Stufe 1"
Topologie Topologie
http-Methode: GET
Bezeichnung: topology
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Anwendungsfall revision timestamp source user-id message-id topology-id entry-point-id connection-state selector fetch-type
Abfrage der gesamten statischen Topologie 2 ? ? ? ? ? Ignore All
Abfrage statischer Teilnetze (unter Schalternormalstellung) unterhalb eines Transformators 2 ? ? ? ? ? <<eindeutige Kennung des Transformators>> Normal Behind
topologische Ressourcen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: topological-resources
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
topologische Ressourcen
http-Methode: GET
Bezeichnung: power-system-resources
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI


Anwendungsfall revision timestamp source user-id message-id topology-id power-system-resource-types entry-point-id connection-state selector fetch-type
Abfrage der topologischen Elemente (Entitäten) 1 ? ? ? ? ? <<Liste der abzufragenden Ressourcentypen>> <<eindeutige Kennung des Element-Containers>> ?
topologische Ressourcentypen Eigenschaften
http-Methode: GET
Bezeichnung: power-system-resource-types
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Anwendungsfall revision timestamp source user-id message-id topology-id entry-point-id connection-state selector fetch-type
Abfrage aller topologischen Elementtypen 1 ? ? ? ? ?

basePath: /domain/electricity/measurement

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

basePath: /domain/electricity/static-topology

Bezeichnung Beschreibung bereitstellendes System
Nennspannungen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: base-voltages
aktuelle Version: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • 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
  • static-topology v2.2
Inhalt topologischer Container
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: equipment-container-content
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • static-topology v2.2

basePath: /domain/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: 2
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • 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
  • 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
  • topology-state v2.2
aktuelle Schalterstellungen
(neu in CIM Cache Stufe II)
http-Methode: GET
Bezeichnung: switch-states
aktuelle Version: 1
Sprache (ISO 639-1): de
Quelltext: api.openk.de
Spezifikation: Swagger UI
Testen: 169.50.13.150
  • 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
  • topology-state v2.2