Page Comparison

...

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.

...

	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	Status 200 /OK Successfully created the Email Template with sysId {sysId}. Status 400 /Bad Request Create Email Template failed. A duplicate value has been detected. Name must be unique.
Email Template Properties	See 5445207 Email Template Properties, below.

Anchor
Create an Email Template Example Request
Create an Email Template Example Request
Create an Email Template: Example Request

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	bcc - ET
	bcc - ET

bcc

BCC

Email address of the party being sent a blind (hidden) copy of the email, if any.

Use commas to separate multiple recipients.

Y
(unless cc or to
is specified)

Anchor

	body - ET
	body - ET

body

Body

Text of the email message.

Y

Anchor

	cc - ET
	cc - ET

cc

CC

Email address of the party being sent a copy of the email, if any.

Use commas to separate multiple recipients.

Y
(unless bcc or to
is specified)

Anchor

	connection - ET
	connection - ET

connection

Email Connection

Connection used for the Email Template.

Y

Anchor

	description - ET
	description - ET

description

Description

Description of this record.

N

Anchor

	opswiseGroups exportReleaseLevel - ETopswiseGroups
	exportReleaseLevel - ET

opswiseGroups

Member of Business Services

Business Services that this record belongs to.

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Use commas to

Anchor

	replyTo exportTable - ETreplyTo
	exportTable - ET

replyTo

Reply-To

Email address of the sender.

exportTable

n/a

Record table information.

read only

N

Anchor

	opswiseGroups - ET
	opswiseGroups - ET

opswiseGroups

Member of Business Services

Business Services that this record belongs to.

N

Anchor

	replyTo - ET
	replyTo - ET

replyTo

Reply-To

Email address of the sender.

Use commas to separate multiple recipients.

N

Anchor

	subject - ET
	subject - ET

subject

Subject

Subject line of the email.

N

Anchor

	sysId - ET
	sysId - ET

sysId

n/a

System ID field in the database for this Email Template record.

Persisted only if retainSysIds is set to true.

N

Anchor

	templateName - ET
	templateName - ET

templateName

Template Name

Name used within the Controller to identify this resource.

Maximum = 40 alphanumerics.

Y

Anchor

	to - ET
	to - ET

to

To

Email address of the recipient.

Use commas to separate multiple recipients.

Y
(unless cc or bcc
is specified)

...

	Description
URI	http://host_name/uc/resources/emailtemplate
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	Status 200 /OK Email Template deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `templatename` and `templateid` at the same time. Status 404 /Not Found An Email Template with {name/id} "test" does not exist.

...

	Description
URI	http://host_name/uc/resources/emailtemplate/list
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	See 5445207 Email Template Properties.

Anchor
List Email Templates Example Response
List Email Templates Example Response
List Email Templates: Example Response

XML Response

JSON Response

Expand

title	XML Response

<emailTemplates>
    <emailTemplate exportReleaseLevel="7.2.0.0" exportTable="ops_email_template" version="7">
         <bcc />
         <body>This is the body text.</body>
         <cc />
         <connection>QA #1</connection>
         <description />
         <opswiseGroups />
         <replyTo />
         <subject>SAP Task email</subject>
         <sysId>55b5d2a6176e4c499cbd43b0d4cc6515</sysId>
         <templateName>SAP Task email template</templateName>
         <to>doc@stonebranch.com</to>
    </emailTemplate>
    <emailTemplate exportReleaseLevel="7.2.0.0" exportTable="ops_email_template" version="2">
         <bcc />
         <body>This is the body text.</body>
         <cc />
         <connection>QA #2</connection>
         <description />
         <opswiseGroups />
         <replyTo />
         <subject>Email Task email</subject>
         <sysId>62701879a6264107bb757a952bcc65cc</sysId>
         <templateName>Email Task email template</templateName>
         <to>doc@stonebranch.com</to>
    </emailTemplate>
<emailTemplates>

Expand

title	JSON Response

