Era.Common.DataDefinition.Filter.Filter

Description

A single filter, in the form of (symbol, operator, operand), e.g. "Computer name = 'xyz'", where "Computer name" is the symbol, "=" is the operator and "xyz" is the operand.

Properties

Name	JsonSchemaType	Description
negation_operand	reference to Era.Common.DataDefinition.Common.MultiDataType	The (second) operand of the filter used in case of operator negation. Don't use for reports. Type of data set in negation_operand must be same as type of symbol's data and must be set only if operation negation must be performed. Also operand above must be set to empty data.
operand	reference to Era.Common.DataDefinition.Common.MultiDataType	The (second) operand of the filter. Type of data set in operand must be same as type of symbol's data. If you want to negate operator used, then set this operand to empty data and fill in negation_operand below.
symbol_id	integer	ID of the symbol to be used for comparison (i.e. the first operand of the filter).
used_operator	enum of Era.Common.DataDefinition.Filter.FilterDefinition_Operators	Operator to be applied to the symbol and operand.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Filter.CompositeFilter
Era.Common.DataDefinition.Reports.ReportTemplate_Data
Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem
Era.Common.DataDefinition.Trigger.Server.StateTrigger

JsonSchema

{
    "title": "Era.Common.DataDefinition.Filter.Filter",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Filter.Filter"
    ],
    "properties": {
        "Era.Common.DataDefinition.Filter.Filter": {
            "$ref": "#/definitions/Filter"
        }
    },
    "definitions": {
        "Filter": {
            "additionalProperties": false,
            "required": [
                "operand",
                "symbol_id",
                "used_operator"
            ],
            "type": "object",
            "properties": {
                "negation_operand": {
                    "$ref": "Era.Common.DataDefinition.Common.MultiDataType#/definitions/MultiDataType"
                },
                "operand": {
                    "$ref": "Era.Common.DataDefinition.Common.MultiDataType#/definitions/MultiDataType"
                },
                "symbol_id": {
                    "type": "integer"
                },
                "used_operator": {
                    "enum": [
                        0,
                        1,
                        2,
                        3,
                        4,
                        5,
                        6,
                        7,
                        8,
                        9,
                        10,
                        11,
                        12,
                        14,
                        15,
                        16,
                        17,
                        18,
                        19
                    ]
                }
            }
        }
    }
}