Workflow Task Instance Web Services
Overview
Universal Controller supports the following RESTful-based web services for Workflow Task Instance operations, which are listed alphabetically on this page.
- Insert a Task into a Workflow with Dependencies
- List Predecessors / Successors of a Task Instance in a Workflow
Formatting specifications for each web service, including details about parameter requirements, are provided.
Insert a Task into a Workflow with Dependencies
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/ops-task-insert |
HTTP Method |
POST |
Description |
Insert a task into a Workflow with dependencies. |
Authentication |
HTTP Basic |
Example URI |
http://localhost:8080/uc/resources/taskinstance/ops-task-insert |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Request Example |
See Insert a Task into a Workflow with Dependencies: XML and JSON Examples. |
Request Properties |
See Insert a Task into a Workflow with Dependencies: Request Properties. |
Response Example |
See Insert a Task into a Workflow with Dependencies: XML and JSON Examples. |
Insert a Task into a Workflow with Dependencies: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Insert a Task into a Workflow with Dependencies: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Alias used for the task within the Workflow; specifically, the value of ops_exec_workflow_vertex.name. |
|
N |
|
|
n/a |
sys_id of the task to be inserted. |
|
Y |
|
|
Task Name |
Name of the task to be inserted. |
|
Y |
|
|
Predecessors |
Comma-separated list of predecessor task instances within the workflow for the task to be inserted. |
|
N |
|
|
Successors |
Comma-separated list of successor task instances within the workflow for the task to be inserted. |
|
N |
|
|
n/a |
x-coordinate of the task to be inserted within the workflow. |
Default is 0. |
N |
|
|
n/a |
y-coordinate of the task to be inserted within the workflow. |
Default is 0. |
N |
|
|
n/a |
Specification for whether or not the inserted task will inherit the Trigger Time of the Workflow task instance. |
Boolean; Valid values (not case-sensitive):
Default is Yes, Y, true. |
N |
|
|
n/a |
If search is by |
Valid values:
Default is oldest active instance (1). |