[ {
    "bcc": null,
    "body": "This is the body text.",
    "cc": null,
    "connection": "QA #1",
    "description": null,
     "opswiseGroupsexportReleaseLevel": null,
    ""7.2.0.0",
    "exportTable": "ops_email_template",
    "opswiseGroups": null,
    "replyTo": null,
    "subject": "SAP Task email",
    "sysId": "55b5d2a6176e4c499cbd43b0d4cc6515",
    "templateName": "SAP Task email template",
    "to": "doc@stonebranch.com",
    "version": 7
    }
    {
    "bcc": null,
    "body": "This is the body text.",
    "cc": null,
    "connection": "QA #2",
    "description": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_email_template",
    "opswiseGroups": null,
    "replyTo": null,
    "subject": "Email Task email",
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "templateName": "Email Task email template",
    "to": "doc@stonebranch.com",
    "version": 2
    }
]

...

	Description
URI	http://host_name/uc/resources/emailtemplate
HTTP Method	PUT
Description	Modifies the Email Template specified by the `sysId`.
Example URI	http://localhost:8080/uc/resources/emailtemplate
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	See 5445207 Email Template Properties.
Example Response	Status 200 /OK Successfully updated the Email Template with sysId <sysId> to version <version>.

...

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	See 5445207 Email Template Properties.

Anchor
Read an Email Template URI Parameters
Read an Email Template URI Parameters
Read an Email Template: URI Parameters

...

Anchor
Read an Email Template Example Response
Read an Email Template Example Response
Read an Email Template: Example Response

<emailTemplate

XML Response

JSON Response

Expand

title	XML Response

JSON Response

Expand

title	XML Response

<emailTemplate exportReleaseLevel="7.2.0.0" exportTable="ops_email_template" retainSysIds="true" version="1">
    <bcc />
    <body>This is the body text.</body>
    <cc />
    <connection>QA #1</connection>
    <description />
    <opswiseGroups />
    <replyTo />
    <subject>SAP Task email</subject>
    <sysId>55b5d2a6176e4c499cbd43b0d4cc6515</sysId>
    <templateName>SAP Task email template</templateName>
    <to>doc@stonebranch.com</to>
</emailTemplate>

Expand

title	JSON Response

{
    "bcc": null,
    "body": "This is the body text.",
    "cc": null,
    "connection": "QA #1",
    "description": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_email_template",
    "opswiseGroups": null,
    "replyTo": null,
    "subject": "SAP Task email",
    "sysId": "55b5d2a6176e4c499cbd43b0d4cc6515",
    "templateName": "SAP Task email template",
    "to": "doc@stonebranch.com",
    "version": 1
}

...

Versions Compared

Old Version 1

New Version Current

Key

Anchor
Create an Email Template Example Request
Create an Email Template Example Request
Create an Email Template: Example Request

Anchor
List Email Templates Example Response
List Email Templates Example Response
List Email Templates: Example Response

Anchor
Read an Email Template URI Parameters
Read an Email Template URI Parameters
Read an Email Template: URI Parameters

Anchor
Read an Email Template Example Response
Read an Email Template Example Response
Read an Email Template: Example Response

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

AnchorCreate an Email Template Example RequestCreate an Email Template Example RequestCreate an Email Template: Example Request

AnchorList Email Templates Example ResponseList Email Templates Example ResponseList Email Templates: Example Response

AnchorRead an Email Template URI ParametersRead an Email Template URI ParametersRead an Email Template: URI Parameters

AnchorRead an Email Template Example ResponseRead an Email Template Example ResponseRead an Email Template: Example Response

Anchor
Create an Email Template Example Request
Create an Email Template Example Request
Create an Email Template: Example Request

Anchor
List Email Templates Example Response
List Email Templates Example Response
List Email Templates: Example Response

Anchor
Read an Email Template URI Parameters
Read an Email Template URI Parameters
Read an Email Template: URI Parameters

Anchor
Read an Email Template Example Response
Read an Email Template Example Response
Read an Email Template: Example Response