FilterComponent

Filter Component

Interface object to represent different filter types.

JSON Example

{
    "filter_field": "string",
    "filter_operation": "string",
    "value": "string"
}

Fields

filter_field

Optional

Constraints: default: METRIC_VALUE

The field options to filtering and sorting.

Possible values are : SITE_ID, NODE_ID, OBJ_ID, METRIC_VALUE, TIMESTAMP,

FilterOperations

filter_operation

Optional

Constraints: default: EQUAL

The filter operations. EQUAL, NOT_EQUAL, GREATER_THAN, GREATER_THAN_EQUAL, LESS_THAN, and LESS_THAN_EQUAL are applicable only when filtering on numeric values. Validations will be performed accordingly.

Possible values are : EQUAL, NOT_EQUAL, GREATER_THAN, GREATER_THAN_EQUAL, LESS_THAN, LESS_THAN_EQUAL,

string

value

Optional

Value to filter on.