Basics of expert syntax (RT Unified)

Basics of expert syntax

Characteristics

The expert syntax has the following characteristics:

Complete JSON commands and replies.
Commands for individual objects and multiple objects, for example, to write multiple tags in one call.
Character coding is always UTF-8.
Cookies are available and mandatory.

Structure of a request

{

" Message ": "<Command>",

" Params ":

{

"<Object name>":

[

"<Param1>",

"<Param2>"

]

},

" ClientCookie ": "<Cookie name>"

}

Structure of a response

OnSuccess

{

" Message ": "Notify<Command>",

" Params ":

{

"<Object name>":

[

{

"<Value1>"

},

{

"<Value2>"

}

]

},

" ClientCookie ": "<Cookie name>"

}

OnError

{

"Message": "Error<Command>",

"ErrorCode": "<Error code>",

"ErrorDescription": "<Error description>",

"ClientCookie": "<Cookie name>"

}

Overview of the commands of the expert syntax

Command	OnSuccess	OnError	Description
`SubscribeTag <Tag> <ClientCookie>`	`NotifySubscribeTag <Tag name> <Value> <TimeStamp> <Quality> <QualityCode> <hasChanged> <Error code> <Error text> <ClientCookie>`	`ErrorSubscribeTag <Error code> <Error text> <ClientCookie>`	Subscribes one or more tags for monitoring.
`UnsubscribeTag <ClientCookie>`	`NotifyUnsubscribeTag <ClientCookie>`	`ErrorUnsubscribeTag <Error code> <Error text> <ClientCookie>`	Unsubscribes the tag or tags from the cookie from monitoring.
`ReadTag <Tags> <ClientCookie>`	`NotifyReadTag <Tag name> <Value> <TimeStamp> <Quality> <QualityCode> <Errorcode> <Error text> <ClientCookie>`	`ErrorReadTag <Error code> <Error text> <ClientCookie>`	Reads the value of one or more tags of the system.
`WriteTag <Tags, Values>` `<ClientCookie>`	`NotifyWriteTag <Tag name> <Error code> <Error text>` `<ClientCookie>`	`ErrorWriteTag <Error code> <Error text> <ClientCookie>`	Writes the specified values to the specified tags.
`SubscribeAlarm <Filter> <Systems> <Language> <ClientCookie>`	`NotifySubscribeAlarm <ClientCookie> <Alarms>`	`ErrorSubscribeAlarm <Error code> <Error text> <ClientCookie>`	Subscribes the alarms defined over the filter, the system and the language ID for monitoring.
`UnsubscribeAlarm <ClientCookie>`	`NotifyUnsubscribeAlarm <ClientCookie>`	`Error UnsubscribeAlarm <Error code> <Error text> <ClientCookie>`	Unsubscribes the alarms from the cookie from monitoring.
`ReadAlarm <Filter> <Systems> <Language>` `<ClientCookie>`	`NotifyReadAlarm <ClientCookie> <Alarms>`	`ErrorReadAlarm <Error code> <Error text> <ClientCookie>`	Reads the alarms defined by the filter, the system and the LanguageID.
`ReadConfig <Parameter> <ClientCookie>`	`NotifyReadConfig <Parameter> <Value> <ClientCookie>`	`ErrorReadConfig <Error code> <Error text> <ClientCookie>`	Reads the settings configured for the general browse behavior.
`WriteConfig <Parameter> <ClientCookie>`	`NotifyWriteConfig <Parameter> <Value> <ClientCookie>`	`ErrorWriteConfig <Error code> <Error text><ClientCookie>`	Sets the settings for the general browse behavior.
`BrowseTags` Initial request: `BrowseTags <LanguageId> <Filter> <Attribute> <PageSize> <Systems> <ClientCookie>` Next request: `BrowseTags <Next> <ClientCookie>`	`NotifyBrowseTags <Attribute> <Value> ... <Attribute> <Value> <ClientCookie>`	`ErrorBrowseTags <Error code> <Error text> <ClientCookie>`	Returns "Name", "DisplayName" and "DataType" as well as optional additional attribute values of the tags of the local system or several HMI systems communicating via runtime collaboration.
`BrowseConfiguredAlarms`: Initial request: `BrowseConfiguredAlarms <LanguageId> <Filter> <Attributes> <PageSize> <SystemNames> <ClientCookie>` Next request: `BrowseConfiguredAlarms <Next> <ClientCookie>`	`NotifyBrowseConfiguredAlarms <Alarm class> <Alarms> ... <Alarm class> <Alarms> <ClientCookie>`	`ErrorBrowseConfiguredAlarms <Error code> <Error text> <ClientCookie>`	Returns "AlarmClass", "Name" and "Area" as well as optional further attribute values of the configured alarms of an HMI system or several systems communicating via Runtime Collaboration.
`BrowseAlarmClasses <Filter> <Attributes> <Systems>`	`NotifyBrowseAlarmClasses <Alarm class> ... <Alarm class> <ClientCookie>`	`ErrorBrowseAlarmClasses <Error code> <Error text> <ClientCookie>`	Returns the alarm classes of the local system or all systems communicating via Runtime Collaboration.

Errors and error texts

This help only provides a selection of possible error messages. The error texts can also differ from the texts in your projects.

Attributes of the tags and alarms

You can find a description of the attributes of the tags and alarms in the help document Runtime - Open Development Kit (ODK).

Basics of expert syntax (RT Unified) - WinCC Unified

WinCC Unified Open Pipe (RT Unified)