blob: d3ebc8418de5698271053b3e056fbf17138dabc5 [file] [log] [blame]
swagger: '2.0'
info:
title: Transformatoren
description: Diese Schnittstelle ist Teil der [oK](http://www.openkonsequenz.de) Quellsystem-API.
version: Revision 3 (CIM 17v07)
contact:
name: BTC AG
url: http://www.btc-ag.com
email: openk@btc-ag.com
license:
name: Eclipse Public License 1.0
url: https://www.eclipse.org/legal/epl-v10.html
host: api.openk.de
schemes:
- http
basePath: /source-system/electricity/static-topology
produces:
- application/xml
paths:
/power-transformers:
get:
summary: 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.
description: Gibt alle topologischen Informationen zu einem Transformator zurück. Dies können z. B. Leistungstransformatoren in einem Umspannwerk oder einer Ortsnetzstation sein.
parameters:
- name: revision
in: query
description: Version, die den Nachrichtenaustausch definiert. Dies ist nicht die CIM-Version.
required: true
type: integer
format: int32
minimum: 3
maximum: 3
- name: timestamp
in: query
description: Zeitpunkt, an dem die Nachricht versendet wurde (in UTC gemäß ISO-8601-Format YYYY-MM-DDTHH:mm:ss.SSSZ).
required: false
type: string
format: date-time
pattern: '^([0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|30|31)T(([0-1][0-9])|(2[0-3]))(:[0-5][0-9]){2}\.[0-9]{3}Z)$'
- name: source
in: query
description: Eindeutige Bezeichnung des Senders der Nachricht.
required: false
type: string
- name: user-id
in: query
description: Eindeutige Kennung des angemeldeten Nutzers (Sender).
required: false
type: string
- name: message-id
in: query
description: Eindeutige Kennung dieser Nachricht. Generiert vom Sender der Nachricht.
required: false
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
- name: topology-id
in: query
description: Eindeutige Kennung der Topologie, für die der aktuelle Aufruf erfolgt. Wird der Parameter nicht angegeben, bezieht sich die Abfrage auf die aktuelle Topologie.
required: false
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
responses:
200:
description: Die CIM-Antwortnachricht.
schema:
$ref: '#/definitions/ResponseMessage'
400:
description: Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
410:
description: Die Topologie mit der angegebenen Kennung ist nicht mehr gültig.
500:
description: Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
definitions:
### specific definitions ######################################################
Payload:
description: Der Inhalt der CIM-Antwortnachricht.
type: object
properties:
PowerTransformers:
$ref: '#/definitions/PowerTransformers'
required:
- PowerTransformers
PowerTransformer:
description: Transformator
type: object
properties:
mRID:
description: Die eindeutige Kennung des Transformators.
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
name:
description: Der Name des Transformators.
type: string
minLength: 1
maxLength: 64
description:
description: Die Beschreibung des Transformators.
type: string
minLength: 1
maxLength: 2048
Names:
description: Referenzen auf alternative Namen.
type: array
minItems: 0
items:
$ref: '#/definitions/Name'
xml:
wrapped: true
vectorGroup:
description: Vector group of the transformer for protective relaying, e.g., Dyn1. For unbalanced transformers, this may not be simply determined from the constituent winding connections and phase angle dispacements.
type: string
minLength: 1
maxLength: 7
PowerTransformerEnd:
description: Referenzen auf die Transformatorwindung (Dies ist die Modellierung der Primär- bzw. Sekundärseite)
type: array
maxItems: 3
items:
$ref: '#/definitions/PowerTransformerEnd'
xml:
wrapped: true
Terminals:
description: Terminals
type: array
minItems: 1
maxItems: 3
items:
$ref: '#/definitions/Terminal'
xml:
wrapped: true
required:
- mRID
- PowerTransformerEnd
- Terminals
xml:
name: PowerTransformer
PowerTransformerEnd:
description: Transformatorwindung
type: object
properties:
ratedU:
$ref: '#/definitions/Voltage'
ratedS:
$ref: '#/definitions/ApparentPower'
RatioTapChanger:
$ref: '#/definitions/PowerTransformerEnd.RatioTapChanger'
BaseVoltage:
$ref: '#/definitions/PowerTransformerEnd.BaseVoltage'
Terminal:
$ref: '#/definitions/PowerTransformerEnd.Terminal'
required:
- Terminal
xml:
name: PowerTransformerEnd
PowerTransformerEnd.BaseVoltage:
description: die Nennspannung
properties:
BaseVoltage:
$ref: '#/definitions/BaseVoltage_Reference'
required:
- BaseVoltage
xml:
name: BaseVoltage
PowerTransformerEnd.RatioTapChanger:
description: der Stufenschalter
properties:
RatioTapChanger:
$ref: '#/definitions/RatioTapChanger'
required:
- RatioTapChanger
xml:
name: RatioTapChanger
PowerTransformerEnd.Terminal:
description: das Terminal
properties:
Terminal:
$ref: '#/definitions/Terminal_Reference'
required:
- Terminal
xml:
name: Terminal
PowerTransformers:
description: Auflistung der Transformatoren
type: array
items:
$ref: '#/definitions/PowerTransformer'
xml:
wrapped: true
RatioTapChanger:
description: Stufenschalter
type: object
properties:
lowStep:
description: kleinste Schaltstufe
type: integer
format: int32
minimum: 0
normalStep:
description: Standardschaltstufe (unter normalen Netzbedingungen)
type: integer
format: int32
minimum: 0
highStep:
description: größte Schaltstufe
type: integer
format: int32
minimum: 0
step:
description: Schrittweite (der Schaltstufen)
type: number
format: float
stepVoltageIncrement:
$ref: '#/definitions/PerCent'
required:
- lowStep
- normalStep
- highStep
- step
- stepVoltageIncrement
### common definitions ########################################################
ApparentPower:
description: Scheinleistung - Produkt des quadratischen Mittels der Spannung und des quadratischen Mittels des Stroms.
type: object
properties:
multiplier:
description: Multiplikator der Scheinleistung (CIM UnitMultiplier)
type: string
default: none
enum:
- a
- c
- d
- da
- E
- f
- G
- h
- k
- m
- M
- micro
- n
- none
- p
- P
- T
- y
- Y
- z
- Z
unit:
description: Einheit der Scheinleistung (CIM UnitSymbol)
type: string
default: VA
enum:
- VA
value:
description: Wert der Scheinleistung
type: number
format: float
minimum: 0
required:
- multiplier
- unit
- value
BaseVoltage_Reference:
description: Referenz auf die Nennspannung
type: object
properties:
mRID:
description: eindeutige Kennung der Nennspannung
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
required:
- mRID
xml:
name: BaseVoltage
ConnectivityNode:
description: Verknüpfungspunkt.
type: object
properties:
mRID:
description: eindeutige Kennung des Verknüpfungspunkts
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
name:
description: Name des Verknüpfungspunkts
type: string
minLength: 1
maxLength: 64
required:
- mRID
xml:
name: ConnectivityNode
Header_Reply:
description: Der Kopf der CIM-Nachricht.
type: object
properties:
Verb:
description: Hinweis, um welche Art von Nachricht es sich handelt.
type: string
default: reply
Noun:
description: Hinweis auf den Nachrichteninhalt.
type: string
Revision:
description: Version, die den Nachrichtenaustausch definiert. Dies ist nicht die CIM-Version.
type: integer
format: int32
minimum: 3
maximum: 3
Timestamp:
description: Zeitpunkt, an dem die Nachricht versendet wurde (in UTC gemäß ISO-8601-Format YYYY-MM-DDThh:mm:ss.sssZ).
type: string
format: date-time
pattern: '^([0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|30|31)T(([0-1][0-9])|(2[0-3]))(:[0-5][0-9]){2}\.[0-9]{3}Z)$'
Source:
description: Eindeutige Bezeichnung des Senders der Nachricht.
type: string
MessageID:
description: Eindeutige Kennung dieser Nachricht. Generiert vom Sender der Nachricht.
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
User:
$ref: '#/definitions/UserID'
required:
- Verb
- Noun
- Revision
- Timestamp
- Source
- MessageID
- User
xml:
name: Header
Name:
description: alternativer Name
type: object
properties:
name:
description: ein alternativer Name (z. B. Kennung aus dem Quellsystem)
type: string
minLength: 1
maxLength: 256
NameType:
$ref: '#/definitions/Name.NameType'
required:
- name
- NameType
xml:
name: Name
Name.NameType:
properties:
NameType:
$ref: '#/definitions/NameType'
xml:
name: NameType
NameType:
description: Namenstyp
type: object
properties:
name:
description: Name des Namestyps
type: string
minLength: 1
maxLength: 256
description:
description: Beschreibung des Namestyps
type: string
minLength: 1
maxLength: 2048
NameTypeAuthority:
$ref: '#/definitions/NameType.NameTypeAuthority'
required:
- name
- NameTypeAuthority
xml:
name: NameType
NameType.NameTypeAuthority:
properties:
NameTypeAuthority:
$ref: '#/definitions/NameTypeAuthority'
xml:
name: NameTypeAuthority
NameTypeAuthority:
description: Vergabestelle des Namestyps
type: object
properties:
name:
description: Name der Vergabestelle des Namestyps
type: string
minLength: 1
maxLength: 256
description:
description: Beschreibung des Namestyps
type: string
minLength: 1
maxLength: 2048
required:
- name
xml:
name: NameTypeAuthority
PerCent:
description: Prozentangabe
type: object
properties:
multiplier:
description: Multiplikator der Prozentangabe (CIM UnitMultiplier)
type: string
default: none
enum:
- none
unit:
description: Einheit der Prozentangabe (CIM UnitSymbol)
type: string
default: none
enum:
- none
value:
description: Prozentwert [0-100]
type: number
format: float
required:
- value
Reply_OK:
description: Die Antwort der CIM-Nachricht.
type: object
properties:
Result:
description: Antworttext
type: string
default: OK
required:
- Result
xml:
name: Reply
ResponseMessage:
description: Die CIM-Antwortnachricht.
type: object
properties:
Header:
$ref: '#/definitions/Header_Reply'
Reply:
$ref: '#/definitions/Reply_OK'
Payload:
$ref: '#/definitions/Payload'
required:
- Header
- Reply
- Payload
Terminal:
description: Terminal
type: object
properties:
mRID:
description: eindeutige Kennung des Terminals
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
name:
description: Name des Terminals
type: string
minLength: 1
maxLength: 64
ConnectivityNode:
$ref: '#/definitions/Terminal.ConnectivityNode'
required:
- mRID
- ConnectivityNode
xml:
name: Terminal
Terminal.ConnectivityNode:
description: Verknüpfungspunkt
type: object
properties:
ConnectivityNode:
$ref: '#/definitions/ConnectivityNode'
required:
- ConnectivityNode
xml:
name: ConnectivityNode
Terminal_Reference:
description: Referenz auf das Terminal
type: object
properties:
mRID:
description: eindeutige Kennung des Terminals
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
required:
- mRID
xml:
name: Terminal
UserID:
properties:
id:
description: Eindeutige Kennung des angemeldeten Nutzers (Empfänger).
type: string
xml:
name: UserID
Voltage:
description: Spannung
type: object
properties:
multiplier:
description: Multiplikator der Spannung (CIM UnitMultiplier)
type: string
defalut: none
enum:
- a
- c
- d
- da
- E
- f
- G
- h
- k
- m
- M
- micro
- n
- none
- p
- P
- T
- y
- Y
- z
- Z
unit:
description: Einheit der Spannung (CIM UnitSymbol)
type: string
default: V
enum:
- V
value:
description: Wert der Spannung
type: number
format: float
minimum: 0
required:
- multiplier
- unit
- value