/reporting/Dps

"/reporting/Dps"
Der Endpunkt "/reporting/Dps" ist ähnlich wie /reporting/Dp aber dieser Endpunkt kann verwendet werden, um mehrere Datenpunkte abzufragen, und die Antwort ist ein strukturiertes JSON-Objekt. Es wird auch eine Autokorrektur durchgeführt, wenn DPs mit fehlendem Punkt am Ende bereitgestellt werden, z. B.: \c BeispielDP_Rpt2 --> \c BeispielDP_Rpt2. Siehe auch Beispiel unterhalb.
Parameter Beschreibung
Der erste erforderliche Parameter ist der Datenpunktname einschließlich des Systemnamens.
from Die beiden optionalen Parameter sind ein Zeitstempel für from und ein Zeitstempel für to.

Das Format des Zeitstempels ist ISO-Format.

Wenn nur der Parameter from angegeben wird, setzt die API den Parameter to auf das aktuelle Datum und die aktuelle Uhrzeit.

Wenn die Parameter from und to nicht angegeben sind, werden die Online-Werte abgefragt.

to
url "count"-URL-Parameter. Anzahl der Werte, die vor der "von"- und nach der "bis"-Zeit ausgelesen werden sollen. Der Defaultwert ist 0.
jsonCompact "jsonCompact"-URL-Parameter. Der Defaultwert ist 0. Wenn Sie den Parameter auf 1 setzen, wird das JSON in einem komprimierten Format zurückgegeben (Ausgabe in einer Zeile), nicht "menschenlesbar", aber etwas weniger Netzwerkverkehr.
verifyDpExistence

"verifyDpExistence"-URL-Parameter. Wenn Sie den Parameter auf TRUE setzen, prüft der Endpunkt, ob alle angegebenen DPs existieren oder nicht. Wenn einer von ihnen nicht existiert, wird ein JSON-Fehlerobjekt zurückgegeben: { "Fehlertext": "Beschreibung des aufgetretenen Fehlers" }

Wenn Sie den Parameter auf FALSE (Default) setzen, wird ein "Datenpunkt existiert nicht"-Fehler zurückgegeben.

Note: Die Anzahl kann auch über den Konfigurationseintrag dpGetPeriodCount gesetzt werden, das JSON-Format über den Konfigurationseintrag jsonCompact und die Existenz von Datenpunkten kann über den Konfigurationseintrag verifyDpExistenceüberprüft werden. Siehe dazu den Abschnitt [restReporting] für die Konfigurationseinträge. Beachten Sie, dass der URL-Parameter die über die Konfigurationseinträge eingestellten Werte überschreibt.

DPs mit zwei DPs und 'from'-Parameter:

Request:

https://HOST:443/reporting/Dps?System1:ExampleDP_Rpt1.&System1:ExampleDP_Rpt2.&from=2023-02-13T12:00:00.000Z 

Response:

{
  "generatedBy": "WinCC OA 3.19-P001 @ Windows AMD64",
   "formatVersionMajor": 2,
   "formatVersionMinor": 0,
   "from": "2023-02-13T12:00:00.000Z",
   "to": "2023-02-13T15:00:00.000Z",
    "dps": [
       {
          "DP":"System1:ExampleDP_Rpt1.",
          "result": {
             "returnMessage": "ok",
             "returnCode": 0,
             "data": [
               {
                  "value": 23.0,
                  "timestamp": "2023-02-13T12:01:45.745Z",
                  "statusBits": 9439544818969608449,
                  "manager": "UI -num 1"
               },
               {
                  "value": 41.0,
                  "timestamp": "2023-02-13T12:04:45.746Z",
                  "statusBits": 9439544818971705601,
                  "manager": "UI -num 1"
               },
               // ...
               {
                  "value": 72.0,
                  "timestamp": "2023-02-13T13:09:03.513Z",
                  "statusBits": 9439544818971705601,
                  "manager": "UI -num 1"
               }
            ]
         }
      },
     {
      "DP":"System1:ExampleDP_Rpt2.",
       "result": {
          "returnMessage": "ok",
           "returnCode": 0,
             "data": [
                {
                  "value": 70.0,
                   "timestamp": "2023-02-13T12:01:45.745Z",
                   "statusBits": 9439544818971705601,
                   "manager": "UI -num 1"
                },
                {
                   "value": 55.0,
                   "timestamp": "2023-02-13T12:04:45.746Z",
                   "statusBits": 9439544818969608449,
                   "manager": "UI -num 1"
                },
                {
                   "value": 103.0,
                   "timestamp": "2023-02-13T12:07:45.746Z",
                   "statusBits": 9439544818971705601,
                   "manager": "UI -num 1"
                },
                // ...
                {
                  "value": 26.0,
                   "timestamp": "2023-02-13T13:09:03.513Z",
                   "statusBits": 9439544818969608449,
                   "manager": "UI -num 1"
                }
             ]
          }
       }
   ]
}