Era.Common.DataDefinition.Reports.QueryUsageDefinition

Description

Each query usage definition defines valid combinations of symbols, which can be used in a report template.
Every report template refers exactly one query usage definition and has to respect this definition.

Properties

Name	JsonSchemaType	Description
filter_definition	array of references to Era.Common.DataDefinition.Filter.FilterDefinition	List of filters, which can be used in the report template.
is_internal	boolean	If true, user is allowed to use symbol combinations from this query usage definition to create report templates. Otherwise, the query usage definition is only for internal purposes.
query_usage_definition_id	integer	Unique ID of the query usage definition.
symbol_usage_definition	array of references to Era.Common.DataDefinition.Reports.QueryUsageDefinition_SymbolQueryUsageDefinition	List of symbols, which can be combined in a report template.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGetAllUsageDefinitionsResponse

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.QueryUsageDefinition",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.QueryUsageDefinition"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.QueryUsageDefinition": {
            "$ref": "#/definitions/QueryUsageDefinition"
        }
    },
    "definitions": {
        "QueryUsageDefinition": {
            "additionalProperties": false,
            "required": [
                "query_usage_definition_id"
            ],
            "type": "object",
            "properties": {
                "filter_definition": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Filter.FilterDefinition#/definitions/FilterDefinition"
                        }
                    ]
                },
                "is_internal": {
                    "type": "boolean"
                },
                "query_usage_definition_id": {
                    "type": "integer"
                },
                "symbol_usage_definition": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Reports.QueryUsageDefinition_SymbolQueryUsageDefinition#/definitions/QueryUsageDefinition_SymbolQueryUsageDefinition"
                        }
                    ]
                }
            }
        }
    }
}