...
Universal Controller supports the following RESTful-based web services for Email Connection operations, which are listed alphabetically on this page.
- Create an Email Connection
- Delete an Email Connection
- List Email Connections
- Modify an Email Connection
- Read an Email Connection
Formatting specifications for each web service, including details about property requirements, are provided.
...
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 |
|
Email Connection Properties | See Email Connection Properties, below. |
Anchor | ||||
---|---|---|---|---|
|
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/emailconnection |
HTTP Method | DELETE |
Description | Deletes an Email Connection. |
URI Parameters | See Delete an Email Connection: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/emailconnection?connectionname=Test4 |
Example Response |
|
...
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 |
...
XML Response | JSON Response | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/emailconnection |
HTTP Method | PUT |
Description | Modifies the Email Connection specified by the |
Example URI | |
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 | |
Example Response |
|
...
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
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 |
...
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...