Era.Common.DataDefinition.Filter.FilterDefinition
Description
Definition of a filter. This is not an actual filter, but defines, how a [Filter] can be made.
Properties
| Name |
JsonSchemaType |
Description |
| allowed_operators |
array of enum |
List of operands available for the filter. |
| is_repeated |
boolean |
If true, the filter can be used multiple times in an expression to satisfy this filter definition. |
| is_required |
boolean |
If true, the filter has to be used at least once in an expression to satisfy this filter definition. |
| is_visible |
boolean |
If false, this filter should not be visible for the user. |
| symbol_id |
integer |
ID of the symbol to be used as first operand. |
Dual message (request/response)
No dual message.Referenced in messages
Era.Common.DataDefinition.Reports.QueryUsageDefinition
Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetAllFilterDefinitionsResponse
Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetStateTriggerDetailsResponse_IdFilterDefinitionPair
JsonSchema
{
"title": "Era.Common.DataDefinition.Filter.FilterDefinition",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"required": [
"Era.Common.DataDefinition.Filter.FilterDefinition"
],
"properties": {
"Era.Common.DataDefinition.Filter.FilterDefinition": {
"$ref": "#/definitions/FilterDefinition"
}
},
"definitions": {
"FilterDefinition": {
"additionalProperties": false,
"required": [
"is_repeated",
"is_required",
"symbol_id"
],
"type": "object",
"properties": {
"allowed_operators": {
"type": "array",
"items": [
{
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
14,
15,
16,
17,
18,
19
]
}
]
},
"is_repeated": {
"type": "boolean"
},
"is_required": {
"type": "boolean"
},
"is_visible": {
"type": "boolean"
},
"symbol_id": {
"type": "integer"
}
}
}
}
}