Era.Common.DataDefinition.Reports.PrintReportParameters

Description

Parameters for converting a generated report to .pdf/.ps or other form.

Properties

Name JsonSchemaType Description
color_mode enum of Era.Common.DataDefinition.Reports.PrintReportParameters_ColorMode Color mode of the document.
customization reference to Era.Common.DataDefinition.Reports.PrintReportParameters_ReportCustomization
dpi integer DPI of the document. Higher DPI causes the fonts to be smaller.
locale string Locale to be used for report generation. 4-letter ISO codes should be used, e.g. en_US.
output_format enum of Era.Common.DataDefinition.Reports.PrintReportParameters_OutputFormat Resulting type of document.
page_margins reference to Era.Common.DataDefinition.Reports.PrintReportParameters_PageMargins Page margins of the document.
page_orientation enum of Era.Common.DataDefinition.Reports.PrintReportParameters_PageOrientation Page orientation for the document.
page_size enum of Era.Common.DataDefinition.Reports.PrintReportParameters_PageSize Page size for the document.
timeZoneOffsetMinutes integer Time zone offset, used for report generation. If set, all times in the report will be moved by this offset. If not set, local ERA server time zone will be used.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Task.Server.GenerateReport_EmailTarget
Era.Common.DataDefinition.Task.Server.GenerateReport_FileSystemTarget
Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateFormattedReportRequest

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.PrintReportParameters",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.PrintReportParameters"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.PrintReportParameters": {
            "$ref": "#/definitions/PrintReportParameters"
        }
    },
    "definitions": {
        "PrintReportParameters": {
            "additionalProperties": false,
            "required": [
                "locale",
                "output_format"
            ],
            "type": "object",
            "properties": {
                "color_mode": {
                    "enum": [
                        0,
                        1
                    ]
                },
                "customization": {
                    "$ref": "Era.Common.DataDefinition.Reports.PrintReportParameters_ReportCustomization#/definitions/PrintReportParameters_ReportCustomization"
                },
                "dpi": {
                    "type": "integer"
                },
                "locale": {
                    "type": "string"
                },
                "output_format": {
                    "enum": [
                        0,
                        1,
                        2
                    ]
                },
                "page_margins": {
                    "$ref": "Era.Common.DataDefinition.Reports.PrintReportParameters_PageMargins#/definitions/PrintReportParameters_PageMargins"
                },
                "page_orientation": {
                    "enum": [
                        0,
                        1
                    ]
                },
                "page_size": {
                    "enum": [
                        3,
                        4,
                        5,
                        13,
                        14,
                        15,
                        24,
                        25,
                        26,
                        27,
                        28,
                        29
                    ]
                },
                "timeZoneOffsetMinutes": {
                    "type": "integer"
                }
            }
        }
    }
}