Introduction
The object used to specify the arguments when searching for ExceptionEvent.
This search has been designed to work efficiently with these combinations of parameters:
  • Id
  • DeviceSearch + RuleSearch + FromDate and/or ToDate
Properties

deviceSearch

Filter by the DeviceSearch options. Providing a Device ID will search for any Exception Events recorded for that Device. Providing Groups will search Exception Events recorded for Devices that are members of the provided GroupSearch(s) or their children. Available DeviceSearch options are:.
  • Id
  • Groups

fromDate

Search for Exception Events that occurred at this date or after.

id

Search for an entry based on the specific Id.

includeExceptionCount

A value indicating whether to include the count of exception instances for the returned exception events. When set to true, the ExceptionEvent.exceptionCount property will be populated.
Only supported when calling Get<ExceptionEvent>. Setting this to true when calling GetFeed<ExceptionEvent> will cause the call to be rejected.

includeInvalidated

Search for ExceptionEvents that have been invalidated because of new data being processed. The default value is [false] while using "Get" and "GetFeed" APIs.

ruleSearch

Filter by the RuleSearch options. Providing a Rule ID will search for any Exception Events recorded for that Rule. Providing a ExceptionRuleBaseType will search for any Exception Events with the given Base Type. Available RuleSearch options are:.
  • Id

toDate

Search for Exception Events that occurred at this date or before.

Loading API Runner...