Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateFormattedReportRequest

Description

Generates a report on server and offers it for downloading in .pdf/.csv format.

Properties

Name	JsonSchemaType	Description
reportFormat	reference to Era.Common.DataDefinition.Reports.PrintReportParameters	Parameters for report generating
reportName	string	Report name that will be used as title in generated reports
reportTemplate	reference to Era.Common.DataDefinition.Reports.ReportTemplate	the report template, for which the report should be generated.
reportTemplateUuid	reference to Era.Common.DataDefinition.Common.Uuid	UUID of a report template stored on server, for which the report should be generated.

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateFormattedReportResponse

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateFormattedReportRequest",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateFormattedReportRequest"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.Reports.RpcGenerateFormattedReportRequest": {
            "$ref": "#/definitions/RpcGenerateFormattedReportRequest"
        }
    },
    "definitions": {
        "RpcGenerateFormattedReportRequest": {
            "oneOf": [
                {
                    "required": [
                        "reportTemplate"
                    ]
                },
                {
                    "required": [
                        "reportTemplateUuid"
                    ]
                }
            ],
            "additionalProperties": false,
            "required": [
                "reportFormat"
            ],
            "type": "object",
            "properties": {
                "reportFormat": {
                    "$ref": "Era.Common.DataDefinition.Reports.PrintReportParameters#/definitions/PrintReportParameters"
                },
                "reportName": {
                    "pattern": "\\s*.{1,}\\s*",
                    "type": "string"
                },
                "reportTemplate": {
                    "$ref": "Era.Common.DataDefinition.Reports.ReportTemplate#/definitions/ReportTemplate"
                },
                "reportTemplateUuid": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                }
            }
        }
    }
}