Era.Common.DataDefinition.Task.Server.SendNotification

Description

Notification configuration.

Properties

Name	JsonSchemaType	Description
keyValuePairs	array of references to Era.Common.DataDefinition.Task.Server.SendNotification_KeyValuePair	Keys will be replaced with values (if provided) in SendSnmpTrap and SendMail body either.
locale	string	Locale of the notification.
sendMail	reference to Era.Common.DataDefinition.Task.Server.SendMail	Optional configuration for e-mail sending. Part of the field content will be moved soon to the limited variant in field sendMailConfiguration.
sendSnmpTrap	reference to Era.Common.DataDefinition.Task.Server.SendSnmpTrap	Optional configuration for SNMP trap sending.
sendSyslog	reference to Era.Common.DataDefinition.Task.Server.SendSyslog	Optional configuration for syslog sending.
send_email	reference to Era.Common.DataDefinition.Task.Server.SendNotification_SendMailConfiguration	Optional configuration for e-mail sending. This will become the one and only mail configuration field soon.
send_webhook	reference to Era.Common.DataDefinition.Task.Server.SendWebhook	Optional configuration for Webhook sending. It is supported only for the Cloud version of the product.
time_zone	reference to Era.Common.DataDefinition.Common.TimeZoneSelection	Time zone to be used for listing dates and times within the notification body.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Task.ServerTaskConfiguration
Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcCreateNotificationRequest
Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcGetNotificationResponse
Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcModifyNotificationRequest

JsonSchema

{
    "title": "Era.Common.DataDefinition.Task.Server.SendNotification",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Task.Server.SendNotification"
    ],
    "properties": {
        "Era.Common.DataDefinition.Task.Server.SendNotification": {
            "$ref": "#/definitions/SendNotification"
        }
    },
    "definitions": {
        "SendNotification": {
            "additionalProperties": false,
            "required": [
                "locale"
            ],
            "type": "object",
            "properties": {
                "keyValuePairs": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Task.Server.SendNotification_KeyValuePair#/definitions/SendNotification_KeyValuePair"
                        }
                    ]
                },
                "locale": {
                    "pattern": "\\s*.{1,}\\s*",
                    "type": "string"
                },
                "sendMail": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.SendMail#/definitions/SendMail"
                },
                "sendSnmpTrap": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.SendSnmpTrap#/definitions/SendSnmpTrap"
                },
                "sendSyslog": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.SendSyslog#/definitions/SendSyslog"
                },
                "send_email": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.SendNotification_SendMailConfiguration#/definitions/SendNotification_SendMailConfiguration"
                },
                "send_webhook": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.SendWebhook#/definitions/SendWebhook"
                },
                "time_zone": {
                    "$ref": "Era.Common.DataDefinition.Common.TimeZoneSelection#/definitions/TimeZoneSelection"
                }
            }
        }
    }
}