Era.Common.DataDefinition.Reports.Report_AggregationParameters

Description

Additional parameters for aggregation.
Currently, aggregation parameters are required for symbols with aggregation SA_X_INTERVAL and SA_X_INTERVAL_LIST.

Properties

Name JsonSchemaType Description
interval enum of Era.Common.DataDefinition.Reports.Report_AggregationParameters_TimeInterval Time interval granularity for SA_X_INTERVAL aggregation. Values are separated to intervals (e.g. 1 hour) and all values inside a single interval are merged.
interval_list array of references to Era.Common.DataDefinition.Reports.Report_AggregationParameters_TimeUnitPair Time units used for SA_X_INTERVAL_LIST aggregation. Values are separated to intervals of various length (e.g. last 1 day, 3 days, 7 days) and all values inside a single interval are merged.
The same TimeUnit has to be used for all items.
All intervals are in the past, relative to "now". So for example for intervals (1 day, 3 days, 7 days), the result will be separated to 5 groups: (now, -1day) (-1day, -3days) (-3days, -7days) (-7days, -inf) (other/no data).

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Reports.ReportTemplate_Data_UsedSymbol
Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem_Filter
Era.Common.DataDefinition.Reports.Report_Drilldown_DrilldownItem_Symbol

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.Report_AggregationParameters",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.Report_AggregationParameters"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.Report_AggregationParameters": {
            "$ref": "#/definitions/Report_AggregationParameters"
        }
    },
    "definitions": {
        "Report_AggregationParameters": {
            "additionalProperties": false,
            "type": "object",
            "properties": {
                "interval": {
                    "enum": [
                        1,
                        2,
                        3,
                        4
                    ]
                },
                "interval_list": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Reports.Report_AggregationParameters_TimeUnitPair#/definitions/Report_AggregationParameters_TimeUnitPair"
                        }
                    ]
                }
            }
        }
    }
}