# GroupFilterCriteria

The unit that composes the list used for Groups searching

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**field** | **string** | The fields to perform the search. They can be native (one from the provided list) or otherwise can specify a custom field definition using the format [customFieldSetId].[customFieldId].  | [default to undefined]
**operator** | **string** | | **Operator**                | **Affected values**  | **Available for**                                                    | |---------------               |----------------------|----------------------------------------------------------------------| | EQUALS                       | ONE_VALUE            | BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY        | | EQUALS_CASE_SENSITIVE        | ONE_VALUE            | BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY     | | MORE_THAN                    | ONE_VALUE            | BIG_DECIMAL,NUMBER,MONEY                                             | | LESS_THAN                    | ONE_VALUE            | BIG_DECIMAL,NUMBER,MONEY                                             | | BETWEEN                      | TWO_VALUES           | BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_TIME                              | | ON                           | ONE_VALUE            | DATE,DATE_TIME                                                       | | AFTER                        | ONE_VALUE            | DATE,DATE_TIME                                                       | | BEFORE                       | ONE_VALUE            | DATE,DATE_TIME                                                       | | BEFORE_INCLUSIVE             | ONE_VALUE            | DATE,DATE_TIME                                                       | | STARTS_WITH                  | ONE_VALUE            | STRING                                                               | | STARTS_WITH_CASE_SENSITIVE   | ONE_VALUE            | STRING                                                               | | IN                           | LIST                 | ENUM,KEY                                                             | | TODAY                        | NO_VALUE             | DATE,DATE_TIME                                                       | | THIS_WEEK                    | NO_VALUE             | DATE,DATE_TIME                                                       | | THIS_MONTH                   | NO_VALUE             | DATE,DATE_TIME                                                       | | THIS_YEAR                    | NO_VALUE             | DATE,DATE_TIME                                                       | | LAST_DAYS                    | ONE_VALUE            | NUMBER                                                               | | EMPTY                        | NO_VALUE             | BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME | | NOT_EMPTY                    | NO_VALUE             | BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME | | [default to undefined]
**secondValue** | **string** | The second value to match the searching criteria, when the `BETWEEN` operator is used. | [optional] [default to undefined]
**value** | **string** | The value to match the searching criteria. | [optional] [default to undefined]
**values** | **Array<string>** | List of values when the `IN` operator is used. | [optional] [default to undefined]

## Example

```typescript
import { GroupFilterCriteria } from './api';

const instance: GroupFilterCriteria = {
    field,
    operator,
    secondValue,
    value,
    values,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)