getTagValues: Input Items

In this section, you can find the descriptions of the input items for the getTagValues operation depending on the value type you select on the General tab.

Snapshot

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

Input Item Data Type Required Description
requestHeader Complex No The request message header.
tagList Complex Yes The list of tag names that you want to get values for. You can add multiple tags in this list.
staleFrom String Yes The starting time of the stale period.
Note: You have to specify both staleFrom and staleTo, and the staleTo value has to be more recent than the staleFrom value.
staleTo String Yes The ending time of the stale period.
Note: You have to specify both staleFrom and staleTo, and the staleTo value has to be more recent than the staleFrom value.

ArcValue

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

Input Item Data Type Required Description
requestHeader Complex No The request message header.
tag String Yes The name of the tag that you want to get historical values for.
timeStamp String No The timestamp of the requested value.

If you do not specify the value, "*" is filled in this field, which means the current date and time.

mode String No The attribute that determines how the value is assigned to the timestamp.

Supported modes in this plug-in are Auto, AtOrBefore, Before, AtOrAfter, After, and Exact.

If you do not specify a value, Auto is filled in this field.

ValueHistory

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

Input Item Data Type Required Description
requestHeader Complex No The request message header.
tag String Yes The name of the tag that you want to get historical values for.
startTime String No The starting time for filtering results.

If you do not specify the value, "*" is filled in this field, which means the current date and time.

endTime String No The end time for filtering results.
count Integer No The number of values that are retrieved from the starting time forwards or backwards.
isForward Boolean No The attribute that determines the timestamp range for retrieving in relation to the specified startTime:
  • If it is set to false(), tag values with timestamps that are less recent than the specified startTime are retrieved. The tag value are returned in time descending order.
  • If it is set to true(), tag values with timestamps that are more recent than the specified startTime are retrieved.

If you do not specify the value, false() is filled in this field by default.

boundaryType String No The attribute that determines which values are returned in relation to the requested time boundaries.

Supported boundary types in this plug-in are Inside, Outside, and Interpolated.

If you do not specify the value, Inside is filled in this field by default.

filterExp String No The PE syntax expression used for filtering historical values.

For example, "'SINUSOID'>70" and "'SINUSOID'<80".

Note:

In version 6.1.0 and 6.2.0 of TIBCO ActiveMatrix BusinessWorks Plug-in for OSIsoft PI System, the ValueHistory type and the ValueHistoryByCount type are merged into one type ValueHistory, but the input items have the same meanings as in version 6.0.0.