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 Task operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

Links to detailed information about the properties used in these web services also is located on this page.
 

...

Anchor
Create an Email Task
Create an Email Task

Create an Email Task


Description

URI

http://host_name/uc/resources/task

HTTP Method

POST

Description

Creates a new Email task.
 
To persist sysIds, use the retainSysIds property.

Example URI

http://localhost:8080/uc/resources/task

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

See Email Task: XML and JSON Examples, below.

Properties

See Properties 63545054.

Example Response

  • Status 200 /OK
    Successfully created the <task type> task with sysId <sysId>.

Anchor
Modify an Email Task
Modify an Email Task

Modify an Email Task


Description

URI

http://host_name/uc/resources/task

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

HTTP Method

PUT

Description

Modifies the task specified by the sysId in the request.
 
To modify Email Task properties without modifying related records, use the excludeRelated property.

Example

See Email Task: XML and JSON Examples.

Properties

See Properties 63545054.

Example Response

  • Status 200 /OK
    Successfully updated the <task type> task with sysId <sysId> to version <version>.

Anchor
Read an Email Task
Read an Email Task

Read an Email Task


Description

URI

http://host_name/uc/resources/task

HTTP Method

GET

Description

Retrieves information on the specified task.

Request Parameters

taskid or taskname

Mutually Exclusive Parameters

taskid and taskname

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Properties

See Properties 63545054.

Anchor
Email Task XML and JSON Examples
Email Task XML and JSON Examples

Email Task: XML and JSON Examples

The retainSysIds and version properties are specified as attributes in XML.

...

See Task Web Services - Task-Related Records for XML and JSON examples of task-related records.

Anchor
Properties
Properties

Properties