...
Universal Controller supports the following RESTful-based web services for Workflow Task Instance operations, which are listed alphabetically on this page.
- Workflow Task Instance Web Services#Insert Insert a Task into a Workflow with Dependencies
- Workflow Task Instance Web Services#List List Predecessors / Successors of a Task Instance in a Workflow
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
Examples | XML | JSON |
---|
Example Request | | |
Example Response |
Expand |
---|
| panel<command-response>
<type>create_task</type>
<success>true</success>
<info>Command Insert Task executed successfully against task instance "test workflow".</info>
<errors />
</command-response> |
|
Expand |
---|
| panel{
"type": "create_task",
"success": true,
"info": "Command Insert Task executed successfully against task instance \"Test Workflow\".",
"errors": ""
} |
|
Anchor |
---|
| Insert a Task into a Workflow with Dependencies Request Properties |
---|
| Insert a Task into a Workflow with Dependencies Request Properties |
---|
|
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 (unless name is specified) | name
|
| Task Name | Name of the task to be inserted. |
| Y (unless id is specified) | id
|
Anchor |
---|
| predecessors - IT |
---|
| predecessors - IT |
---|
|
predecessors | Predecessors | Comma-separated list of predecessor task instances within the workflow for the task to be inserted. |
| N |
|
Anchor |
---|
| successors - IT |
---|
| successors - IT |
---|
|
successors | 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 |
|
Anchor |
---|
| inheritTriggerTime - IT |
---|
| inheritTriggerTime - IT |
---|
|
inheritTriggerTime | 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 |
|
Anchor |
---|
| workflowInstanceCriteria- IT |
---|
| workflowInstanceCriteria- IT |
---|
|
workflowInstanceCriteria | n/a | If search is by workflowInstanceName ; Specific Workflow task instance with this task instance name which you want to insert the task into. | Valid values: - As String = oldest active instance, As Value = 1
- As String = newest active instance, As Value = 2
- As String = oldest instance, As Value = 3
- As String = newest instance, As Value = 4
Default is oldest active instance (1). Note |
---|
| Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
| N |
|
Anchor |
---|
| workflowInstanceId - IT |
---|
| workflowInstanceId - IT |
---|
|
workflowInstanceId | n/a | sys_id of the Workflow to insert the task into. |
| Y (unless workflowInstanceName is specified) | workflowInstanceName
|
Anchor |
---|
| workflowInstanceName - IT |
---|
| workflowInstanceName - IT |
---|
|
workflowInstanceName | Instance Name | Name of the Workflow to insert the task into. |
| Y (unless workflowInstanceId is specified) | workflowInstanceId
|
...
XML | JSON |
---|
|
Expand |
---|
| [ {
"condition": {
"value": "Success"
},
"name": "Sleep 30",
"satisfied": false,
"taskInstanceId": "1471465078487058257PY97G57T09HKB",
"type": "Predecessor",
"vertexId": "20",
"vertexName": "Sleep 30"
}, {
"condition": {
"value": "Success"
},
"name": "Sleep 60",
"satisfied": false,
"taskInstanceId": "151371775991531795355TV2GX49AWD6",
"type": "Successor",
"vertexId": "2",
"vertexName": "Sleep 60"
} ] |
|
...
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|
criteria
| If taskinstancename is specified; Specific task instance with this task instance name for which you want to list predecessors and successors. | Valid values: - As String = oldest active instance, As Value = 1
- As String = newest active instance, As Value = 2
- As String = oldest instance, As Value = 3
- As String = newest instance, As Value = 4
Default is oldest active instance (1). Note |
---|
| Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
| N |
|
dependencytype
| Type of dependency to list for the task instance. | Valid values: predecessors, successors, * (all predecessors and successors). | N |
|
taskinstanceid
| sys_id of the task instance for which you want to list predecessors and successors. |
| Y (unless taskinstancename is specified) | taskinstancename
|
taskinstancename
| Name of the task instance for which you want to list predecessors and successors. |
| Y (unless taskinstanceid is specified) | taskinstanceid
|
workflowinstancename
| If taskinstancename is specified; Name of the Workflow task instance containing the task instance for which you want to list predecessors and successors. |
| N |
|
...