Attributes in the Output Items

In this section, you can find the descriptions of all the attributes for the header, serverName, and tagList items in the Output tab.

The following table provides the descriptions of all the attributes in the header item:

Attribute Name Data Type Description
consumer String The identifier of the message user.
provider String The identifier of the message provider.
timestamp String The date and time when the message is generated.
messageId String The globally unique identifier of the message.
correlationId String The correlation identifier that can be used for correlating multiple messages.
serverName String The name of the PI server that stores the tag.

The following table provides the descriptions of all the attributes in the serverName and tagList items:

Attribute Name Data Type Description
serverName String The name of the PI server that stores the tag.
name String The unique name of the tag.
value String The tag value returned by PI server.

If the value is not available for any reason, it is set to N/A. And it is not relevant for Blob type tags.

binaryValue Binary The binary value of the tag returned by PI server.

If the value is not available for any reason, it is set to N/A. And it is relevant for Blob type tags only.

timestamp String The date and time when the tag value is generated.
isGood Boolean The attribute that identifies whether the tag value is valid.
isStale Boolean The attribute that identifies whether the last tag value change is stale in relation to the stale period you specify in the getValues request.

The value is relevant only when the staleFrom and staleTo values are entered in the getValues request.

  • If the last tag value change happens within the stale period, isStale is set to true.
  • If the last tag value change happens after the staleTo value, isStale is set to false.
  • If the last tag value change happens before the staleFrom value, the tag is omitted from the response message.