Home
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
REST Reporting API
The REST Reporting API is integrated into the Standard web server and can be activated via the config entry [restRporting] enabled.
Endpoints
/reporting/DpNames

Version Information
Release Notes, Update information, Certifications and Frequently Asked Questions.
Concepts
Your first step into modern and powerful process visualization.
Deployment
Topics you need to know before using WinCC OA.
Security
Go beyond the norm in cybersecurity.
Engineering
Powerful tools for easy or complex engineering tasks.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
Data Visualization
User interfaces, Trends and Reports for every purpose and device.
Southbound Interfaces
The process connection to the actual machines/sensors.
Northbound Interfaces
Your portal to the cloud or supervising systems.
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
- APIs
  An overview of the APIs (Application Programming Interface) available in WinCC OA.
- COM
  COM - Microsoft Interface stands for Component Object Model, a specification for developing modular software components which can be used by each COM compatible application. COM components can be easily integrated in such applications and can even be removed from an application at run time. COM components can be programmed in various different programming languages although C++ is used mostly. The specifications OLE, ActiveX and DirectX are based on the COM technology.
- Prometheus Interface
  The Prometheus interface (also referred to as Prometheus client) serves as a bridge between WinCC OA and Prometheus. It facilitates the retrieval, processing, and exposure of data from the WinCC OA system to a Prometheus-compatible format. This allows Prometheus to monitor and alert based on the data fetched from the WinCC OA system.
- SIMATIC PLC Discovery
  In increasingly dynamic automation environments and the merging of IT with OT, the SIMATIC PLC Discovery can help with the connection of newly added S7/S7+ devices by showing you all the devices in the network
- WinCC OA JavaScript Manager for Node.js
  The WinCC OA JavaScript Manager for Node.js is a manager that allows for the integration of the TypeScript/JavaScript runtime environment Node.js® into WinCC OA.
- SIMATIC Unified AR (Augmented Reality)
  SIMATIC Unified AR is an industrial Augmented Reality app that allows to display and operate HMI screens (WinCC Unified) and web applications (WinCC OA Dashboard) in real production environments.
- HTTP Server
  The HTTP Server integrates Internet technologies directly into WinCC OA . Implemented as an add-on for the Control Manager, possible applications are many and diverse. The HTTP Server can be used as a web server for static HTML pages including download facility or to generate dynamic HTML pages.
- XML-RPC
  XML-RPC (Extensible Markup Language Remote Procedure Call) allows software on different operating systems to make procedure calls over the internet. XML-RPC uses HTTP for the transport and XML for the encoding. It sends the procedure call to a remote server through HTTP. The call is an XML document and it receives the response as XML.
- REST Reporting API
  The REST Reporting API is integrated into the Standard web server and can be activated via the config entry [restRporting] enabled.
- Distributed systems
  Distributed systems in WinCC OA allow to connect two or more autonomous WinCC OA systems via a network.
- Dist-Management
  Configuring and maintaining a distributed system in WinCC OA requires a high amount of engineering effort due to a high number of settings and configuration steps that must be applied on several systems. The Dist-Management reduces the engineering effort and simplifies the necessary settings.
- XMPP
  XMPP (formerly Jabber) is mostly used in chat (instant messaging) applications and allows near real time communication between two or more parties. It can, e.g., be used to push information from a WinCC_OA project server to one or more persons, even allowing the recipient to send a confirmation back to the server.
User Management
All about authorization, authentication and login-customization.
Availability
How to get your system uptime to the maximum.
Reporting
Create state of the art project reports without limits.
Addons
Useful tools and enhancements for special demands.
Reference Tables
Detailed and extensive content for special project adaptation.
Videos & Tutorials
Explore the capabilities of WinCC OA with our carefully selected collection of video tutorials and guides.
Documentation
Basic information about terms and functions within the documentation.
Support & Services
An experienced team of support agents, consultants and trainers are ready to facilitate active partnerships with our customers, so they can profit from our comprehensive service.
Disclaimer
A brief clarification of liability exclusions or legal notices.

/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"]