Create a communication template
post
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCommunicationTemplates-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the communication template. -
AlertEnd(optional):
string(date-time)
Title:
Alert End Date
The last date that an alert appears. -
AlertStart(optional):
string(date-time)
Title:
Alert Start Date
The first date that an alert appears. -
AttachmentKeyReference(optional):
string
Title:
Attachment Key Reference
Maximum Length:256
The attachment key references. -
AttachmentsEnabled(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether attachments are enabled for the communication template. -
BccEmailAddress(optional):
string
Title:
Bcc Email Address
The blind copied recipient addresses for email communications. -
Body(optional):
string
Title:
Message Body
The communication message body text. -
CcEmailAddress(optional):
string
Title:
Cc Email Address
The copied recipient addresses for email communications. -
ChannelType(optional):
string
Title:
Channel Type
Maximum Length:30
The communication message channel type. -
ChannelTypeMeaning(optional):
string
Title:
Channel Type
Maximum Length:80
The channel type for the communication template. -
Comments(optional):
string
Title:
Comments
Maximum Length:1000
The comments entered by the user. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the communication template. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the communication template was created. -
DefaultLanguage(optional):
string
Title:
Default Language
Maximum Length:4
The default language for the communication template. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the communication template is available to be used. The default value is false. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress(optional):
string
Title:
From Address
Maximum Length:256
The sender of the communication message. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the communication template was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the communication template. -
links(optional):
array Items
Title:
Items
Link Relations -
MessageDeleteAllowed(optional):
boolean
Indicates whether the notifications generated by the template can be deleted from a user's notification list.
-
MimeType(optional):
string
Title:
MIME Type
Maximum Length:30
The MIME type of communication message. The possible values are HTML and Text. -
MimeTypeMeaning(optional):
string
Title:
Mime Type
Maximum Length:80
The MIME type of the communication template. The possible values are HTML and Text. -
Priority(optional):
string
Title:
Priority
Maximum Length:1
The priority of the notification. -
ShortMessage(optional):
string
Title:
Short Message
Maximum Length:500
The short text message body. -
Subject(optional):
string
Title:
Subject
Maximum Length:1000
The subject of the communication message. -
TemplateCode(optional):
string
Title:
Template Code
Maximum Length:32
The unique code of the communication template. -
TemplateId(optional):
integer(int64)
Title:
Template ID
The unique identifier of the communication template. This ID is generated automatically by the application. -
TemplateName(optional):
string
Title:
Template Name
Maximum Length:100
The name of the communication template. -
ToEmailAddress(optional):
string
Title:
To Email Address
The primary recipient addresses for email communications. -
ToPhoneNumber(optional):
string
Title:
To Phone Number
The recipient phone number for text communications. -
ToUserid(optional):
string
Title:
To User ID
The recipient user ID for notifications. -
Visibility(optional):
string
Title:
Visibility
Maximum Length:30
Visibility option of the communication message generated by the template. -
VisibilityMeaning(optional):
string
Title:
Visibility
Maximum Length:80
Visibility option of the communication message generated by template.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCommunicationTemplates-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the communication template. -
AlertEnd(optional):
string(date-time)
Title:
Alert End Date
The last date that an alert appears. -
AlertStart(optional):
string(date-time)
Title:
Alert Start Date
The first date that an alert appears. -
AttachmentKeyReference(optional):
string
Title:
Attachment Key Reference
Maximum Length:256
The attachment key references. -
AttachmentsEnabled(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether attachments are enabled for the communication template. -
BccEmailAddress(optional):
string
Title:
Bcc Email Address
The blind copied recipient addresses for email communications. -
Body(optional):
string
Title:
Message Body
The communication message body text. -
CcEmailAddress(optional):
string
Title:
Cc Email Address
The copied recipient addresses for email communications. -
ChannelType(optional):
string
Title:
Channel Type
Maximum Length:30
The communication message channel type. -
ChannelTypeMeaning(optional):
string
Title:
Channel Type
Maximum Length:80
The channel type for the communication template. -
Comments(optional):
string
Title:
Comments
Maximum Length:1000
The comments entered by the user. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the communication template. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the communication template was created. -
DefaultLanguage(optional):
string
Title:
Default Language
Maximum Length:4
The default language for the communication template. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the communication template is available to be used. The default value is false. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress(optional):
string
Title:
From Address
Maximum Length:256
The sender of the communication message. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the communication template was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the communication template. -
links(optional):
array Items
Title:
Items
Link Relations -
MessageDeleteAllowed(optional):
boolean
Indicates whether the notifications generated by the template can be deleted from a user's notification list.
-
MimeType(optional):
string
Title:
MIME Type
Maximum Length:30
The MIME type of communication message. The possible values are HTML and Text. -
MimeTypeMeaning(optional):
string
Title:
Mime Type
Maximum Length:80
The MIME type of the communication template. The possible values are HTML and Text. -
Priority(optional):
string
Title:
Priority
Maximum Length:1
The priority of the notification. -
ShortMessage(optional):
string
Title:
Short Message
Maximum Length:500
The short text message body. -
Subject(optional):
string
Title:
Subject
Maximum Length:1000
The subject of the communication message. -
TemplateCode(optional):
string
Title:
Template Code
Maximum Length:32
The unique code of the communication template. -
TemplateId(optional):
integer(int64)
Title:
Template ID
The unique identifier of the communication template. This ID is generated automatically by the application. -
TemplateName(optional):
string
Title:
Template Name
Maximum Length:100
The name of the communication template. -
ToEmailAddress(optional):
string
Title:
To Email Address
The primary recipient addresses for email communications. -
ToPhoneNumber(optional):
string
Title:
To Phone Number
The recipient phone number for text communications. -
ToUserid(optional):
string
Title:
To User ID
The recipient user ID for notifications. -
Visibility(optional):
string
Title:
Visibility
Maximum Length:30
Visibility option of the communication message generated by the template. -
VisibilityMeaning(optional):
string
Title:
Visibility
Maximum Length:80
Visibility option of the communication message generated by template.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.