Era.Common.DataDefinition.Reports.ReportTemplate_Data

Description

Instruction about how to generate the report data.

Properties

Name	JsonSchemaType	Description
console_path	string	webconsole path, where was template created.
filter	array of references to Era.Common.DataDefinition.Filter.Filter	Filters, which should be used during report generation.
incremental	boolean	If true, the report was already requested before, thus [rendering] does not have to be included in the resulting report.
query_usage_definition_id	integer	ID of the [QueryUsageDefinition], which was used to create and verify this template.
sorting	array of references to Era.Common.DataDefinition.Reports.Sorting	Requested sorting of the report. Only symbols, which are added to [used_symbol] can be used for sorting.
used_symbol	array of references to Era.Common.DataDefinition.Reports.ReportTemplate_Data_UsedSymbol	List of symbols, which should form the data columns of the resulting reports. Additional data columns may be added automatically during the report gneration process.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Reports.ReportTemplate

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.ReportTemplate_Data",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.ReportTemplate_Data"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.ReportTemplate_Data": {
            "$ref": "#/definitions/ReportTemplate_Data"
        }
    },
    "definitions": {
        "ReportTemplate_Data": {
            "additionalProperties": false,
            "required": [
                "query_usage_definition_id"
            ],
            "type": "object",
            "properties": {
                "console_path": {
                    "type": "string"
                },
                "filter": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Filter.Filter#/definitions/Filter"
                        }
                    ]
                },
                "incremental": {
                    "type": "boolean"
                },
                "query_usage_definition_id": {
                    "type": "integer"
                },
                "sorting": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Reports.Sorting#/definitions/Sorting"
                        }
                    ]
                },
                "used_symbol": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Reports.ReportTemplate_Data_UsedSymbol#/definitions/ReportTemplate_Data_UsedSymbol"
                        }
                    ]
                }
            }
        }
    }
}