1 Overview
2 Cancel a Task Instance
- 2.1 Cancel a Task Instance: XML and JSON Examples
- 2.2 Cancel a Task Instance: Request Properties
3 Clear All Dependencies
- 3.1 Clear All Dependencies: XML and JSON Examples
- 3.2 Clear All Dependencies: Request Properties
4 Clear Exclusive Dependencies
- 4.1 Clear Exclusive Dependencies: XML and JSON Examples
- 4.2 Clear Exclusive Dependencies: Request Properties
5 Clear Predecessor Dependencies
- 5.1 Clear Predecessor Dependencies: XML and JSON Examples
- 5.2 Clear Predecessor Dependencies: Request Properties
6 Clear Time Dependency
- 6.1 Clear Time Dependency: XML and JSON Examples
- 6.2 Clear Time Dependency: Request Properties
7 Clear Virtual Resource Dependencies
- 7.1 Clear Virtual Resource Dependencies: XML and JSON Examples
- 7.2 Clear Virtual Resource Dependencies: Request Properties
8 Delete a Task Instance
- 8.1 Delete a Task Instance: XML and JSON Examples
- 8.2 Delete a Task Instance: Request Properties
9 Force Finish a Task Instance
- 9.1 Force Finish a Task Instance: XML and JSON Examples
- 9.2 Force Finish a Task Instance: Request Properties
10 Force Finish/Cancel a Task Instance
- 10.1 Force Finish/Cancel a Task Instance: XML and JSON Examples
- 10.2 Force Finish/Cancel a Task Instance: Request Properties
11 Hold a Task Instance
- 11.1 Hold a Task Instance: XML and JSON Examples
- 11.2 Hold a Task Instance: Request Properties
12 Issue Set Completed Command for a Manual Task Instance
- 12.1 Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples
- 12.2 Issue Set Completed Command for a Manual Task Instance: Request Properties
13 Issue Set Started Command for a Manual Task Instance
- 13.1 Issue Set Started Command for a Manual Task Instance: XML and JSON Examples
- 13.2 Issue Set Started Command for a Manual Task Instance: Request Properties
14 List Task Instances
- 14.1 List Task Instances: XML and JSON Examples
- 14.2 List Task Instances: Request Properties
- 14.3 Task Instance Status Types
15 List Task Instance Variables (Show Variables)
- 15.1 List Task Instance Variables (Show Variables): XML and JSON Response Examples
- 15.2 List Task Instance Variables (Show Variables): Example URI Properties
16 Release a Task Instance from Hold
- 16.1 Release a Task Instance from Hold: XML and JSON Examples
- 16.2 Release a Task Instance from Hold: Request Properties
17 Rerun a Task Instance
- 17.1 Rerun a Task Instance: XML and JSON Examples
- 17.2 Rerun a Task Instance: Request Properties
18 Retrieve Task Instance Output
- 18.1 Retrieve Task Instance Output: XML and JSON Response Examples
- 18.2 Retrieve Task Instance Output: Example URI Properties
19 Set or Modify Wait Time/Duration for Task Instance
- 19.1 Set or Modify Wait Time/Duration for Task Instance: XML and JSON Examples
- 19.2 Set or Modify Wait Time/Duration for Task Instance: Request Properties
20 Set Priority for a Task Instance
- 20.1 Set Priority for a Task Instance: XML and JSON Examples
- 20.2 Set Priority for a Task Instance: Request Properties
21 Skip a Task Instance
- 21.1 Skip a Task Instance: XML and JSON Examples
- 21.2 Skip a Task Instance: Request Properties
22 Skip a Task Instance Path
- 22.1 Skip a Task Instance Path: XML and JSON Examples
- 22.2 Skip a Task Instance Path: Request Properties
23 Unskip a Task Instance
- 23.1 Unskip a Task Instance: XML and JSON Examples
- 23.2 Unskip a Task Instance: Request Properties
24 Update a Task Instance Operational Memo
- 24.1 Update a Task Instance Operational Memo: Text/Plain Examples
- 24.2 Update a Task Instance Operational Memo: Example URI Properties

Overview

Universal Controller supports the following RESTful-based web services for Task Instance operations, which are listed alphabetically on this page.

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

For RESTful-based web services for Workflow Task Instance operations, see Workflow Task Instance Web Services.

Cancel a Task Instance

Note

A Web Service Task instance cannot be cancelled if the specified Protocol is SOAP.

	Description
URI	http://host_name/uc/resources/taskinstance/cancel
HTTP Method	POST
Description	Cancel a task instance.
Example URI	http://localhost:8080/uc/resources/taskinstance/cancel
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Cancel a Task Instance: XML and JSON Examples.
Request Properties	See Cancel a Task Instance: Request Properties.
Example Response	See Cancel a Task Instance: XML and JSON Examples.

