searchEventFrames: Input Items

In this section, you can find the descriptions of the input items for the searchEventFrames 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.
startTime String No A PI time expression that specifies the start of the time period used to search for event frames.
endTime String No A PI time expression that specifies the end of the time period used to search for event frames.
inProgress Boolean No If applicable, this flag is used to restrict matching event frames to those that have not yet finished.
fetchAllDescendants Boolean No This flag is used to search all levels of the event frame hierarchy below the specified root for matching event frames.
eventFrameName String No Enter the name of the event frame to retrieve, based on the filter type. You can enter special characters to match part of a name.
analysisName String No Enter the name of the analysis that retrieved event frames were generated from. You can use wildcards as needed.
elementName String No Enter a PI AF element that must be the parent of any retrieved event frames. You can enter special characters to match part of a name.
categoryName String No The category that retrieved event frames must match.
templateName String No The template that retrieved event frames must be based on.
searchMode String No The modes of event frames are used while searching event frames. The following values are supported:

  • Active Between

  • Ending Between

  • Starting Between

  • Entirely Between

  • Ending After

  • Ending Before

  • Starting Ater

  • Starting Before

Note: If any one of these values is present, then it takes precedence over the General tab Search Mode value.
numberOfRecords Int No

Number of event frames that you want to fetch.

Note: If the user specifies negative or zero value for numberOfRecords, it won’t consider that value and process output with all the event frames.