Get all communication templates
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- CommunicationTemplatesAltKey: Finds a communication template that matches specified alternate key criteria.
Finder Variables:- TemplateCode; string; The unique code of the communication template.
- PrimaryKey: Finds a communication template that matches the specified primary key criteria.
Finder Variables:- TemplateId; integer; The unique identifier of the communication template.
- simpleSearchFinder: Finds a communication template with the specified key word.
Finder Variables:- value; string; The key word used to find a communication template such as template name or channel type.
- CommunicationTemplatesAltKey: Finds a communication template that matches specified alternate key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The unique identifier of the agency associated with the communication template.
- AlertEnd; string; The last date that an alert appears.
- AlertStart; string; The first date that an alert appears.
- AttachmentKeyReference; string; The attachment key references.
- AttachmentsEnabled; string; Indicates whether attachments are enabled for the communication template.
- BccEmailAddress; string; The blind copied recipient addresses for email communications.
- CcEmailAddress; string; The copied recipient addresses for email communications.
- ChannelType; string; The communication message channel type.
- ChannelTypeMeaning; string; The channel type for the communication template.
- Comments; string; The comments entered by the user.
- CreatedBy; string; The user who created the communication template.
- CreationDate; string; The date and time that the communication template was created.
- DefaultLanguage; string; The default language for the communication template.
- EnabledFlag; boolean; Indicates whether the communication template is available to be used. The default value is false.
- EventId; integer; The unique identifier for the communication event.
- FromAddress; string; The sender of the communication message.
- LastUpdateDate; string; The date that the communication template was last updated.
- LastUpdatedBy; string; The user who last updated the communication template.
- MessageDeleteAllowed; boolean; Indicates whether the notifications generated by the template can be deleted from a user's notification list.
- MimeType; string; The MIME type of communication message. The possible values are HTML and Text.
- MimeTypeMeaning; string; The MIME type of the communication template. The possible values are HTML and Text.
- Priority; string; The priority of the notification.
- ShortMessage; string; The short text message body.
- Subject; string; The subject of the communication message.
- TemplateAttData; string; The attachment details of the template.
- TemplateCode; string; The unique code of the communication template.
- TemplateId; integer; The unique identifier of the communication template. This ID is generated automatically by the application.
- TemplateName; string; The name of the communication template.
- ToEmailAddress; string; The primary recipient addresses for email communications.
- ToPhoneNumber; string; The recipient phone number for text communications.
- ToUserid; string; The recipient user ID for notifications.
- Visibility; string; Visibility option of the communication message generated by the template.
- VisibilityMeaning; string; Visibility option of the communication message generated by template.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.