blob: 2b19bb7f1715e0ab586316ed5783133f145e8ad4 [file] [log] [blame]
[id='interface-concept-{context}']
= Schnittstellenbeschreibung
Die Kommunikation mit dem {ProjectName} erfolgt über REST-Schnittstellen, welche
im http://wiki.openkonsequenz.de/Dom%C3%A4nen-API[OpenKonsequenz-Wiki] veröffentlicht sind.
Von diesem Service angebotene Schnittstellen.
[%header,cols=1*]
|===
|Topologie
|Die Schnittstelle gibt (Teil-)Topologien zurück. Es kann die definierte Topologie abgefragt werden. Dabei kann der Ausschnitt der abgefragten Topologie durch Selektionsparameter eingeschränkt werden. Die Selektion erfolgt über die Wahl eines Ausgangspunkts, der Angabe des Verknüpfungsstatus und einer Selektionsbereichsbegrenzung. Mithilfe des Parameters 'entry-point-id' können alle topologischen Elemente (z. B. Schalter, Transformatoren) oder Element-Container (z. B. Umspannwerke, Teilnetzgebiete) als Ausgangspunkt verwendet werden. Diese werden über die Angabe ihrer eindeutige Kennungen gewählt. Der Parameter 'connection-state' gibt an, wie die Ressourcen, die Teil der Selektion sein sollen, mit dem Ausgangspunkt verknüpft sein sollen (z. B. unter Schalternormalstellung, unter aktueller Schalterstellung). Der Parameter 'selector' gibt an, welche Ressourcen vom Ausgangspunkt aus bei der Selektion mit berücksichtigt werden sollen (z. B. alle Ressourcen innerhalb des gewählten Umspannwerks). Die Grenzen sind in der Regel Netzbereiche mit anderen Nennspannungen. Die Abrufmethode über den Parameter 'fetch-type' definiert, welche Ebenen bei der Abfrage eines Element-Containers berücksichtigt werden. Die Selektion ist optional. Wird sie weggelassen, wird die gesamte Topologie berücksichtigt.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/topology
|aktuelle Version
|Revision 2 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/domain.electricity.dynamic-topology.topology_GET_2_de.open-api.yaml[domain.electricity.dynamic-topology.topology_GET_2_de.open-api.yaml]
|===
[%header,cols=2*]
|===
|Status-Code
|Beschreibung
|200
|Die CIM-Antwortnachricht.
|400
|Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
|410
|Die Topologie mit der angegebenen Kennung ist nicht mehr gültig.
|500
|Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
|===
'''
<<<
[%header,cols=1*]
|===
|topologische Ressourcen
|Die Schnittstelle gibt die Ressourcen eines bestimmten Typs aus der Topologie zurück. Es können die Ressourceninstanzen eines bestimmten Typs aus der Topologie abgefragt werden. Dabei kann die Auswahl der Ressourcen durch Selektions- und Filterparameter eingeschränkt werden. Der Parameter 'power-system-resources' schränkt die Abfrage auf die Typen der zu suchenden Ressourcen ein. Diese können über die Schnittstelle <b>domain/electricity/dynamic-topology/power-system-resource-types</b> abgefragt werden. Die Selektion erfolgt über die Wahl eines Ausgangspunkts, der Angabe des Verknüpfungsstatus und einer Selektionsbereichsbegrenzung. Mithilfe des Parameters 'entry-point-id' können alle topologischen Elemente (z. B. Schalter, Transformatoren) oder Element-Container (z. B. Umspannwerke, Teilnetzgebiete) als Ausgangspunkt verwendet werden. Diese werden über die Angabe ihrer eindeutigen Kennungen gewählt. Der Parameter 'connection-state' gibt an, wie die Ressourcen, die Teil der Selektion sein sollen, mit dem Ausgangspunkt verknüpft sein sollen (z. B. unter Schalternormalstellung, unter aktueller Schalterstellung). Der Parameter 'selector' gibt an, welche Ressourcen vom Ausgangspunkt aus bei der Selektion mit berücksichtigt werden sollen (z. B. alle Ressourcen innerhalb des gewählten Umspannwerks). Die Grenzen sind in der Regel Netzbereiche mit anderen Nennspannungen. Die Abrufmethode über den Parameter 'fetch-type' definiert, welche Ebenen bei der Abfrage eines Element-Containers berücksichtigt werden. Die Selektion ist optional. Wird sie weggelassen, wird die gesamte Topologie berücksichtigt.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/power-system-resources
|aktuelle Version
|Revision 1 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/domain.electricity.dynamic-topology.power-system-resources_GET_1_de.open-api.yaml[domain.electricity.dynamic-topology.power-system-resources_GET_1_de.open-api.yaml]
|===
[%header,cols=2*]
|===
|Status-Code
|Beschreibung
|200
|Die CIM-Antwortnachricht.
|400
|Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
|410
|Die Topologie mit der angegebenen Kennung ist nicht mehr gültig.
|500
|Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
|===
'''
<<<
[%header,cols=1*]
|===
|topologische Ressourcentypen
|Die Schnittstelle gibt die in der Topologie definierten Ressourcentypen zurück. Es können die Typen der Ressourcen, die in der Topologie definiert sind, abgefragt werden. Dabei kann die Auswahl der Ressourcentypen durch Selektionsparameter eingeschränkt werden. Die Selektion erfolgt über die Wahl eines Ausgangspunkts, der Angabe des Verknüpfungsstatus und einer Selektionsbereichsbegrenzung. Mithilfe des Parameters 'entry-point-id' können alle topologischen Elemente (z. B. Schalter, Transformatoren) oder Element-Container (z. B. Umspannwerke, Teilnetzgebiete) als Ausgangspunkt verwendet werden. Diese werden über die Angabe ihrer eindeutigen Kennungen gewählt. Der Parameter 'connection-state' gibt an, wie die Ressourcen, die Teil der Selektion sein sollen, mit dem Ausgangspunkt verknüpft sein sollen (z. B. unter Schalternormalstellung, unter aktueller Schalterstellung). Der Parameter 'selector' gibt an, welche Ressourcen vom Ausgangspunkt aus bei der Selektion mit berücksichtigt werden sollen (z. B. alle Ressourcen innerhalb des gewählten Umspannwerks). Die Grenzen sind in der Regel Netzbereiche mit anderen Nennspannungen. Die Abrufmethode über den Parameter 'fetch-type' definiert, welche Ebenen bei der Abfrage eines Element-Containers berücksichtigt werden. Die Selektion ist optional. Wird sie weggelassen, wird die gesamte Topologie berücksichtigt.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/power-system-resource-types
|aktuelle Version
|Revision 1 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/domain.electricity.dynamic-topology.power-system-resource-types_GET_1_de.open-api.yaml[domain.electricity.dynamic-topology.power-system-resource-types_GET_1_de.open-api.yaml]
|===
[%header,cols=2*]
|===
|Status-Code
|Beschreibung
|200
|Die Antwortnachricht.
|400
|Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
|410
|Die Topologie mit der angegebenen Kennung ist nicht mehr gültig.
|500
|Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
|===
'''
<<<
[%header,cols=1*]
|===
|verbundene topologische Verbindungselemente
|Die Schnittstelle gibt, die mit einem Wandler verbundenen topologische Verbindungselemente zurück. Es können die topologischen Verbindungselemente aus der Topologie, die mit einem Wandler verbunden sind, abgefragt werden. Als Wandler wir in diesem Context eine topologische Ressource bezeichnet, die bestimmte Größen innerhalb der Topologie transformieren kann. In elektrischen Netzen sind dies beispielsweise Transformatoren, in Gasnetzen sind dies Druckminderungs- oder Druckerhöhungsanlagen. Die Auswahl der zurückgegebenen topologischen Verbindungselemente kann durch Filterparameter eingeschränkt werden. Mithilfe des Parameters 'converter-id' kann die Abfrage auf die eindeutige Kennung eines Wandlers eingeschränkt werden. Unbekannte Kennungen werden ignoriert. Der Parameter 'topological-resource-types' schränkt die benutzerspezifischen Typen von topologischen Ressourcen ein, die zurückgegeben werden sollen. Verschiedene Kennungen können mit Hilfe des Zeichens '|' getrennt werden. Wird ein benutzerspezifischer Typ angegeben, werden alle topologischen Ressourcen dieses Typs zurückgegeben. Wird keine Kennung angegeben, werden alle topologischen Ressourcen zurückgegeben. Unbekannte Kennungen werden ignoriert. Der Parameter 'connection-state' gibt an, wie die Ressourcen, die Teil der Selektion sein sollen, mit dem Ausgangspunkt verknüpft sein sollen (z. B. unter Schalternormalstellung, unter aktueller Schalterstellung). Der Parameter 'selector' gibt an, welche Ressourcen vom Ausgangspunkt aus bei der Selektion mit berücksichtigt werden sollen (z. B. alle Ressourcen innerhalb des gewählten Umspannwerks). Die Grenzen sind in der Regel Netzbereiche mit anderen Nennspannungen.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/connected-connecting-equipments
|aktuelle Version
|Revision 1 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/domain.electricity.dynamic-topology.connected-connecting-equipments_GET_1_de.open-api.yaml[domain.electricity.dynamic-topology.connected-connecting-equipments_GET_1_de.open-api.yaml]
|===
[%header,cols=2*]
|===
|Status-Code
|Beschreibung
|200
|Die CIM-Antwortnachricht.
|400
|Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
|410
|Die Topologie mit der angegebenen Kennung ist nicht mehr gültig.
|500
|Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
|===
'''
<<<