Class CaseAggregateRequestAttributes

Attributes for the aggregation request, including the search query and grouping configuration.

Hierarchy

  • CaseAggregateRequestAttributes

Constructors

constructor

Properties

additionalProperties? groupBy queryFilter

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

groupBy

groupBy: CaseAggregateGroupBy

Configuration for grouping aggregated results by one or more case fields.

queryFilter

queryFilter: string

A search query to filter which cases are included in the aggregation. Uses the same syntax as the Case Management search bar.

Settings

Member Visibility

Theme

Generated using TypeDoc