/reporting/DpNames
- "/reporting/DpNames?[api-version=<vernr>]"
- The "/reporting/DpNames?[api-version=<vernr>]" endpoint provides a list with all available data points. The provided information contains the name of each
data point including the respective system name. See also examples below.
CAUTION: Breaking change with version 2.0! If you like to continue using the old format, set the api-version=1.0 or api-version=1.1!
Parameter | Description |
---|---|
api-version |
Version number for compatibility reasons. The default value is 2.0! |
jsonCompact |
jsonCompact. The default value is 0. If you set the parameter to 1, the JSON will be returned in a compressed format (output on one line), not "human readable", but slightly less network traffic. |
Example with the version 2.0
As of the version 2.0 of the REST Reporting API (available with WinCC OA 3.19-P002) the standard format of the response has been changed to structured JSON objects instead of flat JSON array.
Request:
https://HOST:443/reporting/DpNames
Response:
{
"generatedBy": "WinCC OA 3.19-P002 @ Windows AMD64",
"formatVersionMajor": 2,
"formatVersionMinor": 0,
"dps": [
{
"DP": "System1:AlertHorn"
},
{
"DP": "System1:Connection1"
},
{
"DP": "System1:Connection2"
},
// ...
{
"DP": "System1:warning"
}
]
}
Example with the version 1.0 - 1.1
Request:
https://HOST:443/reporting/DpNames
Response:
[
"System1:ExampleDP_AlertHdl1",
"System1:ExampleDP_AlertHdl2",
"System1:ExampleDP_Arg1",
"System1:ExampleDP_Arg2",
"System1:ExampleDP_BarTrend",
"System1:ExampleDP_DDE",
"System1:ExampleDP_Result",
"System1:ExampleDP_Rpt1",
"System1:ExampleDP_Rpt2"
...
]
Example with the version 1.0 -1 .1
If you prefer the previous format you must provide the api-version parameter with the value 1.0 or 1.1.
Request:
https://HOST:443/reporting/DpNames?api-version=1.1
Response:
["System1:AlertHorn", "System1:Connection1", "System1:Connection2", /* ... */ "System1:warning"]