Versions Compared

Key

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

...


Description

URI

HTTP Method

POST

Description

Creates an Email Connection.

Example URI

http://localhost:8080/uc/resources/emailconnection

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Create an Email Connection: Example Request, below.

Example Response

  • Status 200 /OK
    Successfully created the Email Connection with sysId {sysId}.
  • Status 400 /Bad Request
    Create Email Connection failed. A duplicate value has been detected. Name must be unique.

Email Connection Properties

See 13074436 Email Connection Properties, below.

Anchor
Create an Email Connection Example Request
Create an Email Connection Example Request
Create an Email Connection: Example Request

...


Description

URI

http://host_name/uc/resources/emailconnection/list

HTTP Method

GET

Description

Retrieves information on all Email Connections.

Example URI

http://localhost:8080/uc/resources/emailconnection/list

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List Email Connections: Example Response, below.

Email Connection Properties

See 13074436 Email Connection Properties.

Anchor
List Email Connections Example Response
List Email Connections Example Response
List Email Connections: Example Response

...


Description

URI

http://host_name/uc/resources/emailconnection

HTTP Method

PUT

Description

Modifies the Email Connection specified by the sysId.

Example URI

http://localhost:8080/uc/resources/emailconnection

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify an Email Connection: Example Request, below.

Email Connection Properties

See 13074436SeeĀ Email Connection Properties.

Example Response

  • Status 200 /OK
    Successfully updated the Email Connection with sysId <sysId> to version <version>.

...

URI

http://host_name/uc/resources/emailconnection

HTTP Method

GET

Description

Retrieves information on a specific Email Connection.

URI Parameters

See Read an Email Connection: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/emailconnection?connectionname=Test4

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See Read an Email Connection: Example Response, below.

Email Connection Properties

See 13074436 Email Connection Properties.

Anchor
Read an Email Connection URI Parameters
Read an Email Connection URI Parameters
Read an Email Connection: URI Parameters

...