notification.coms¶

Communications notification.¶

type	object
properties
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
isTemplateGeneratedByOspComposer	If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.
	type	boolean
moduleId	The id of the linked communications module
	type	string
accessedValues	The notification retrieves this list of values, which can subsequently be utilized within the message template.
	type	array
	default
	items	type	string
template	The template to use to generate the message
	TemplateConfiguration
additionalProperties	False

type	object
properties
shortMessageTemplateId	Define the template ID to use to generate the content of the sms.
	type	string
objectTemplateId	Define the template ID to use to generate the object of the email.
	type	string
longMessageTemplateId	Define the template ID to use to generate the body of the email.
	type	string
requestTimeout	he module ‘osp-report’ is responsible for generating notifications. In case this module is not available, a timeout feature is implemented to avoid endless waiting
	default	value	5
		unit	SECONDS
	DurationConfigurationEntity
retryDelay	The delay between retry to generate the notification with ‘osp-report’ module (after a failure).
	default	value	5
		unit	SECONDS
	DurationConfigurationEntity
locale	The locale to use when generating the messages.
	type	string
	enum	FRENCH, GERMAN, ITALIAN, ENGLISH, JAPANESE, KOREAN, CHINESE, SIMPLIFIED_CHINESE, TRADITIONAL_CHINESE, FRANCE, GERMANY, JAPAN, KOREA, UK, US, CANADA, CANADA_FRENCH
	default	FRENCH
additionalProperties	False

type	object
properties
value	The amount of time expressed with the unit
	type	integer
unit	The unit of time expressed with the value
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
additionalProperties	False