Menu

filter

Alters a filter of the report produced by a loadReport commands. The specified value attribute will overwrite the predefined value in the filter.

Parent commands

  • loadReport
    Required. This parent command loads its report with the modified filter values.

Attributes

index

Required
Value type
EL-evaluated
Yes Number Yes
Defines the index of the filter to alter. The report's first filter's index is 1, second filter's is 2, and so on. This index combined with the value of the field attribute is used to find the correct filter to alter.
field

Required
Value type
EL-evaluated
Yes String Yes
Name of the filter's field. This field name is expected to be an API name understood by the Salesforce Reports and Dashboards API.
value

Required
Value type
EL-evaluated
Yes String Yes
Defines the new value for the filter.

Examples

If a report would have a single filter specifying that only records created after the 1st of January 2014 are to be included (CREATED_DATE greaterThan 2014-01-01), the following filter could be used:

<filter index="1" field="CREATED_DATE" value="2012-01-01">

This would change the filter so that record created after 1st of January 2012 are included, possibly increasing the size of the result set.

Comments

0 comments