Era.Common.DataDefinition.Reports.Report_Data_Column_Header

Description

Column header, informations regarding the whole column.

Properties

Name JsonSchemaType Description
column_id integer ID of the column. This number is copied from report template to allow identifying of the resulting data column. It is referenced from [Report.rendering] and can be any number, but has to be unique in the report (i.e. unique in the [used_symbol] list).
link reference to Era.Common.DataDefinition.Reports.Link Used when displaying context menus above reports and for other interaction with report data.
symbol_id integer ID of the symbol in this column. Ideally, should not be used for rendering, only for interactivity.
type enum of Era.Common.DataDefinition.Reports.Report_Data_Column_Type Data type of the column. Treat this field as required. Optional only because of forward compatibility.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Reports.Report_Data_Column

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.Report_Data_Column_Header",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.Report_Data_Column_Header"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.Report_Data_Column_Header": {
            "$ref": "#/definitions/Report_Data_Column_Header"
        }
    },
    "definitions": {
        "Report_Data_Column_Header": {
            "additionalProperties": false,
            "required": [
                "column_id"
            ],
            "type": "object",
            "properties": {
                "column_id": {
                    "type": "integer"
                },
                "link": {
                    "$ref": "Era.Common.DataDefinition.Reports.Link#/definitions/Link"
                },
                "symbol_id": {
                    "type": "integer"
                },
                "type": {
                    "enum": [
                        12,
                        0,
                        1,
                        2,
                        3,
                        4,
                        7,
                        8,
                        9,
                        10,
                        11,
                        13,
                        14,
                        15,
                        16,
                        17,
                        18,
                        19,
                        20,
                        21,
                        22,
                        23
                    ]
                }
            }
        }
    }
}