API for Report Filters¶

Part of the Object based program API.

class ReportFilterApi¶

API to create report filter definitions

Returned by

• ConfigurationApi.ReportFilterApi

CreateFilterGroupConjunction()¶

Creates an ‘AND’ report filter group. Used to group several filter elements (FilterElement).

Returns:

The ‘AND’ report filter group

Return type:

FilterGroupConjunction

CreateFilterGroupDisjunction()¶

Creates an ‘OR’ report filter group. Used to group several filter elements (FilterElement) or ‘AND’ filter groups (FilterGroupConjunction).

Returns:

The ‘OR’ report filter group

Return type:

FilterGroupDisjunction

GetAvailableFilters()¶

Returns a list of configured filters.

Returns:

List of filters

Return type:

list[FilterGroupElement]