Era.Common.DataDefinition.Reports.Report

Description

Structure to store a generated report.

Properties

Name JsonSchemaType Description
data reference to Era.Common.DataDefinition.Reports.Report_Data Data of the generated report.
drilldown reference to Era.Common.DataDefinition.Reports.Report_Drilldown Drilldown possibilities for the generated report.
label string Name of the report. Typically taken from the report template.
license string Deprecated, do not use.
nested_report array of references to Era.Common.DataDefinition.Reports.Report Deprecated, do not use.
rendering reference to Era.Common.DataDefinition.Reports.Report_Rendering Rendering instructions for the generated report. This is copied from [ReportTemplate] used to generate the report.
report_id reference to Era.Common.DataDefinition.Common.Uuid Deprecated, do not use. ID of the report.
report_template_static_object_identification reference to Era.Common.DataDefinition.StaticObject.StaticObjectIdentification If the report was generated from a report template stored in the database, this is the ID of the template.
server_id reference to Era.Common.DataDefinition.Common.Uuid UUID of the server, where the report was generated.
server_name string Name of the server, where the report was generated.
time_prep integer Duration of report generation in database in milliseconds. (Report serialization and transfer time is not included.)
time_start reference to Era.Common.DataDefinition.Common.UTCTime Time when the report generation was started.
timestamp integer Deprecated, do not use.
version_guard integer Version guard for all static objects contained within the generated report. If performing actions on static objects from the report, always use this version guard.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Reports.Report
Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateReportResponse

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.Report",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.Report"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.Report": {
            "$ref": "#/definitions/Report"
        }
    },
    "definitions": {
        "Report": {
            "additionalProperties": false,
            "required": [
                "data",
                "label",
                "license",
                "report_id",
                "server_id",
                "server_name",
                "time_prep",
                "time_start"
            ],
            "type": "object",
            "properties": {
                "data": {
                    "$ref": "Era.Common.DataDefinition.Reports.Report_Data#/definitions/Report_Data"
                },
                "drilldown": {
                    "$ref": "Era.Common.DataDefinition.Reports.Report_Drilldown#/definitions/Report_Drilldown"
                },
                "label": {
                    "type": "string"
                },
                "license": {
                    "type": "string"
                },
                "nested_report": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Reports.Report#/definitions/Report"
                        }
                    ]
                },
                "rendering": {
                    "$ref": "Era.Common.DataDefinition.Reports.Report_Rendering#/definitions/Report_Rendering"
                },
                "report_id": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                },
                "report_template_static_object_identification": {
                    "$ref": "Era.Common.DataDefinition.StaticObject.StaticObjectIdentification#/definitions/StaticObjectIdentification"
                },
                "server_id": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                },
                "server_name": {
                    "type": "string"
                },
                "time_prep": {
                    "type": "integer"
                },
                "time_start": {
                    "$ref": "Era.Common.DataDefinition.Common.UTCTime#/definitions/UTCTime"
                },
                "timestamp": {
                    "type": "integer"
                },
                "version_guard": {
                    "type": "integer"
                }
            }
        }
    }
}