Era.Common.DataDefinition.Reports.QueryUsageDefinition_SymbolQueryUsageDefinition

Description

Information about how a symbol may be used in a report template.

Properties

Name	JsonSchemaType	Description
is_visible	boolean	If true, user can see this symbol during report template creation. Otherwise, the symbol is only for internal purposes.
is_x	boolean	Deprecated, do not use.
sorted	boolean	This symbol can be used for sorting. Only symbols, which are actually added to the data part of a report template may be used for sorting.
symbol_id	integer	ID of the symbol.
vector	boolean	Deprecated, do not use. True if the result may have more than one row, false if there is always at most (or exactly) one value in the result.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Reports.QueryUsageDefinition

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.QueryUsageDefinition_SymbolQueryUsageDefinition",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.QueryUsageDefinition_SymbolQueryUsageDefinition"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.QueryUsageDefinition_SymbolQueryUsageDefinition": {
            "$ref": "#/definitions/QueryUsageDefinition_SymbolQueryUsageDefinition"
        }
    },
    "definitions": {
        "QueryUsageDefinition_SymbolQueryUsageDefinition": {
            "additionalProperties": false,
            "required": [
                "is_x",
                "sorted",
                "symbol_id",
                "vector"
            ],
            "type": "object",
            "properties": {
                "is_visible": {
                    "type": "boolean"
                },
                "is_x": {
                    "type": "boolean"
                },
                "sorted": {
                    "type": "boolean"
                },
                "symbol_id": {
                    "type": "integer"
                },
                "vector": {
                    "type": "boolean"
                }
            }
        }
    }
}