Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRenko Ortgies2019-03-25 11:17:14 -0400
committerRenko Ortgies2019-03-25 11:17:14 -0400
commit36e24574f30ca41027146799d23917f326686db4 (patch)
treea6961641046207d28fa81c093783a3199f0f73f7
parentc7841de80000ed7f352c3abaedba680757700adb (diff)
downloadorg.eclipse.openk.sourcesystem.mockupmeasurement-36e24574f30ca41027146799d23917f326686db4.tar.gz
org.eclipse.openk.sourcesystem.mockupmeasurement-36e24574f30ca41027146799d23917f326686db4.tar.xz
org.eclipse.openk.sourcesystem.mockupmeasurement-36e24574f30ca41027146799d23917f326686db4.zip
CIM Cache Stufe 2 - MS 5
Task references: CICA-817 Reason: CIM Cache v2.21 - finished for EISMAN MS 2 Rationale: none Side effects: None
-rw-r--r--data/Measurments.xml10
-rw-r--r--dev/adapter/pom.xml6
-rw-r--r--dev/core/pom.xml4
-rw-r--r--dev/infrastructure/pom.xml6
-rw-r--r--dev/logic/pom.xml8
-rw-r--r--dev/model/pom.xml6
-rw-r--r--dev/pom.xml2
-rw-r--r--dev/service/pom.xml8
-rw-r--r--dev/service/src/main/resources/application.properties56
-rw-r--r--dev/service/src/main/resources/logger-configuration.xml86
-rw-r--r--doc/pom.xml4
-rw-r--r--doc/src/main/doc/docs/documentation/modules/interface-concept-de.adoc208
-rw-r--r--doc/src/main/doc/docs/documentation/modules/user-concept-de.adoc3
-rw-r--r--doc/src/main/doc/docs/test/modules/test-cases-report.csv8
-rw-r--r--doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-points_GET_4_de.open-api.yaml478
-rw-r--r--doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-values_GET_4_de.open-api.yaml636
-rw-r--r--doc/src/test/doc/test/test.adoc40
17 files changed, 791 insertions, 778 deletions
diff --git a/data/Measurments.xml b/data/Measurments.xml
index 360ff1b..163d8a2 100644
--- a/data/Measurments.xml
+++ b/data/Measurments.xml
@@ -1,4 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright © 2015-2019 PSI AG - http://www.psi.de
+
+ This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+
+ http://www.eclipse.org/legal/epl-v10.html
+-->
+
<ResponseMessage>
<Header>
<Verb>reply</Verb>
diff --git a/dev/adapter/pom.xml b/dev/adapter/pom.xml
index 5965a8b..4c5f1f2 100644
--- a/dev/adapter/pom.xml
+++ b/dev/adapter/pom.xml
@@ -6,7 +6,7 @@
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-adapter</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
<packaging>jar</packaging>
<name>${project.groupId}.${project.artifactId}</name>
@@ -23,13 +23,13 @@
<dependency>
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-logic</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
<dependency>
<groupId>org.eclipse.openk.service</groupId>
<artifactId>service-adapter</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
</dependencies>
diff --git a/dev/core/pom.xml b/dev/core/pom.xml
index b3e3c0f..920dcae 100644
--- a/dev/core/pom.xml
+++ b/dev/core/pom.xml
@@ -6,7 +6,7 @@
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-core</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
<name>${project.groupId}.${project.artifactId}</name>
<parent>
@@ -21,7 +21,7 @@
<dependency>
<groupId>org.eclipse.openk.service</groupId>
<artifactId>service-core</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
</dependencies>
</project> \ No newline at end of file
diff --git a/dev/infrastructure/pom.xml b/dev/infrastructure/pom.xml
index 88c72df..3c0b8f8 100644
--- a/dev/infrastructure/pom.xml
+++ b/dev/infrastructure/pom.xml
@@ -6,7 +6,7 @@
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-infrastructure</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
<packaging>jar</packaging>
<name>${project.groupId}.${project.artifactId}</name>
@@ -27,13 +27,13 @@
<dependency>
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-adapter</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
<dependency>
<groupId>org.eclipse.openk.service</groupId>
<artifactId>service-infrastructure</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
</dependencies>
diff --git a/dev/logic/pom.xml b/dev/logic/pom.xml
index 73ee21f..a75a2c4 100644
--- a/dev/logic/pom.xml
+++ b/dev/logic/pom.xml
@@ -6,7 +6,7 @@
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-logic</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
<name>${project.groupId}.${project.artifactId}</name>
<parent>
@@ -21,13 +21,13 @@
<dependency>
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-model</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
<dependency>
<groupId>org.eclipse.openk.domain.measurement</groupId>
<artifactId>measurement-logic</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
<!-- scope: test -->
@@ -35,7 +35,7 @@
<dependency>
<groupId>org.eclipse.openk.service</groupId>
<artifactId>service-logic</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
<type>test-jar</type>
</dependency>
</dependencies>
diff --git a/dev/model/pom.xml b/dev/model/pom.xml
index fa208ba..c70e7ed 100644
--- a/dev/model/pom.xml
+++ b/dev/model/pom.xml
@@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-model</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
<name>${project.groupId}.${project.artifactId}</name>
<parent>
@@ -20,7 +20,7 @@
<dependency>
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-core</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
<dependency>
@@ -33,7 +33,7 @@
<dependency>
<groupId>org.eclipse.openk.service</groupId>
<artifactId>service-model</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
</dependencies>
diff --git a/dev/pom.xml b/dev/pom.xml
index 05daf46..cc7bb56 100644
--- a/dev/pom.xml
+++ b/dev/pom.xml
@@ -6,7 +6,7 @@
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
<packaging>pom</packaging>
<name>mock-up-measurement project aggregator</name>
<description>Aggregator POM for the mock-up-measurement modules</description>
diff --git a/dev/service/pom.xml b/dev/service/pom.xml
index b5301d9..0bf8b88 100644
--- a/dev/service/pom.xml
+++ b/dev/service/pom.xml
@@ -6,7 +6,7 @@
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-service</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
<name>${project.groupId}.${project.artifactId}</name>
<parent>
@@ -21,18 +21,18 @@
<dependency>
<groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
<artifactId>mock-up-measurement-infrastructure</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
<dependency>
<groupId>org.eclipse.openk.domain.measurement</groupId>
<artifactId>measurement-adapter</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
<dependency>
<groupId>org.eclipse.openk.service</groupId>
<artifactId>service-service</artifactId>
- <version>2.20.0</version>
+ <version>2.21.1</version>
</dependency>
</dependencies>
diff --git a/dev/service/src/main/resources/application.properties b/dev/service/src/main/resources/application.properties
index 12c2734..4fc0e5b 100644
--- a/dev/service/src/main/resources/application.properties
+++ b/dev/service/src/main/resources/application.properties
@@ -1,28 +1,28 @@
-## Spring configuration file (will be packed in executable JAR, may be overriden by command line switch
-## --spring.config.location=application.properties
-
-# server properties
-server.port=9706
-
-# logger properties (org.slf4j.Logger)
-
-## path of the logger-configuration.xml file
-logging.config=./src/main/resources/logger-configuration.xml
-
-## name of the log-file
-logging.file=mock-up-measurement-service
-
-## path for the log-file
-logging.path=${java.io.tmpdir}/logs
-
-## custom log-levels
-## logging.level.root is defined in logging.config-file, but can be overridden here
-logging.level.root=INFO
-
-## custom log-levels (base path is root, other paths override root settings)
-logging.level.com.btc=DEBUG
-logging.level.org.eclipse.openk=DEBUG
-logging.level.org.hibernate=WARN
-logging.level.org.springframework=WARN
-logging.level.org.apache=WARN
-logging.level.org.eclipse.persistence=WARN
+## Spring configuration file (will be packed in executable JAR, may be overriden by command line switch
+## --spring.config.location=application.properties
+
+# server properties
+server.port=9706
+
+# logger properties (org.slf4j.Logger)
+
+## path of the logger-configuration.xml file
+logging.config=./src/main/resources/logger-configuration.xml
+
+## name of the log-file
+logging.file=mock-up-measurement-service
+
+## path for the log-file
+logging.path=${java.io.tmpdir}/logs
+
+## custom log-levels
+## logging.level.root is defined in logging.config-file, but can be overridden here
+logging.level.root=INFO
+
+## custom log-levels (base path is root, other paths override root settings)
+logging.level.com.btc=DEBUG
+logging.level.org.eclipse.openk=DEBUG
+logging.level.org.hibernate=WARN
+logging.level.org.springframework=WARN
+logging.level.org.apache=WARN
+logging.level.org.eclipse.persistence=WARN
diff --git a/dev/service/src/main/resources/logger-configuration.xml b/dev/service/src/main/resources/logger-configuration.xml
index e5083fd..51ca598 100644
--- a/dev/service/src/main/resources/logger-configuration.xml
+++ b/dev/service/src/main/resources/logger-configuration.xml
@@ -11,48 +11,48 @@
-->
<configuration>
- <!-- Properties -->
- <property name="LOG_FILE_NAME" value="${LOG_FILE}" /><!-- from application.properties: logging.file -->
- <property name="LOG_FILE_EXTENSION" value="log" />
- <property name="LOG_FILE_PATH" value="${LOG_PATH}" /> <!-- from application.properties: logging.path -->
- <property name="LOG_PATTERN" value="%d{HH:mm:ss.SSS} [%-5level] %logger{10} - %msg%n" /> <!-- logger{10} defines the length of logged package name -->
-
- <!-- ConsoleAppender -->
- <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
- <encoder>
- <pattern>
- ${LOG_PATTERN}
- </pattern>
- </encoder>
- </appender>
-
- <!-- RollingFileAppender -->
- <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
- <file>${LOG_FILE_PATH}/${LOG_FILE_NAME}.${LOG_FILE_EXTENSION}</file>
- <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
-
- <!-- rollover daily -->
- <fileNamePattern>${LOG_FILE_PATH}/${LOG_FILE_NAME}-%d{yyyy-MM-dd}.%i.${LOG_FILE_EXTENSION}</fileNamePattern>
-
- <!-- The maxFileSize option can be specified in bytes, kilobytes, megabytes or gigabytes by suffixing a numeric value with KB, MB and respectively GB. For example, 5000000, 5000KB, 5MB and 2GB are all valid values, with the first three being equivalent. -->
- <maxFileSize>1MB</maxFileSize>
-
- <!-- The optional maxHistory property controls the maximum number of archive files to keep, asynchronously deleting older files. For example, if you specify monthly rollover, and set maxHistory to 6, then 6 months worth of archives files will be kept with files older than 6 months deleted. Note as old archived log files are removed, any folders which were created for the purpose of log file archiving will be removed as appropriate. -->
- <maxHistory>60</maxHistory>
-
- <!-- max size for all files: The optional totalSizeCap property controls the total size of all archive files. Oldest archives are deleted asynchronously when the total size cap is exceeded. The totalSizeCap property requires maxHistory property to be set as well. Moreover, the "max history" restriction is always applied first and the "total size cap" restriction applied second. -->
- <totalSizeCap>5MB</totalSizeCap>
-
- </rollingPolicy>
- <encoder>
- <pattern>${LOG_PATTERN}</pattern>
- </encoder>
- </appender>
-
- <!-- log-level -->
- <root level="ERROR">
- <appender-ref ref="CONSOLE" />
- <appender-ref ref="ROLLING_FILE" />
- </root>
+ <!-- Properties -->
+ <property name="LOG_FILE_NAME" value="${LOG_FILE}" /><!-- from application.properties: logging.file -->
+ <property name="LOG_FILE_EXTENSION" value="log" />
+ <property name="LOG_FILE_PATH" value="${LOG_PATH}" /> <!-- from application.properties: logging.path -->
+ <property name="LOG_PATTERN" value="%d{dd.MM.yyyy HH:mm:ss.SSS} [%-5level] [%thread] %logger{15} - %msg%n" /> <!-- logger{15} defines the length of logged package name -->
+
+ <!-- ConsoleAppender -->
+ <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+ <encoder>
+ <pattern>
+ ${LOG_PATTERN}
+ </pattern>
+ </encoder>
+ </appender>
+
+ <!-- RollingFileAppender -->
+ <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
+ <file>${LOG_FILE_PATH}/${LOG_FILE_NAME}.${LOG_FILE_EXTENSION}</file>
+ <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
+
+ <!-- rollover daily -->
+ <fileNamePattern>${LOG_FILE_PATH}/${LOG_FILE_NAME}-%d{yyyy-MM-dd}.%i.${LOG_FILE_EXTENSION}</fileNamePattern>
+
+ <!-- The maxFileSize option can be specified in bytes, kilobytes, megabytes or gigabytes by suffixing a numeric value with KB, MB and respectively GB. For example, 5000000, 5000KB, 5MB and 2GB are all valid values, with the first three being equivalent. -->
+ <maxFileSize>1MB</maxFileSize>
+
+ <!-- The optional maxHistory property controls the maximum number of archive files to keep, asynchronously deleting older files. For example, if you specify monthly rollover, and set maxHistory to 6, then 6 months worth of archives files will be kept with files older than 6 months deleted. Note as old archived log files are removed, any folders which were created for the purpose of log file archiving will be removed as appropriate. -->
+ <maxHistory>60</maxHistory>
+
+ <!-- max size for all files: The optional totalSizeCap property controls the total size of all archive files. Oldest archives are deleted asynchronously when the total size cap is exceeded. The totalSizeCap property requires maxHistory property to be set as well. Moreover, the "max history" restriction is always applied first and the "total size cap" restriction applied second. -->
+ <totalSizeCap>5MB</totalSizeCap>
+
+ </rollingPolicy>
+ <encoder>
+ <pattern>${LOG_PATTERN}</pattern>
+ </encoder>
+ </appender>
+
+ <!-- log-level -->
+ <root level="ERROR">
+ <appender-ref ref="CONSOLE" />
+ <appender-ref ref="ROLLING_FILE" />
+ </root>
</configuration>
diff --git a/doc/pom.xml b/doc/pom.xml
index 90c637a..2faa983 100644
--- a/doc/pom.xml
+++ b/doc/pom.xml
@@ -4,8 +4,8 @@
<modelVersion>4.0.0</modelVersion>
- <groupId>org.eclipse.openk.source-system.mock-up-measurement</groupId>
- <artifactId>mock-up-measurement-documentation</artifactId>
+ <groupId>org.eclipse.openk.source-system.measurement</groupId>
+ <artifactId>measurement-documentation</artifactId>
<version>2.20.0</version>
<packaging>pom</packaging>
diff --git a/doc/src/main/doc/docs/documentation/modules/interface-concept-de.adoc b/doc/src/main/doc/docs/documentation/modules/interface-concept-de.adoc
index 94355b3..c3e2c66 100644
--- a/doc/src/main/doc/docs/documentation/modules/interface-concept-de.adoc
+++ b/doc/src/main/doc/docs/documentation/modules/interface-concept-de.adoc
@@ -1,104 +1,104 @@
-[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*]
-|===
-|aktuelle Messwerte
-
-|Die Schnittstelle gibt die aktuellen Messwerte zurück, die den angegebenen Suchkriterien entsprechen. Es werden die Messwerte mit den angegebenen Messpunktschlüsseln (measurement-point-ids) berücksichtigt. Verschiedene Schlüssel können mit Hilfe des Zeichens '\|
-' getrennt werden. Weitere Suchkriterien sind der Startzeitpunkt in UTC (start-time) und der Endzeitpunkt in UTC (end-time) des betrachteten Zeitraums sowie die Typen der zurückgegebenen Messwerte (measurement-types). (Die zurückgegebenen Messswerte enthalten Messwerte >= dem Startzeitpunkt und <= dem Endzeitpunkt) Verschiedene measurement-types können mit Hilfe des Zeichens '\|
-' getrennt werden.
-|===
-
-[%header,cols=2*]
-|===
-|Beschreibung
-|Wert
-
-|http-Methode
-|GET
-
-|Bezeichnung
-|/measurement-values
-
-|aktuelle Version
-|Revision 4 (CIM 17v07)
-
-|Sprache (ISO 639-1)
-|de
-
-|Spezifikation
-|link:resources/api/source-system.electricity.measurement.measurement-values_GET_4_de.open-api.yaml[source-system.electricity.measurement.measurement-values_GET_4_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*]
-|===
-|Messpunkte
-
-|Die Schnittstelle gibt alle Messpunkte zurück, die den angegeben Suchkriterien entsprechen. Messpunkte können sowohl topologische Ressourcen als auch Terminals sein. Weiterhin können die Typen der Messwerte (measurement-types), die die zurückzugebenen Messpunkte unterstützen als Suchkriterien genutzt werden. Verschiedene measurement-types können mit Hilfe des Zeichens '\|
-' getrennt werden.
-|===
-
-[%header,cols=2*]
-|===
-|Beschreibung
-|Wert
-
-|http-Methode
-|GET
-
-|Bezeichnung
-|/measurement-points
-
-|aktuelle Version
-|Revision 4 (CIM 17v07)
-
-|Sprache (ISO 639-1)
-|de
-
-|Spezifikation
-|link:resources/api/source-system.electricity.measurement.measurement-points_GET_4_de.open-api.yaml[source-system.electricity.measurement.measurement-points_GET_4_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.
-
-
-
-|===
-'''
-<<<
+[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*]
+|===
+|aktuelle Messwerte
+
+|Die Schnittstelle gibt die aktuellen Messwerte zurück, die den angegebenen Suchkriterien entsprechen. Es werden die Messwerte mit den angegebenen Messpunktschlüsseln (measurement-point-ids) berücksichtigt. Verschiedene Schlüssel können mit Hilfe des Zeichens '\|
+' getrennt werden. Weitere Suchkriterien sind der Startzeitpunkt in UTC (start-time) und der Endzeitpunkt in UTC (end-time) des betrachteten Zeitraums sowie die Typen der zurückgegebenen Messwerte (measurement-types). (Die zurückgegebenen Messswerte enthalten Messwerte >= dem Startzeitpunkt und <= dem Endzeitpunkt) Verschiedene measurement-types können mit Hilfe des Zeichens '\|
+' getrennt werden.
+|===
+
+[%header,cols=2*]
+|===
+|Beschreibung
+|Wert
+
+|http-Methode
+|GET
+
+|Bezeichnung
+|/measurement-values
+
+|aktuelle Version
+|Revision 4 (CIM 17v07)
+
+|Sprache (ISO 639-1)
+|de
+
+|Spezifikation
+|link:resources/api/source-system.electricity.measurement.measurement-values_GET_4_de.open-api.yaml[source-system.electricity.measurement.measurement-values_GET_4_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*]
+|===
+|Messpunkte
+
+|Die Schnittstelle gibt alle Messpunkte zurück, die den angegeben Suchkriterien entsprechen. Messpunkte können sowohl topologische Ressourcen als auch Terminals sein. Weiterhin können die Typen der Messwerte (measurement-types), die die zurückzugebenen Messpunkte unterstützen als Suchkriterien genutzt werden. Verschiedene measurement-types können mit Hilfe des Zeichens '\|
+' getrennt werden.
+|===
+
+[%header,cols=2*]
+|===
+|Beschreibung
+|Wert
+
+|http-Methode
+|GET
+
+|Bezeichnung
+|/measurement-points
+
+|aktuelle Version
+|Revision 4 (CIM 17v07)
+
+|Sprache (ISO 639-1)
+|de
+
+|Spezifikation
+|link:resources/api/source-system.electricity.measurement.measurement-points_GET_4_de.open-api.yaml[source-system.electricity.measurement.measurement-points_GET_4_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.
+
+
+
+|===
+'''
+<<<
diff --git a/doc/src/main/doc/docs/documentation/modules/user-concept-de.adoc b/doc/src/main/doc/docs/documentation/modules/user-concept-de.adoc
index d0c57e8..bbf753d 100644
--- a/doc/src/main/doc/docs/documentation/modules/user-concept-de.adoc
+++ b/doc/src/main/doc/docs/documentation/modules/user-concept-de.adoc
@@ -15,6 +15,9 @@ include::{docdir}/common/toc.adoc[]
= Benutzung
NOTE: {NoteSeeServiceFramework}
+= Service-Kommandos
+* add: Generiert neue (zufällige) Werte und fügt sie dem aktuellen Referenzmodell hinzu
+* reset: Löscht und baut das aktuelle Referenzmodell neu auf
// tear down document and reset parent informations
:context: {parent-context}
diff --git a/doc/src/main/doc/docs/test/modules/test-cases-report.csv b/doc/src/main/doc/docs/test/modules/test-cases-report.csv
index d40d279..e00add1 100644
--- a/doc/src/main/doc/docs/test/modules/test-cases-report.csv
+++ b/doc/src/main/doc/docs/test/modules/test-cases-report.csv
@@ -1,4 +1,4 @@
-;Offen;In Ausführung;Erfolgreich;Fehlerhaft;Nicht ausführbar;Gestrichen;Testfälle
-Initialer Test;0;0;24;2;0;1;
-Regressionstest;0;0;2;0;0;0;
-Gesamt;0;0;26;0;0;1;27
+;Offen;In Ausführung;Erfolgreich;Fehlerhaft;Nicht ausführbar;Gestrichen;Testfälle
+Initialer Test;0;0;24;2;0;1;
+Regressionstest;0;0;2;0;0;0;
+Gesamt;0;0;26;0;0;1;27
diff --git a/doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-points_GET_4_de.open-api.yaml b/doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-points_GET_4_de.open-api.yaml
index 5b87b3a..9f60c77 100644
--- a/doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-points_GET_4_de.open-api.yaml
+++ b/doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-points_GET_4_de.open-api.yaml
@@ -1,240 +1,240 @@
-swagger: '2.0'
-info:
- title: Messpunkte
- description: Diese Schnittstelle ist Teil der [oK](http://www.openkonsequenz.de) Quellsystem-API.
- version: Revision 4 (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/measurement
-produces:
-- application/xml
-paths:
- /measurement-points:
- get:
- summary: Die Schnittstelle gibt alle Messpunkte zurück, die den angegeben Suchkriterien entsprechen. Messpunkte können sowohl topologische Ressourcen als auch Terminals sein. Weiterhin können die Typen der Messwerte (measurement-types), die die zurückzugebenen Messpunkte unterstützen als Suchkriterien genutzt werden. Verschiedene measurement-types können mit Hilfe des Zeichens '|' getrennt werden.
- parameters:
- - name: revision
- in: query
- description: Version, die den Nachrichtenaustausch definiert. Dies ist nicht die CIM-Version.
- required: true
- type: integer
- format: int32
- minimum: 4
- maximum: 4
- - 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: measurement-types
- in: query
- description: Die Typen der Messwert, die die zurückzugebenden Messpunkte unterstützen. Verschiedene Schlüssel können mit Hilfe des Zeichens '|' getrennt werden. Wird dieser Wert nicht angegeben, werden alle Messwerttypen berücksichtigt. Unbekannte Typen werden ignoriert.
- required: false
- type: string
- enum: [Angle, LineCurrent, LineToLineVoltage, PhaseVoltage, ThreePhaseActivePower, ThreePhasePower, ThreePhaseReactivePower]
- responses:
- 200:
- description: Die CIM-Antwortnachricht.
- schema:
- $ref: '#/definitions/ResponseMessage'
- 400:
- description: Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
- 500:
- description: Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
-### specific definitions ######################################################
-definitions:
- Analog:
- description: Die analoge Messung.
- type: object
- properties:
- measurementType:
- description: Beschreibt den Typ der Messung.
- type: string
- enum:
- - Angle
- - LineCurrent
- - LineToLineVoltage
- - PhaseVoltage
- - ThreePhaseActivePower
- - ThreePhasePower
- - ThreePhaseReactivePower
- required:
- - measurementType
- xml:
- name: Analog
- MeasurementPoints:
- description: Die Messpunkte. Dies können topologische Ressourcen oder Terminals sein.
- type: object
- properties:
- PowerSystemResources:
- description: Die topologische Ressource an der gemessen wird.
- type: array
- minItems: 0
- items:
- $ref: '#/definitions/PowerSystemResource'
- Terminals:
- description: Das Terminal an dem gemessen wird.
- type: array
- minItems: 0
- items:
- $ref: '#/definitions/Terminal'
- Measurement:
- type: object
- properties:
- Analog:
- type: array
- minItems: 0
- items:
- $ref: '#/definitions/Analog'
- Payload:
- description: Der Inhalt der CIM-Antwortnachricht.
- type: object
- properties:
- MeasurementPoints:
- $ref: '#/definitions/MeasurementPoints'
- required:
- - MeasurementPoints
- PowerSystemResource:
- description: Die topologische Ressource an der gemessen wird.
- type: object
- properties:
- mRID:
- description: Die eindeutige Kennung der topologischen Ressource.
- 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}$'
- Measurements:
- type: array
- items:
- $ref: '#/definitions/Measurement'
- xml:
- name: Measurements
- required:
- - mRID
- - Measurements
- xml:
- name: PowerSystemResource
- Terminal:
- description: Das Terminal an dem gemessen wird.
- type: object
- properties:
- mRID:
- description: Die 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}$'
- Measurements:
- type: array
- items:
- $ref: '#/definitions/Measurement'
- xml:
- name: Measurements
- required:
- - mRID
- - Measurements
- xml:
- name: Terminal
-### common definitions ########################################################
- 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: 4
- maximum: 4
- 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
- User:
- $ref: '#/definitions/User'
- 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}$'
- required:
- - Verb
- - Noun
- - Revision
- - Timestamp
- - Source
- - MessageID
- xml:
- name: Header
- 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-Nachricht.
- type: object
- properties:
- Header:
- $ref: '#/definitions/Header_Reply'
- Reply:
- $ref: '#/definitions/Reply_OK'
- Payload:
- $ref: '#/definitions/Payload'
- required:
- - Header
- - Reply
- - Payload
- User:
- properties:
- userId:
- description: Eindeutige Kennung des angemeldeten Nutzers (Empfänger).
- type: string
- xml:
- name: UserID
- required:
+swagger: '2.0'
+info:
+ title: Messpunkte
+ description: Diese Schnittstelle ist Teil der [oK](http://www.openkonsequenz.de) Quellsystem-API.
+ version: Revision 4 (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/measurement
+produces:
+- application/xml
+paths:
+ /measurement-points:
+ get:
+ summary: Die Schnittstelle gibt alle Messpunkte zurück, die den angegeben Suchkriterien entsprechen. Messpunkte können sowohl topologische Ressourcen als auch Terminals sein. Weiterhin können die Typen der Messwerte (measurement-types), die die zurückzugebenen Messpunkte unterstützen als Suchkriterien genutzt werden. Verschiedene measurement-types können mit Hilfe des Zeichens '|' getrennt werden.
+ parameters:
+ - name: revision
+ in: query
+ description: Version, die den Nachrichtenaustausch definiert. Dies ist nicht die CIM-Version.
+ required: true
+ type: integer
+ format: int32
+ minimum: 4
+ maximum: 4
+ - 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: measurement-types
+ in: query
+ description: Die Typen der Messwert, die die zurückzugebenden Messpunkte unterstützen. Verschiedene Schlüssel können mit Hilfe des Zeichens '|' getrennt werden. Wird dieser Wert nicht angegeben, werden alle Messwerttypen berücksichtigt. Unbekannte Typen werden ignoriert.
+ required: false
+ type: string
+ enum: [Angle, LineCurrent, LineToLineVoltage, PhaseVoltage, ThreePhaseActivePower, ThreePhasePower, ThreePhaseReactivePower]
+ responses:
+ 200:
+ description: Die CIM-Antwortnachricht.
+ schema:
+ $ref: '#/definitions/ResponseMessage'
+ 400:
+ description: Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
+ 500:
+ description: Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
+### specific definitions ######################################################
+definitions:
+ Analog:
+ description: Die analoge Messung.
+ type: object
+ properties:
+ measurementType:
+ description: Beschreibt den Typ der Messung.
+ type: string
+ enum:
+ - Angle
+ - LineCurrent
+ - LineToLineVoltage
+ - PhaseVoltage
+ - ThreePhaseActivePower
+ - ThreePhasePower
+ - ThreePhaseReactivePower
+ required:
+ - measurementType
+ xml:
+ name: Analog
+ MeasurementPoints:
+ description: Die Messpunkte. Dies können topologische Ressourcen oder Terminals sein.
+ type: object
+ properties:
+ PowerSystemResources:
+ description: Die topologische Ressource an der gemessen wird.
+ type: array
+ minItems: 0
+ items:
+ $ref: '#/definitions/PowerSystemResource'
+ Terminals:
+ description: Das Terminal an dem gemessen wird.
+ type: array
+ minItems: 0
+ items:
+ $ref: '#/definitions/Terminal'
+ Measurement:
+ type: object
+ properties:
+ Analog:
+ type: array
+ minItems: 0
+ items:
+ $ref: '#/definitions/Analog'
+ Payload:
+ description: Der Inhalt der CIM-Antwortnachricht.
+ type: object
+ properties:
+ MeasurementPoints:
+ $ref: '#/definitions/MeasurementPoints'
+ required:
+ - MeasurementPoints
+ PowerSystemResource:
+ description: Die topologische Ressource an der gemessen wird.
+ type: object
+ properties:
+ mRID:
+ description: Die eindeutige Kennung der topologischen Ressource.
+ 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}$'
+ Measurements:
+ type: array
+ items:
+ $ref: '#/definitions/Measurement'
+ xml:
+ name: Measurements
+ required:
+ - mRID
+ - Measurements
+ xml:
+ name: PowerSystemResource
+ Terminal:
+ description: Das Terminal an dem gemessen wird.
+ type: object
+ properties:
+ mRID:
+ description: Die 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}$'
+ Measurements:
+ type: array
+ items:
+ $ref: '#/definitions/Measurement'
+ xml:
+ name: Measurements
+ required:
+ - mRID
+ - Measurements
+ xml:
+ name: Terminal
+### common definitions ########################################################
+ 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: 4
+ maximum: 4
+ 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
+ User:
+ $ref: '#/definitions/User'
+ 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}$'
+ required:
+ - Verb
+ - Noun
+ - Revision
+ - Timestamp
+ - Source
+ - MessageID
+ xml:
+ name: Header
+ 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-Nachricht.
+ type: object
+ properties:
+ Header:
+ $ref: '#/definitions/Header_Reply'
+ Reply:
+ $ref: '#/definitions/Reply_OK'
+ Payload:
+ $ref: '#/definitions/Payload'
+ required:
+ - Header
+ - Reply
+ - Payload
+ User:
+ properties:
+ userId:
+ description: Eindeutige Kennung des angemeldeten Nutzers (Empfänger).
+ type: string
+ xml:
+ name: UserID
+ required:
- UserID \ No newline at end of file
diff --git a/doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-values_GET_4_de.open-api.yaml b/doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-values_GET_4_de.open-api.yaml
index 33725b0..d173924 100644
--- a/doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-values_GET_4_de.open-api.yaml
+++ b/doc/src/main/doc/resources/api/source-system.electricity.measurement.measurement-values_GET_4_de.open-api.yaml
@@ -1,319 +1,319 @@
-swagger: '2.0'
-info:
- title: aktuelle Messwerte
- description: Diese Schnittstelle ist Teil der [oK](http://www.openkonsequenz.de) Quellsystem-API.
- version: Revision 4 (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/measurement
-produces:
-- application/xml
-paths:
- /measurement-values:
- get:
- summary: Die Schnittstelle gibt die aktuellen Messwerte zurück, die den angegebenen Suchkriterien entsprechen. Es werden die Messwerte mit den angegebenen Messpunktschlüsseln (measurement-point-ids) berücksichtigt. Verschiedene Schlüssel können mit Hilfe des Zeichens '|' getrennt werden. Weitere Suchkriterien sind der Startzeitpunkt in UTC (start-time) und der Endzeitpunkt in UTC (end-time) des betrachteten Zeitraums sowie die Typen der zurückgegebenen Messwerte (measurement-types). (Die zurückgegebenen Messswerte enthalten Messwerte >= dem Startzeitpunkt und <= dem Endzeitpunkt) Verschiedene measurement-types können mit Hilfe des Zeichens '|' getrennt werden.
- parameters:
- - name: revision
- in: query
- description: Version, die den Nachrichtenaustausch definiert. Dies ist nicht die CIM-Version.
- required: true
- type: integer
- format: int32
- minimum: 4
- maximum: 4
- - 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: measurement-point-ids
- in: query
- description: Die Schlüssel der Messpunkte, deren Messwerte zurückgegeben werden sollen. Verschiedene Schlüssel können mit Hilfe des Zeichens '|' getrennt werden. Wird kein Schlüssel angegeben, werden alle bekannten Messwerte zurückgegeben. Unbekannte Schlüssel werden ignoriert.
- required: false
- type: string
- pattern: '^(([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})([|][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*)$'
- - name: start-time
- in: query
- description: Der Anfangszeitpunkt des betrachteten Zeitraums (inklusive) in UTC gemäß ISO-8601-Format YYYY-MM-DDTHH:mm:ss.SSSZ. Wird dieser Wert nicht angegeben, werden alle Zeitpunkte bis zum Endzeitpunkt berücksichtigt.
- 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: end-time
- in: query
- description: Der Endzeitpunkt des betrachteten Zeitraums (inklusive) in UTC gemäß ISO-8601-Format YYYY-MM-DDTHH:mm:ss.SSSZ. Wird dieser Wert nicht angegeben, werden alle Zeitpunkte ab dem Anfangszeitpunkt berücksichtigt.
- 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: measurement-types
- in: query
- description: Die Typen der zurückzugebenden Messwerte. Verschiedene Schlüssel können mit Hilfe des Zeichens '|' getrennt werden. Wird dieser Wert nicht angegeben, werden alle Messwerttypen berücksichtigt. Unbekannte Typen werden ignoriert.
- required: false
- type: string
- enum: [Angle, LineCurrent, LineToLineVoltage, PhaseVoltage, ThreePhaseActivePower, ThreePhasePower, ThreePhaseReactivePower]
- responses:
- 200:
- description: Die CIM-Antwortnachricht.
- schema:
- $ref: '#/definitions/ResponseMessage'
- 400:
- description: Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
- 500:
- description: Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
-definitions:
-### specific definitions ######################################################
- Analog:
- description: die analoge Messung
- type: object
- properties:
- measurementType:
- description: die Art der Messung (aus CGMES Version 2.4.15)
- type: string
- enum:
- - Angle
- - LineCurrent
- - LineToLineVoltage
- - PhaseVoltage
- - ThreePhaseActivePower
- - ThreePhasePower
- - ThreePhaseReactivePower
- unitSymbol:
- description: die Einheit der Messung (CIM UnitSymbol)
- type: string
- enum:
- - A
- - deg
- - V
- - VA
- - VAr
- - W
- unitMultiplier:
- description: der Multiplikator der Messung (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
- AnalogValues:
- type: array
- minItems: 0
- maxItems: 1
- items:
- $ref: '#/definitions/AnalogValue'
- xml:
- wrapped: true
- required:
- - measurementType
- - unitSymbol
- - unitMultiplier
- - AnalogValues
- xml:
- name: Analog
- AnalogValue:
- description: der analoge Messwert
- type: object
- properties:
- timeStamp:
- 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)$'
- value:
- type: number
- format: double
- required:
- - timeStamp
- - value
- xml:
- name: AnalogValue
- Measurements:
- type: object
- properties:
- Analog:
- type: array
- minItems: 0
- items:
- $ref: '#/definitions/Analog'
- Payload:
- description: Der Inhalt der CIM-Nachricht.
- type: object
- properties:
- MeasurementValues:
- $ref: '#/definitions/Payload.MeasurementValues'
- required:
- - MeasurementValues
- Payload.MeasurementValues:
- description: |
- Die Liste der Messungen. Diese können topologischen Ressourcen oder Terminals erfolgen.
- type: object
- properties:
- PowerSystemResource:
- description: Die Liste der topologischen Ressourcen an denen gemessen wird.
- type: array
- minItems: 0
- items:
- $ref: '#/definitions/PowerSystemResource'
- Terminal:
- description: Die Liste der Terminals an denen gemessen wird.
- type: array
- minItems: 0
- items:
- $ref: '#/definitions/Terminal'
- PowerSystemResource:
- description: Die topologische Ressource an der gemessen wird.
- type: object
- properties:
- mRID:
- description: Die eindeutige Kennung der topologischen Ressource.
- 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}$'
- Measurements:
- type: array
- items:
- $ref: '#/definitions/Measurements'
- required:
- - mRID
- - Measurements
- xml:
- name: PowerSystemResource
- Terminal:
- description: Das Terminal an dem gemessen wird.
- type: object
- properties:
- mRID:
- description: Die 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}$'
- Measurements:
- type: array
- items:
- $ref: '#/definitions/Measurements'
- required:
- - mRID
- - Measurements
- xml:
- name: Terminal
-### common definitions ########################################################
- 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: 1
- maximum: 1
- 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
- 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-Nachricht.
- type: object
- properties:
- Header:
- $ref: '#/definitions/Header_Reply'
- Reply:
- $ref: '#/definitions/Reply_OK'
- Payload:
- $ref: '#/definitions/Payload'
- required:
- - Header
- - Reply
- - Payload
- UserID:
- properties:
- id:
- description: Eindeutige Kennung des angemeldeten Nutzers (Empfänger).
- type: string
- xml:
+swagger: '2.0'
+info:
+ title: aktuelle Messwerte
+ description: Diese Schnittstelle ist Teil der [oK](http://www.openkonsequenz.de) Quellsystem-API.
+ version: Revision 4 (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/measurement
+produces:
+- application/xml
+paths:
+ /measurement-values:
+ get:
+ summary: Die Schnittstelle gibt die aktuellen Messwerte zurück, die den angegebenen Suchkriterien entsprechen. Es werden die Messwerte mit den angegebenen Messpunktschlüsseln (measurement-point-ids) berücksichtigt. Verschiedene Schlüssel können mit Hilfe des Zeichens '|' getrennt werden. Weitere Suchkriterien sind der Startzeitpunkt in UTC (start-time) und der Endzeitpunkt in UTC (end-time) des betrachteten Zeitraums sowie die Typen der zurückgegebenen Messwerte (measurement-types). (Die zurückgegebenen Messswerte enthalten Messwerte >= dem Startzeitpunkt und <= dem Endzeitpunkt) Verschiedene measurement-types können mit Hilfe des Zeichens '|' getrennt werden.
+ parameters:
+ - name: revision
+ in: query
+ description: Version, die den Nachrichtenaustausch definiert. Dies ist nicht die CIM-Version.
+ required: true
+ type: integer
+ format: int32
+ minimum: 4
+ maximum: 4
+ - 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: measurement-point-ids
+ in: query
+ description: Die Schlüssel der Messpunkte, deren Messwerte zurückgegeben werden sollen. Verschiedene Schlüssel können mit Hilfe des Zeichens '|' getrennt werden. Wird kein Schlüssel angegeben, werden alle bekannten Messwerte zurückgegeben. Unbekannte Schlüssel werden ignoriert.
+ required: false
+ type: string
+ pattern: '^(([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})([|][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*)$'
+ - name: start-time
+ in: query
+ description: Der Anfangszeitpunkt des betrachteten Zeitraums (inklusive) in UTC gemäß ISO-8601-Format YYYY-MM-DDTHH:mm:ss.SSSZ. Wird dieser Wert nicht angegeben, werden alle Zeitpunkte bis zum Endzeitpunkt berücksichtigt.
+ 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: end-time
+ in: query
+ description: Der Endzeitpunkt des betrachteten Zeitraums (inklusive) in UTC gemäß ISO-8601-Format YYYY-MM-DDTHH:mm:ss.SSSZ. Wird dieser Wert nicht angegeben, werden alle Zeitpunkte ab dem Anfangszeitpunkt berücksichtigt.
+ 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: measurement-types
+ in: query
+ description: Die Typen der zurückzugebenden Messwerte. Verschiedene Schlüssel können mit Hilfe des Zeichens '|' getrennt werden. Wird dieser Wert nicht angegeben, werden alle Messwerttypen berücksichtigt. Unbekannte Typen werden ignoriert.
+ required: false
+ type: string
+ enum: [Angle, LineCurrent, LineToLineVoltage, PhaseVoltage, ThreePhaseActivePower, ThreePhasePower, ThreePhaseReactivePower]
+ responses:
+ 200:
+ description: Die CIM-Antwortnachricht.
+ schema:
+ $ref: '#/definitions/ResponseMessage'
+ 400:
+ description: Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
+ 500:
+ description: Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
+definitions:
+### specific definitions ######################################################
+ Analog:
+ description: die analoge Messung
+ type: object
+ properties:
+ measurementType:
+ description: die Art der Messung (aus CGMES Version 2.4.15)
+ type: string
+ enum:
+ - Angle
+ - LineCurrent
+ - LineToLineVoltage
+ - PhaseVoltage
+ - ThreePhaseActivePower
+ - ThreePhasePower
+ - ThreePhaseReactivePower
+ unitSymbol:
+ description: die Einheit der Messung (CIM UnitSymbol)
+ type: string
+ enum:
+ - A
+ - deg
+ - V
+ - VA
+ - VAr
+ - W
+ unitMultiplier:
+ description: der Multiplikator der Messung (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
+ AnalogValues:
+ type: array
+ minItems: 0
+ maxItems: 1
+ items:
+ $ref: '#/definitions/AnalogValue'
+ xml:
+ wrapped: true
+ required:
+ - measurementType
+ - unitSymbol
+ - unitMultiplier
+ - AnalogValues
+ xml:
+ name: Analog
+ AnalogValue:
+ description: der analoge Messwert
+ type: object
+ properties:
+ timeStamp:
+ 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)$'
+ value:
+ type: number
+ format: double
+ required:
+ - timeStamp
+ - value
+ xml:
+ name: AnalogValue
+ Measurements:
+ type: object
+ properties:
+ Analog:
+ type: array
+ minItems: 0
+ items:
+ $ref: '#/definitions/Analog'
+ Payload:
+ description: Der Inhalt der CIM-Nachricht.
+ type: object
+ properties:
+ MeasurementValues:
+ $ref: '#/definitions/Payload.MeasurementValues'
+ required:
+ - MeasurementValues
+ Payload.MeasurementValues:
+ description: |
+ Die Liste der Messungen. Diese können topologischen Ressourcen oder Terminals erfolgen.
+ type: object
+ properties:
+ PowerSystemResource:
+ description: Die Liste der topologischen Ressourcen an denen gemessen wird.
+ type: array
+ minItems: 0
+ items:
+ $ref: '#/definitions/PowerSystemResource'
+ Terminal:
+ description: Die Liste der Terminals an denen gemessen wird.
+ type: array
+ minItems: 0
+ items:
+ $ref: '#/definitions/Terminal'
+ PowerSystemResource:
+ description: Die topologische Ressource an der gemessen wird.
+ type: object
+ properties:
+ mRID:
+ description: Die eindeutige Kennung der topologischen Ressource.
+ 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}$'
+ Measurements:
+ type: array
+ items:
+ $ref: '#/definitions/Measurements'
+ required:
+ - mRID
+ - Measurements
+ xml:
+ name: PowerSystemResource
+ Terminal:
+ description: Das Terminal an dem gemessen wird.
+ type: object
+ properties:
+ mRID:
+ description: Die 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}$'
+ Measurements:
+ type: array
+ items:
+ $ref: '#/definitions/Measurements'
+ required:
+ - mRID
+ - Measurements
+ xml:
+ name: Terminal
+### common definitions ########################################################
+ 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: 1
+ maximum: 1
+ 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
+ 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-Nachricht.
+ type: object
+ properties:
+ Header:
+ $ref: '#/definitions/Header_Reply'
+ Reply:
+ $ref: '#/definitions/Reply_OK'
+ Payload:
+ $ref: '#/definitions/Payload'
+ required:
+ - Header
+ - Reply
+ - Payload
+ UserID:
+ properties:
+ id:
+ description: Eindeutige Kennung des angemeldeten Nutzers (Empfänger).
+ type: string
+ xml:
name: UserID \ No newline at end of file
diff --git a/doc/src/test/doc/test/test.adoc b/doc/src/test/doc/test/test.adoc
index 854988d..84315d3 100644
--- a/doc/src/test/doc/test/test.adoc
+++ b/doc/src/test/doc/test/test.adoc
@@ -1,20 +1,20 @@
-= openKonsequenz - Testkonzept
-:Author: Renko Ortgies
-:Date: 2019-02-12
-:Email: info@psi.de
-:Company: PSI Software AG
-:ProjectNameID: CIM Cache
-:stylesheet: common/html-skin.css
-:icons: font
-:lang: de
-:doctype: article
-:encoding: utf-8
-:source-highlighter: coderay
-:highlightjs-theme: solarized_dark
-:sectnums:
-:toc-title: Inhaltsverzeichnis
-:toc:
-
-== Testkonzept
-
-NOTE: Siehe Service-Framework (org-eclipse-openk-service).
+= openKonsequenz - Testkonzept
+:Author: Renko Ortgies
+:Date: 2019-02-12
+:Email: info@psi.de
+:Company: PSI Software AG
+:ProjectNameID: CIM Cache
+:stylesheet: common/html-skin.css
+:icons: font
+:lang: de
+:doctype: article
+:encoding: utf-8
+:source-highlighter: coderay
+:highlightjs-theme: solarized_dark
+:sectnums:
+:toc-title: Inhaltsverzeichnis
+:toc:
+
+== Testkonzept
+
+NOTE: Siehe Service-Framework (org-eclipse-openk-service).

Back to the top