Era.Common.DataDefinition.Reports.ReportTemplate

Description

Report template. The perscription on how to generate a report.
Should be created according to one of the [QueryUsageDefinition]s returned by the [RpcGetAllUsageDefinitionsRequest].

Properties

Name	JsonSchemaType	Description
data	reference to Era.Common.DataDefinition.Reports.ReportTemplate_Data	Instructions about how to generate the report data.
generate_drilldown	boolean	If true, additional data is added to the report, allowing to drill down into the report from UI.
rendering	reference to Era.Common.DataDefinition.Reports.Report_Rendering	Instructions about how the report should be displayed.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.NetworkMessage.ConsoleApi.Reports.RpcCreateReportTemplateRequest
Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateFormattedReportRequest
Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateReportRequest
Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGetReportTemplateResponse
Era.Common.NetworkMessage.ConsoleApi.Reports.RpcModifyReportTemplateRequest

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.ReportTemplate",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.ReportTemplate"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.ReportTemplate": {
            "$ref": "#/definitions/ReportTemplate"
        }
    },
    "definitions": {
        "ReportTemplate": {
            "additionalProperties": false,
            "required": [
                "data"
            ],
            "type": "object",
            "properties": {
                "data": {
                    "$ref": "Era.Common.DataDefinition.Reports.ReportTemplate_Data#/definitions/ReportTemplate_Data"
                },
                "generate_drilldown": {
                    "type": "boolean"
                },
                "rendering": {
                    "$ref": "Era.Common.DataDefinition.Reports.Report_Rendering#/definitions/Report_Rendering"
                }
            }
        }
    }
}