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). Note Values with an underscore characters ( _ ) |
N |
|
|
n/a |
sys_id of the Workflow to insert the task into. |
|
Y |
|
|
Instance Name |
Name of the Workflow to insert the task into. |
|
Y |
|
Note
- If both
predecessors
andsuccessors
lists are empty, the task is inserted without dependencies. - If there is a task name in a
predecessors
orsuccessors
list that does not exist, the operation will fail with error Cannot find vertex with the name ... - If a
predecessors
orsuccessors
list contains a task name with multiple occurrences in the workflow, the operation will fail with error Multiple vertices found for the name... (For example, the workflow contains two tasks named Sleep 30 and you are trying to insert Task ABC with predecessor Sleep 30.
List Predecessors / Successors of a Task Instance in a Workflow
List Predecessors / Successors of a Task Instance in a Workflow: XML and JSON Examples
XML |
JSON |
---|---|
|
|
List Predecessors / Successors of a Task Instance in a Workflow: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
If |
Valid values:
Default is oldest active instance (1). Note Values with an underscore characters ( _ ) |
N |
|
|
Type of dependency to list for the task instance. |
Valid values: predecessors, successors, * (all predecessors and successors). |
N |
|
|
sys_id of the task instance for which you want to list predecessors and successors. |
|
Y |
|
|
Name of the task instance for which you want to list predecessors and successors. |
|
Y |
|
|
If |
|
N |
|
List Predecessors / Successors of a Task Instance in a Workflow: Response Properties
Property |
UI Field Name |
Description |
---|---|---|
|
n/a |
Dependency condition between the task instance and the listed Predecessor / Successor task instance. |
|
n/a |
Resolved name of the Predecessor / Successor task instance. |
|
n/a |
Indication of whether the |
|
n/a |
sys_id of the task instance for which the Predecessor / Successor task instance is listed. |
|
n/a |
Type of dependency for the Predecessor / Successor task instance. |
|
n/a |
Vertex ID of the Predecessor / Successor task instance. |
|
n/a |
Name of the Predecessor / Successor task instance. |