getTagValues: Output Items

Snapshot

The following table provides the descriptions of the output items for the Snapshot type of value:

Output Item

Data Type

Description

responseHeader

Complex

The response message header.

failureList

Complex

A list of tags on which operations are not done in the right way.

It is used as an output item in bulk tag operations where some of the tag operations succeed and some fail.

For descriptions of the attributes in this item, see Attributes in the failureList item.

tagValueList

Complex

A list of current tag values stored on the PI server.

For descriptions of the attributes in this item, see Attributes in the tagValueList item.

Attributes in the failureList item
Attribute Name	Data Type	Description
`tagName`	String	The name of the tag under which the operation fails
`errorCode`	String	The unique identification of the error
`errorDesc`	String	The text description of the error

Attributes in the tagValueList item
Attribute Name	Data Type	Description
`name`	String	The unique name of the tag name.
`value`	String	The tag value returned from PI server. If the value is not available for any reason, `N/A` is filled in this field. This value is not relevant for Blob type tags.
`binaryValue`	Binary	The binary value of the tag returned from the PI server. If the value is not available for any reason, `N/A` is filled in this field. This value is only relevant for Blob type tags.
`timestamp`	String	The timestamp of the tag value.
`isGood`	Boolean	The attribute that identifies whether the tag is set to a valid value.
`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, then the tag is omitted from the response message.

ValueHistory

The following table provides the descriptions of the output items for the ValueHistory type of value:

Output Item	Data Type	Description
`responseHeader`	Complex	The response message header
`valueList`	Complex	The list of historical values that match the filtering criteria

Note: When you use the AF TagValues activity to get historical tag values, the output results are incorrect if the following conditions are satisfied simultaneously:

In the Input tab, both startTime and endTime are specified to the same timestamp, which can be a timestamp more recent than the timestamp of the latest tag value, or a timestamp between the creation timestamp of the tag and the timestamp of the latest tag value.
In the Input tab, boundaryType is specified to Interpolated.
In the Input tab, filterExp is specified to a valid value.

ArcValues

The following table provides the descriptions of the output items for the ArcValue type of value:

Output Item	Data Type	Description
`responseHeader`	Complex	The response message header.
`arcValue`	Complex	A single value associated to the timestamp. For descriptions of the attributes in this element, see Attributes in the arcValue item.

Attributes in the arcValue item
Output Item	Data Type	Description
`value`	String	The archival value of the tag.
`binaryValue`	Binary	The archival binary value of the tag. This value is only relevant to Blob type tags.
`timestamp`	String	The timestamp of the archival value of the tag.

ValueHistoryByCount

The following table provides the descriptions of the output items for the ValueHistoryByCount type of value:

Output Item	Data Type	Description
`responseHeader`	Complex	The response message header
`valueList`	Complex	A list of historical values that match the filtering criteria