Web API Service

The system:inmation Web API (application programming interface) is hosted in a Windows Service. It can be used by any external application as an interface to system:inmation, using HTTP or WebSocket calls. The Web API is also used extensively by Visual KPI in enterprise:inmation, to provide and update the data items displayed on the Web dashboard. Using the Web API you can perform the following actions:

  1. Read from any VQT item in the system:inmation namespace

  2. Write to any VQT item in the system:inmation namespace

  3. Read History from any VQT item in the system:inmation namespace

  4. Execute a function from a Lua script library

  5. Encode a JSON document to a Base64 string

Detailed information about the HTTP service can be found in the Swagger documentation page of the Web API: <Web API base address>/api/docs. The default url is http://localhost:8002/api/docs

The Swagger documentation page is only visible after the Web API service has been installed.