getTagDefinitions: Input Items

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

The following table lists the descriptions of all the input items:

Input Item Data Type Required Description
requestHeader Complex No The request message header.

For descriptions of all the attributes in this element, see Attributes in requestHeader.

filterExpression String Yes The expression used for filtering the returned tag definitions.

The expression format must correspond with the method you specify in the useMethod element. For example, to get all tags starting with a:

  • If the useMethod element is set to useGetPoints, type "a*" in this field.
  • If the useMethod element is set to useGetPointsSql, type "tag:a*" in this field.

useMethod String No The filtering method used to evaluate the filtering expression in the filterExpression element.

 

Enter one of the following methods in this field:

  • useGetPoints (default): the method that uses PI server specific syntax.
  • useGetPointsSql: the method that uses SQL-like syntax.