ReadConfig (RT Unified) - WinCC Unified

WinCC Unified Open Pipe (RT Unified)

ft:publication_title
WinCC Unified Open Pipe (RT Unified)
Product
WinCC Unified
Version
V20
Publication date
06/2025
Language
en-US
ReadConfig

Description

The "ReadConfig" command reads the settings configured for the general browse behavior.

Request

{"Message": "ReadConfig", "Params": ['<Parameter>', '<Parameter>'], "ClientCookie": '<Cookie>'}

  • Params:

    Value: Comma-separated list of configuration parameters

    Possible parameters:

    • DefaultPageSize

      The page size used when a browse request is called without the "PageSize" parameter

    • BrowseTimeOut

      Number of seconds after which an inactive browse request is canceled.

  • Cookie:

    Name of the response cookie

For example:

{"Message": "ReadConfig", "Params": ['DefaultPageSize', 'BrowseTimout'], "ClientCookie": "myBrowseAlarmsRequest1"}

OnSuccess

{"Message":"NotifyReadConfig", "Params": {"<Parameter>":<Value>, "<Parameter>":<Value>}, "ClientCookie": '<Cookie>'}

For example:

{"Message":"NotifyReadConfig", "Params": {"DefaultPageSize":500, "BrowseTimeOut":60}, "ClientCookie": "myBrowseAlarmsRequest1"}

OnError

{"Message": "ErrorReadConfig", "ErrorCode": "<Code>", "ErrorDescription": "<Description>", "ClientCookie": "<Cookie>"}

For example:

{"Message": "ErrorReadConfig", "ErrorCode": "-2165322729", "ErrorDescription": "Invalid arguments passed to browsing function.", "ClientCookie": "myBrowseAlarmsRequest1"}