Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem

Description

One item in a drilldown menu.
Based on this item, new report template should be generated and sent to the server to generate the drilldown report.

Properties

Name JsonSchemaType Description
all_filters boolean True if the drilldown covers all filters from the original report and filters, which should be added. If false, the report may display more information than requested.
all_symbols boolean True if the drilldown covers all symbols from the original report. If false, the user may miss some information in the drilldown report.
drilldown_type enum of Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem_DrilldownType Type of drilldown.
filter_list array of references to Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem_Filter List of filters, which can be added to the drilldown report. Concrete filters are generated based on what the user clicked on.
origin_filter_list array of references to Era.Common.DataDefinition.Filter.Filter Filters of the original report. Should be copied to the drilldown report, while translating symbol IDs based on [filter_list].
query_usage_definition_id integer Query usage definition for the new report template.
reference_filter reference to Era.Common.DataDefinition.Filter.CompositeFilter If present, the [reference_filter] should be evaluated for clicked row. If the result of the [reference_filter] is false, then this drilldown item should not be offered.
reference_symbol_id integer If present, filter for this symbol shoulf be always added to the resulting report.
sorting array of references to Era.Common.DataDefinition.Reports.Sorting Original report sorting.
symbol_list array of references to Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem_Symbol List of symbols to be added to the drilldown report.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Reports.Report_Drilldown

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem": {
            "$ref": "#/definitions/Report_Drilldown_DrilldownItem"
        }
    },
    "definitions": {
        "Report_Drilldown_DrilldownItem": {
            "additionalProperties": false,
            "required": [
                "drilldown_type",
                "query_usage_definition_id"
            ],
            "type": "object",
            "properties": {
                "all_filters": {
                    "type": "boolean"
                },
                "all_symbols": {
                    "type": "boolean"
                },
                "drilldown_type": {
                    "enum": [
                        1,
                        2,
                        3,
                        4
                    ]
                },
                "filter_list": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem_Filter#/definitions/Report_Drilldown_DrilldownItem_Filter"
                        }
                    ]
                },
                "origin_filter_list": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Filter.Filter#/definitions/Filter"
                        }
                    ]
                },
                "query_usage_definition_id": {
                    "type": "integer"
                },
                "reference_filter": {
                    "$ref": "Era.Common.DataDefinition.Filter.CompositeFilter#/definitions/CompositeFilter"
                },
                "reference_symbol_id": {
                    "type": "integer"
                },
                "sorting": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Reports.Sorting#/definitions/Sorting"
                        }
                    ]
                },
                "symbol_list": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem_Symbol#/definitions/Report_Drilldown_DrilldownItem_Symbol"
                        }
                    ]
                }
            }
        }
    }
}