Cancel a Task Instance: XML and JSON Examples

Examples	XML	JSON
Example Request	`<task-instance> <`id`>1464817327170011848D633V6106ENQ7</`id`> </task-instance>` or `<task-instance> <`name`>Timer 60</`name`> <`criteria`>Newest Instance</`criteria`> <`workflowInstanceName`>test</workflowInstanceName> </task-instance>`	`{ "`name`": "Timer 60", "`criteria`": "Newest Instance", "workflowInstanceName": "test" }`
Example Response	`<command-response> <type>cancel</type> <success>true</success> <info>Command Cancel executed successfully against task instance "test".</info> <errors /> </command-response>`	`{ "type": "cancel", "success": true, "info": "Command Cancel executed successfully against task instance \"Timer 60\".", "errors": "" }`

Cancel a Task Instance: Request Properties

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
`criteria`	n/a	Specific task instance with this task instance `name` that you want to cancel.	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
`id`	n/a	sys_id used within the Controller to identify this task instance.		Y (unless `name` is specified)	`name`
`name`	Instance Name	Name of the task instance.		Y (unless `id` is specified)	`id`
`workflowInstanceName`	Workflow	Name of the parent Workflow of the task instance.	You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.	N

Clear All Dependencies

	Description
URI	http://host_name/uc/resources/taskinstance/cleardependencies
HTTP Method	POST
Description	Clears all dependencies of a task instance.
Example URI	http://localhost:8080/uc/resources/taskinstance/cleardependencies
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Clear All Dependencies: XML and JSON Examples.
Request Properties	See Clear All Dependencies: Request Properties.
Example Response	See Clear All Dependencies: XML and JSON Examples.

Clear All Dependencies: XML and JSON Examples

Examples	XML	JSON
Example Request	`<task-instance> <`id`>1464817327170011848D633V6106ENQ7</`id`> </task-instance>` or `<task-instance> <`name`>Timer 60</`name`> <`criteria`>Newest Instance</`criteria`> <`workflowInstanceName`>test</`workflowInstanceName`> </task-instance>`	`{ "`name`": "Timer 60", "`criteria`": "Newest Instance", "`workflowInstanceName`": "Test" }`
Example Response	`<command-response> <type>clear_all_dependencies</type> <success>true</success> <info>Command Clear All Dependencies executed successfully against task instance "Timer 60".</info> <errors /> </command-response>`	`{ "type": "clear_all_dependencies", "success": true, "info": "Command Clear All Dependencies executed successfully against task instance \"Timer 60\".", "errors": "" }`

Clear All Dependencies: Request Properties

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
`criteria`	n/a	Specific task instance with this task instance `name` for which you want to clear all dependencies.	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
`id`	n/a	sys_id used within the Controller to identify this task instance.		Y (unless `name` is specified)	`name`
`name`	Instance Name	Name of the task instance.		Y (unless `id` is specified)	`id`
`workflowInstanceName`	Workflow	Name of the parent Workflow of the task instance.	You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.	N

Clear Exclusive Dependencies

	Description
URI	http://host_name/uc/resources/taskinstance/clearexclusive
HTTP Method	POST
Description	Clears all exclusive dependencies of a task instance.
Authentication	HTTP Basic
Example URI	http://localhost:8080/uc/resources/taskinstance/clearexclusive
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Clear Exclusive Dependencies: XML and JSON Examples.
Request Properties	See Clear Exclusive Dependencies: Request Properties.
Example Response	See Clear Exclusive Dependencies: XML and JSON Examples.

Clear Exclusive Dependencies: XML and JSON Examples

Examples	XML	JSON
Example Request	`<task-instance> <`id`>1464817327170011848D633V6106ENQ7</`id`> </task-instance>` or `<task-instance> <`name`>Timer 60</`name`> <`criteria`>Newest Instance</`criteria`> <`workflowInstanceName`>test</`workflowInstanceName`> </task-instance>`	`{ "`name`": "Timer 60", "`criteria`": "Newest Instance", "`workflowInstanceName`": "Test" }`
Example Response	`<command-response> <type>clear_exclusive</type> <success>true</success> <info>Command Clear Exclusive executed successfully against task instance "Timer 60".</info> <errors /> </command-response>`	`{ "type": "clear_exclusive", "success": true, "info": "Command Clear Exclusive executed successfully against task instance \"Timer 60\".", "errors": "" }`

Clear Exclusive Dependencies: Request Properties

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
`criteria`	n/a	Specific task instance with this task instance `name` for which you want to clear exclusive dependencies.	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
`id`	n/a	sys_id used within the Controller to identify this task instance.		Y (unless `name` is specified)	`name`
`name`	Instance Name	Name of the task instance.		Y (unless `id` is specified)	`id`
`workflowInstanceName`	Workflow	Name of the parent Workflow of the task instance.	You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.