Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...


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

  • 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 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

...


Description

URI

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

...