Versions Compared

Key

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

...

Universal Controller supports the following RESTful-based web services for Workflow Task operations.

  • Create a Workflow Task
  • Modify a Workflow Task
  • Read a Workflow Task

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.
 

...


Description

URI

http://host_name/uc/resources/task

HTTP Method

POST

Description

Creates a new Workflow task.

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

See Workflow Task: XML and JSON Examples, below.

Properties

See Properties.

Example Response

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

...


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 Workflow Task properties without modifying related records, use the excludeRelated property.

Example Response

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

...


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

http://localhost:8080/uc/resources/task?taskname=test

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Anchor
Workflow Task XML and JSON Examples
Workflow Task XML and JSON Examples
Workflow Task: XML and JSON Examples

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

...