blob: b0ffc6bd97089b4c2ff5f26d56a9547dad4c9ad7 [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*]
|===
|Einspeiser
|Die Schnittstelle gibt alle Einspeiser im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Einspeiser mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/energy-sources
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.energy-sources_GET_3_de.open-api.yaml[source-system.electricity.static-topology.energy-sources_GET_3_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*]
|===
|Erdschlussdrossel
|Die Schnittstelle gibt alle möglichen Erdschlussdrosseln im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Erdschlussdrosseln mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung. Weiterhin werden Informationen zum Widerstand und dem Blindwiderstand der Erdschlussdrosseln zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/grounding-impedances
|aktuelle Version
|Revision 1 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.grounding-impedances_GET_1_de.open-api.yaml[source-system.electricity.static-topology.grounding-impedances_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*]
|===
|Erdungswiderstände
|Die Schnittstelle gibt alle möglichen Erdungswiderstände im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Erdungswiderstände mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung. Weiterhin werden Informationen zum Widerstand der Erdungswiderstände zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/earth-fault-compensators
|aktuelle Version
|Revision 1 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.earth-fault-compensators_GET_1_de.open-api.yaml[source-system.electricity.static-topology.earth-fault-compensators_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*]
|===
|Felder
|Die Schnittstelle gibt alle Felder im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Felder mit deren Beschreibungen, den dazugehörigen Referenzen auf das elektrische leitende Equipment, das zum Feld gehört sowie die jeweiligen eindeutigen Kennungen.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/bays
|aktuelle Version
|Revision 2 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.bays_GET_2_de.open-api.yaml[source-system.electricity.static-topology.bays_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*]
|===
|Kraftwerke
|Die Schnittstelle gibt alle Kraftwerke im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Kraftwerke bzw. Anlagengruppierungen mit deren Beschreibungen, den dazugehörigen Referenzen auf das elektrische leitende Equipment, das zum Kraftwerk bzw. der Anlagengruppierung gehört sowie die jeweiligen eindeutigen Kennungen.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/plants
|aktuelle Version
|Revision 2 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.plants_GET_2_de.open-api.yaml[source-system.electricity.static-topology.plants_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*]
|===
|Lastgangschalter
|Die Schnittstelle gibt alle Lastgangschalter im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Lastgangschalter mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung. Weiterhin werden Informationen zur Normalschaltung des jeweiligen Schalters zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/load-break-switches
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.load-break-switches_GET_3_de.open-api.yaml[source-system.electricity.static-topology.load-break-switches_GET_3_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*]
|===
|Leistungsschalter
|Die Schnittstelle gibt alle Leistungsschalter im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Leistungsschalter mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung. Weiterhin werden Informationen zur Normalschaltung des jeweiligen Schalters zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/breakers
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.breakers_GET_3_de.open-api.yaml[source-system.electricity.static-topology.breakers_GET_3_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*]
|===
|Leitungen
|Die Schnittstelle gibt alle Leitungen im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Leitungen mit den dazugehörigen Beschreibungen, den jeweiligen Leitungstypen und den Referenzen auf das elektrische leitende Equipment, das zur Leitung gehört sowie die jeweiligen eindeutigen Kennungen.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/lines
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.lines_GET_3_de.open-api.yaml[source-system.electricity.static-topology.lines_GET_3_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*]
|===
|Leitungsabschnitte
|Die Schnittstelle gibt alle Leitungsabschnitte im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Leitungsabschnitte mit den dazugehörigen Beschreibungen und Nennspannungen sowie die entsprechenden Terminals. Weiterhin werden Informationen zum Stromfluss, zur Länge des Leitungsabschnitts und dessen Widerstand sowie Blindwiderstand der Leitungsabschnitte zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/ac-line-segments
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.ac-line-segments_GET_3_de.open-api.yaml[source-system.electricity.static-topology.ac-line-segments_GET_3_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*]
|===
|Leitungsarten
|Die Schnittstelle gibt alle Leitungsarten im Netzgebiet zurück. In der zurückgegebenen Auflistung sind sowohl der Name der Leitungsart als auch dessen eindeutige Kennung enthalten.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/line-types
|aktuelle Version
|Revision 2 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.line-types_GET_2_de.open-api.yaml[source-system.electricity.static-topology.line-types_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*]
|===
|Muffen
|Die Schnittstelle gibt alle Muffen im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Muffen mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/junctions
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.junctions_GET_3_de.open-api.yaml[source-system.electricity.static-topology.junctions_GET_3_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*]
|===
|Nennspannungen
|Die Schnittstelle gibt alle möglichen Nennspannungen im Netzgebiet der Topologie zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Nennspannungen, welche jeweils mit einem Wert, einem Multiplikator und der Einheit Volt dargestellt werden.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/base-voltages
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.base-voltages_GET_3_de.open-api.yaml[source-system.electricity.static-topology.base-voltages_GET_3_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*]
|===
|Netzgebiete
|Die Schnittstelle gibt alle Netzgebiete der Topologie zurück. Die Netzgebiete dienen der Aufgliederung des elektrischen Netzes der gesamten Topologie.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/geographical-regions
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.geographical-regions_GET_3_de.open-api.yaml[source-system.electricity.static-topology.geographical-regions_GET_3_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*]
|===
|Petersenspulen
|Die Schnittstelle gibt alle möglichen Petersenspulen im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Petersenspulen mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung. Weiterhin werden Informationen zum Stromfluss und zum Spektrum des Blindwiderstands der Petersenspulen zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/petersen-coils
|aktuelle Version
|Revision 1 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.petersen-coils_GET_1_de.open-api.yaml[source-system.electricity.static-topology.petersen-coils_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*]
|===
|Sammelschienen
|Die Schnittstelle gibt alle Sammelschienen im Netzgebiet zurück. Unter einer Sammelschiene versteht man eine Anordnung von Leitern, die als zentraler Verteiler von elektrischer Energie dienen, da an die Sammelschienen alle ankommenden und abgehenden Leitungen angeschlossen sind. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Sammelschienen mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/busbar-sections
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.busbar-sections_GET_3_de.open-api.yaml[source-system.electricity.static-topology.busbar-sections_GET_3_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*]
|===
|Schalter
|Die Schnittstelle gibt alle Schalter im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Schalter mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung. Weiterhin werden Informationen zur Normalschaltung des jeweiligen Schalters zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/switches
|aktuelle Version
|Revision 2 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.switches_GET_2_de.open-api.yaml[source-system.electricity.static-topology.switches_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*]
|===
|Spannungsebenen
|Die Schnittstelle gibt alle Spannungsebenen in den Stationen des Netzgebiets zurück. Stromnetze werden in Spannungsebenen eingeteilt, bei der sie elektrische Energie übertragen. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Spannungsebenen mit deren Beschreibungen, den dazugehörigen Referenzen auf das elektrische leitende Equipment, das zur Spannungsebene gehört sowie die jeweiligen eindeutigen Kennungen. Weiterhin werden die dazugehörigen Felder sowie die Referenzen auf die eindeutige Kennung der Stationen zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/voltage-levels
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.voltage-levels_GET_3_de.open-api.yaml[source-system.electricity.static-topology.voltage-levels_GET_3_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*]
|===
|Stationen
|Die Schnittstelle gibt alle Stationen im Netzgebiet zurück. Stationen sind Teil des elektrischen Versorgungsnetzes und dienen der Verbindung unterschiedlicher Spannungsebenen. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Stationen mit den dazugehörigen Beschreibungen, den jeweiligen Stationstypen und den Referenzen auf das elektrische leitende Equipment, die Felder und die Spannungsebenen, die zur Station gehören sowie die jeweiligen eindeutigen Kennungen.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/substations
|aktuelle Version
|Revision 3 (CIM 07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.substations_GET_3_de.open-api.yaml[source-system.electricity.static-topology.substations_GET_3_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*]
|===
|Stationsarten
|Die Schnittstelle gibt alle Stationsarten im Netzgebiet zurück. In der zurückgegebenen Auflistung sind sowohl der Name der Stationsart als auch dessen eindeutige Kennung enthalten. Arten von Stationen sind bspw. Umspannwerke oder Ortsnetzstationen.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/substation-types
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.substation-types_GET_3_de.open-api.yaml[source-system.electricity.static-topology.substation-types_GET_3_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*]
|===
|Teilnetzgebiete
|Die Schnittstelle gibt alle Teilnetzgebiete der Topologie zurück. Die Teilnetzgebiete dienen der Aufgliederung des elektrischen Netzes der jeweiligen übergeordneten Netzgebiete.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/sub-geographical-regions
|aktuelle Version
|Revision 2 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.sub-geographical-regions_GET_2_de.open-api.yaml[source-system.electricity.static-topology.sub-geographical-regions_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*]
|===
|Topologiekennung
|Die Schnittstelle gibt die Kennung der aktuellen Topologie zurück. Ändert sich die Topologie, ändert sich gleichermaßen die Kennung der Topologie. Mithilfe der Kennung der Topologie kann die, im CIM Cache enthaltene, Topologie auf ihre Aktualität überprüft werden.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/topology-id
|aktuelle Version
|Revision 1 (CIM-Profile openKONSEQUENZ)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.topology-id_GET_1_de.open-api.yaml[source-system.electricity.static-topology.topology-id_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.
|500
|Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
|===
'''
<<<
[%header,cols=1*]
|===
|Transformatoren
|Die Schnittstelle gibt alle topologischen Informationen zu Transformatoren aller Spannungsebenen zurück. Dies können z.B. Leistungstransformatoren in einem Umspannwerk oder einer Ortsnetzstation sein.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/power-transformers
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.power-transformers_GET_3_de.open-api.yaml[source-system.electricity.static-topology.power-transformers_GET_3_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*]
|===
|Trennschalter
|Die Schnittstelle gibt alle Trennschalter im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Trennschalter mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung. Weiterhin werden Informationen zur Normalschaltung des jeweiligen Schalters zurückgegeben.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/disconnectors
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.disconnectors_GET_3_de.open-api.yaml[source-system.electricity.static-topology.disconnectors_GET_3_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*]
|===
|Verbraucher
|Die Schnitstelle gibt alle Verbraucher im Netzgebiet zurück. Das Ergebnis dieses Schnittstellenaufrufs ist eine Auflistung der Verbraucher mit ihren dazugehörigen eindeutigen Kennungen, Beschreibungen und Terminals sowie der Referenz auf die eindeutige Kennnung der Nennspannung.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/energy-consumers
|aktuelle Version
|Revision 3 (CIM 17v07)
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/source-system.electricity.static-topology.energy-consumers_GET_3_de.open-api.yaml[source-system.electricity.static-topology.energy-consumers_GET_3_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.
|===
'''
<<<