Get a communication template
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}
Request
Path Parameters
-
TemplateId: integer
The unique identifier of the communication template. This ID is generated automatically by the application.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.