Interface GetRulesRequest

Hierarchy

  • GetRulesRequest

Properties

enabled? fields? include_fields? include_totals? page? per_page?

Properties

Optional enabled

enabled?: boolean

Optional filter on whether a rule is enabled (true) or disabled (false).

Optional fields

fields?: string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Optional include_fields

include_fields?: boolean

Whether specified fields are to be included (true) or excluded (false).

Optional include_totals

include_totals?: boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

Optional page

page?: number

Page index of the results to return. First page is 0.

Optional per_page

per_page?: number

Number of results per page. Paging is disabled if parameter not sent.

Settings

Member Visibility

Theme

On This Page