Overview
Universal Controller supports the following RESTful-based web services for Email Template operations, which are listed alphabetically on this page.
- Create an Email Template
- Delete an Email Template
- List Email Template
- Modify an Email Template
- Read an Email Template
Formatting specifications for each web service, including details about property requirements, are provided.
Create an Email Template
|
Description |
---|---|
URI |
http://host_name/uc/resources/emailtemplate |
HTTP Method |
POST |
Description |
Creates an Email Template. |
Example URI |
http://localhost:8080/uc/resources/emailtemplate |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
n/a |
Example Request |
See Create an Email Template Example Request, below. |
Example Response |
|
Email Template Properties |
See Email Template Properties, below. |
Create an Email Template: Example Request
XML Request |
JSON Request |
---|---|
|
|
Email Template Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
BCC |
Email address of the party being sent a blind (hidden) copy of the email, if any. |
Use commas to separate multiple recipients. |
Y |
|
Body |
Text of the email message. |
|
Y |
|
CC |
Email address of the party being sent a copy of the email, if any. |
Use commas to separate multiple recipients. |
Y |
|
Email Connection |
Connection used for the Email Template. |
|
Y |
|
Description |
Description of this record. |
|
N |
|
n/a |
Universal Controller release that the record was exported from. |
read only | N |
|
n/a | Record table information. | read only | N |
|
Member of Business Services |
Business Services that this record belongs to. |
|
N |
|
Reply-To |
Email address of the sender. |
Use commas to separate multiple recipients. |
N |
|
Subject |
Subject line of the email. |
|
N |
|
n/a |
System ID field in the database for this Email Template record. |
Persisted only if retainSysIds is set to true. |
N |
|
Template Name |
Name used within the Controller to identify this resource. |
Maximum = 40 alphanumerics. |
Y |
|
To |
Email address of the recipient. |
Use commas to separate multiple recipients. |
Y |
Delete an Email Template
|
Description |
---|---|
URI |
|
HTTP Method |
DELETE |
Description |
Deletes an Email Template. |
URI Parameters |
See Delete an Email Template URI Parameters, below. |
Example URI |
http://localhost:8080/uc/resources/emailtemplate?templatename=Test4 |
Example Response |
|
Delete an Email Template: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this Email Template. |
String; URI parameter. |
Y |
|
|
Name used within the Controller to identify this Email Template. |
String; URI parameter. |
Y |
|
List Email Templates
|
Description |
---|---|
URI |
|
HTTP Method |
GET |
Description |
Retrieves information on all Email Templates. |
Example URI |
http://localhost:8080/uc/resources/emailtemplate/list |
Authentication |
HTTP Basic |
Consumes Content-Type |
n/a |
Produces Content-Type |
application/xml, application/json |
Example Response |
See List Email Templates Example Response, below. |
Email Template Properties |
List Email Templates: Example Response
XML Response |
JSON Response |
---|---|
|
|
Modify an Email Template
|
Description |
---|---|
URI |
|
HTTP Method |
PUT |
Description |
Modifies the Email Template specified by the |
Example URI |
|
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
n/a |
Example Request |
See Modify an Email Template Example Request, below. |
Email Template Properties |
|
Example Response |
|
Modify an Email Template: Example Request
XML Request |
JSON Request |
---|---|
|
|
Read an Email Template
URI |
http://host_name/uc/resources/emailtemplate |
HTTP Method |
GET |
Description |
Retrieves information on a specific Email Template. |
URI Parameters |
See Read an Email Template URI Parameters, below. |
Example URI |
http://localhost:8080/uc/resources/emailtemplate?templatename=Test4 |
Consumes Content-Type |
n/a |
Produces Content-Type |
application/xml, application/json |
Example Response |
See Read an Email Template Example Response, below. |
Email Template Properties |
Read an Email Template: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this Email Template. |
String; URI parameter. |
Y |
|
|
Name used within the Controller to identify this Email Template. |
String; URI parameter. |
Y |
|
Read an Email Template: Example Response
XML Response |
JSON Response |
---|---|
|
|