searchElements with Attributes: Input Items

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

The following table provides the description of the input items for the searchElements operation when Get Attributes check box is enabled.

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.

elementName String No Provide AFElement name that you want to search.

You can use a regular expression as well while searching the AFElement.

elementSearchRoot String Yes Provide AFElement search root.

It does not support regular expressions.

fetchAllDescendants Boolean No Provide AFElement search criteria to get all descendants or not.

By default this value is true.

templateName String No Provide AFElement template name from which AFElement is created on the PI AF server.
categoryName String No Provide AFElement category name that is provided while creating the AFElement.
elementType String No Provide AFElement type that is provided while creating AFElement.

Supported types in this field are Int16, Int32, Int64, Boolean, Byte, String, Double, Single, and DateTime.

For more information, see the AF SDK documentation.