Create a communication template
post
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the communication template. -
AlertEnd: string
(date-time)
Title:
Alert End Date
The last date that an alert appears. -
AlertStart: string
(date-time)
Title:
Alert Start Date
The first date that an alert appears. -
AttachmentKeyReference: string
Title:
Attachment Key Reference
Maximum Length:256
The attachment key references. -
AttachmentsEnabled: string
Title:
Enabled
Maximum Length:1
Indicates whether attachments are enabled for the communication template. -
BccEmailAddress: string
Title:
Bcc Email Address
The blind copied recipient addresses for email communications. -
Body: string
(byte)
Title:
Message Body
The communication message body text. -
CcEmailAddress: string
Title:
Cc Email Address
The copied recipient addresses for email communications. -
ChannelType: string
Title:
Channel Type
Maximum Length:30
The communication message channel type. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments entered by the user. -
DefaultLanguage: string
Title:
Default Language
Maximum Length:4
The default language for the communication template. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the communication template is available to be used. The default value is false. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress: string
Title:
From Address
Maximum Length:256
The sender of the communication message. -
MessageDeleteAllowed: boolean
Maximum Length:
1
Indicates whether the notifications generated by the template can be deleted from a user's notification list. -
MimeType: string
Title:
MIME Type
Maximum Length:30
The MIME type of communication message. The possible values are HTML and Text. -
Priority: string
Title:
Priority
Maximum Length:1
The priority of the notification. -
ShortMessage: string
Title:
Short Message
Maximum Length:500
The short text message body. -
Subject: string
Title:
Subject
Maximum Length:1000
The subject of the communication message. -
TemplateAttachmentAttributes: string
Title:
Attachment Key Reference
Maximum Length:900
Attachment attributes required to generate reports. -
TemplateAttData: string
Maximum Length:
255
The attachment details of the template. -
TemplateCode: string
Title:
Template Code
Maximum Length:32
The unique code of the communication template. -
TemplateId: integer
(int64)
Title:
Template ID
The unique identifier of the communication template. This ID is generated automatically by the application. -
TemplateName: string
Title:
Template Name
Maximum Length:100
The name of the communication template. -
ToEmailAddress: string
Title:
To Email Address
The primary recipient addresses for email communications. -
ToPhoneNumber: string
Title:
To Phone Number
The recipient phone number for text communications. -
ToUserid: string
Title:
To User ID
The recipient user ID for notifications. -
Visibility: string
Title:
Visibility
Maximum Length:30
Visibility option of the communication message generated by the template.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorCommunicationTemplates-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the communication template. -
AlertEnd: string
(date-time)
Title:
Alert End Date
The last date that an alert appears. -
AlertStart: string
(date-time)
Title:
Alert Start Date
The first date that an alert appears. -
AttachmentKeyReference: string
Title:
Attachment Key Reference
Maximum Length:256
The attachment key references. -
AttachmentsEnabled: string
Title:
Enabled
Maximum Length:1
Indicates whether attachments are enabled for the communication template. -
BccEmailAddress: string
Title:
Bcc Email Address
The blind copied recipient addresses for email communications. -
Body: string
(byte)
Title:
Message Body
The communication message body text. -
CcEmailAddress: string
Title:
Cc Email Address
The copied recipient addresses for email communications. -
ChannelType: string
Title:
Channel Type
Maximum Length:30
The communication message channel type. -
ChannelTypeMeaning: string
Title:
Channel Type
Read Only:true
Maximum Length:80
The channel type for the communication template. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments entered by the user. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the communication template. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the communication template was created. -
DefaultLanguage: string
Title:
Default Language
Maximum Length:4
The default language for the communication template. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the communication template is available to be used. The default value is false. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress: string
Title:
From Address
Maximum Length:256
The sender of the communication message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date that the communication template was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the communication template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDeleteAllowed: boolean
Maximum Length:
1
Indicates whether the notifications generated by the template can be deleted from a user's notification list. -
MimeType: string
Title:
MIME Type
Maximum Length:30
The MIME type of communication message. The possible values are HTML and Text. -
MimeTypeMeaning: string
Title:
Mime Type
Read Only:true
Maximum Length:80
The MIME type of the communication template. The possible values are HTML and Text. -
Priority: string
Title:
Priority
Maximum Length:1
The priority of the notification. -
ShortMessage: string
Title:
Short Message
Maximum Length:500
The short text message body. -
Subject: string
Title:
Subject
Maximum Length:1000
The subject of the communication message. -
TemplateAttachmentAttributes: string
Title:
Attachment Key Reference
Maximum Length:900
Attachment attributes required to generate reports. -
TemplateAttData: string
Maximum Length:
255
The attachment details of the template. -
TemplateCode: string
Title:
Template Code
Maximum Length:32
The unique code of the communication template. -
TemplateId: integer
(int64)
Title:
Template ID
The unique identifier of the communication template. This ID is generated automatically by the application. -
TemplateName: string
Title:
Template Name
Maximum Length:100
The name of the communication template. -
ToEmailAddress: string
Title:
To Email Address
The primary recipient addresses for email communications. -
ToPhoneNumber: string
Title:
To Phone Number
The recipient phone number for text communications. -
ToUserid: string
Title:
To User ID
The recipient user ID for notifications. -
Visibility: string
Title:
Visibility
Maximum Length:30
Visibility option of the communication message generated by the template. -
VisibilityMeaning: string
Title:
Visibility
Read Only:true
Maximum Length:80
Visibility option of the communication message generated by template.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.