A NetworkMessage with MessageType “ua-action-response” contains a JSON array with ActionResponse messages. An ActionResponse message is a JSON object with the fields defined in Table 194.
Table 194 – JSON ActionResponse definition
|
Name |
Type |
Description |
|
DataSetWriterId |
UInt16 |
An identifier for DataSetWriter which created the Response. This value is mandatory. It is unique within the scope of a Responder. |
|
ActionTargetId |
UInt16 |
The numeric identifier assigned to the Action target which is unique within one ActionMetaData. This value is mandatory. It is used to address the Action target in combination with the PublisherId and the DataSetWriterId. |
|
DataSetWriterName |
String |
The name of the DataSetWriter which created the DataSetMessage. The presence of the value depends on the setting in the JsonDataSetMessageContentMask. |
|
WriterGroupName |
String |
The name of the WriterGroup which created the DataSetMessage. The presence of the value depends on the setting in the JsonDataSetMessageContentMask. The value shall be omitted if the WriterGroupName is contained in the NetworkMessage header. |
|
MetaDataVersion |
ConfigurationVersionDataType |
The version of the ActionMetaData Response which describes the contents of the Payload. The presence of the value depends on the setting in the JsonDataSetMessageContentMask. |
|
MinorVersion |
VersionTime |
The minor version of the ActionMetaData Response which describes the contents of the Payload. The presence of the value depends on the setting in the JsonDataSetMessageContentMask. The value shall be omitted if the MetaDataVersion is contained in the DataSetMessage header. |
|
Timestamp |
DateTime |
The time the DataSetMessage was created. The presence of the value depends on the setting in the JsonDataSetMessageContentMask. |
|
Status |
StatusCode |
The overall result of the Action Response. The value shall be present. |
|
MessageType |
String |
“ua-action-response”. The presence of the value depends on the setting in the JsonDataSetMessageContentMask. |
|
RequestId |
UInt16 |
Data provided by the Requestor in the Request message that is returned to the Requestor in the Response message. |
|
ActionState |
ActionState |
The current state of this currently running Action. The details for the use of this value and the relation to other values for a Action execution is defined in 6.2.11.2. |
|
Payload |
Object |
A JSON object containing the name-value pairs specified by the ActionMetaData. The format of the value depends on the DataType of the field and the flags specified by the DataSetFieldContentMask. Only Variant or RawData encoding shall be allowed. If bits for DataValue encoding are set, the Variant encoding shall be used. |
The encoding rules defined in 7.2.5.4 for DataSetMessages also apply to the ActionResponse message. The DataValue encoding shall not be used in ActionResponse message. The RawData flag shall be FALSE for ActionResponse messages.