1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Email Templates

Get all email templates

get

/crmRestApi/resources/11.13.18.05/emailTemplates

Request

Query Parameters
  • 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).
  • 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
  • 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

    • PrimaryKey Find an email template with the specified primary key.
      Finder Variables
      • TemplateId; integer; The primary key of an email template.
    • TemplateNumberFinder Finds an email template with the specified alternate key.
      Finder Variables
      • TemplateNumber; string; The unique identifier of an email template.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CreationDate; string; The date and time when the email template was created.
    • ObjectCode; string; The object code for which an email template is created for.
    • TemplateActiveFlag; boolean; Indicates whether an email template is active or inactive.
    • TemplateDescription; string; The description of an email template.
    • TemplateId; integer; The primary key of an email template.
    • TemplateName; string; The name of an email template.
    • TemplateNumber; string; The alternate key of an email template.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : emailTemplates
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : emailTemplates-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Email Template Translations
Type: array
Title: Email Template Translations
The email template translations resource is used to view, create, update, and delete the email template translations.
Show Source
Nested Schema : Email Template Usages
Type: array
Title: Email Template Usages
Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.
Show Source
Nested Schema : emailTemplates-Attachments-item-response
Type: object
Show Source
Nested Schema : emailTemplates-EmailTemplateTranslations-item-response
Type: object
Show Source
Nested Schema : emailTemplates-EmailTemplateUsages-item-response
Type: object
Show Source
Links
getMergedEmailContent
This method evaluates all the tokens for the given template with the object key.
Back to Top

Examples

The following example shows how to get all email templates by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "TemplateId": 300100570838829,
            "TemplateNumber": "MSGT-1000",
            "TemplateName": "Opty email test in opty page 01",
            "TemplateDescription": "Opty email test in opty page",
            "ObjectCode": "Opportunity",
            "TemplateActiveFlag": true,
            "EmailFormat": "HTML",
            "EmailSubject": "{{$Name$}} is create on {{$OptyCreatedBy$}}",
            "CreatedBy": "MHoope",
            "CreationDate": "2023-02-14T10:00:40+00:00",
            "LastUpdatedBy": "MHoope",
            "LastUpdateDate": "2023-02-14T10:00:40.750+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-1000",
                    "name": "emailTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-1000",
                    "name": "emailTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-1000/child/EmailTemplateTranslations",
                    "name": "EmailTemplateTranslations",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-1000/enclosure/EmailBody",
                    "name": "EmailBody",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates",
            "name": "emailTemplates",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/action/getMergedEmailContent",
            "name": "getMergedEmailContent",
            "kind": "other"
        }
    ]
}
Back to Top