Task Instance Web Services
Overview
Universal Controller supports the following RESTful-based web services for Task Instance operations, which are listed alphabetically on this page.
- Cancel a Task Instance
- Clear All Dependencies
- Clear Exclusive Dependencies
- Clear Predecessor Dependencies
- Clear Time Dependency
- Clear Virtual Resource Dependencies
- Delete a Task Instance
- Force/Finish a Task Instance
- Force/Finish Cancel a Task Instance
- Hold a Task Instance
- Issue Set Completed Command for a Manual Task Instance
- Issue Set Started Command for a Manual Task Instance
- List Task Instances
- List Task Instance Variables (Show Variables)
- Release a Task Instance from Hold
- Rerun a Task Instance
- Retrieve Task Instance Output
- Set or Modify Wait Time/Duration for Task Instance
- Set Priority for a Task Instance
- Skip a Task Instance
- Skip a Task Instance Path
- Unskip a Task Instance
- Update a Task Instance Operational Memo
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 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 |
|
Request Properties |
|
Example Response |
Cancel a Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Cancel a Task Instance: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 |
|
Request Properties |
|
Example Response |
Clear All Dependencies: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Clear All Dependencies: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 |
|
Request Properties |
|
Example Response |
Clear Exclusive Dependencies: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Clear Exclusive Dependencies: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 Predecessor Dependencies
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/clearpredecessors |
HTTP Method |
POST |
Description |
Clears all predecessor dependencies of a task instance in a Workflow. |
Authentication |
HTTP Basic |
Example URI |
http://localhost:8080/uc/resources/taskinstance/clearpredecessors |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
Clear Predecessor Dependencies: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Clear Predecessor Dependencies: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
n/a |
Name of the predecessor task instance for which you want to clear dependency. |
* = Clears dependencies from all predecessor task instances. |
Y |
|
|
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 Time Dependency
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/cleartimewait |
HTTP Method |
POST |
Description |
Clears the time dependency of a task instance. |
Authentication |
HTTP Basic |
Example URI |
http://localhost:8080/uc/resources/taskinstance/cleartimewait |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
Clear Time Dependency: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Clear Time Dependency: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 Virtual Resource Dependencies
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/clearresources |
HTTP Method |
POST |
Description |
Clears virtual resource dependencies of a task instance. |
Authentication |
HTTP Basic |
Example URI | http://localhost:8080/uc/resources/taskinstance/clearresources |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
See Clear Virtual Resource Dependencies: XML and JSON Examples. |
Request Properties |
See Clear Virtual Resource Dependencies: Request Properties. |
Example Response |
See Clear Virtual Resource Dependencies: XML and JSON Examples. |
Clear Virtual Resource Dependencies: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Clear Virtual Resource Dependencies: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
n/a |
Name of the virtual resource for which you want to clear dependency. |
* = Clears dependencies from all virtual resources. |
Y |
|
|
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 |
|
Delete a Task Instance
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance |
HTTP Method |
DELETE |
Description |
Deletes the specified task instance. For Workflow task instances, if the |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Example URI |
http://localhost:8080/uc/resources/taskinstance |
Example Request |
|
Request Properties |
|
Example Response |
|
Delete a Task Instance: XML and JSON Examples
XML |
JSON |
---|---|
|
|
Delete a Task Instance: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Instance (3). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
n/a |
For Workflow task instances only; Specification for whether or not to delete all children task instances of the task instance. |
Boolean; Valid values: true/false. Default is false. |
N |
|
Force Finish a Task Instance
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/forcefinish |
HTTP Method |
POST |
Description |
Force Finish a task instance. (To Force Finish (Halt) a task instance, set the halt property to true.) |
Example URI |
http://localhost:8080/uc/resources/taskinstance/forcefinish |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
Force Finish a Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Force Finish a Task Instance: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
Prevents successor task instances of the specified task instance in a Workflow from being run. |
Boolean. Valid values: true/false. Default is false. |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 |
|
Force Finish/Cancel a Task Instance
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/forcefinishcancel |
HTTP Method |
POST |
Description |
Force Finish/Cancel a task instance. (To Force Finish/Cancel (Halt) a task instance, set the halt property to true.) |
Example URI |
http://localhost:8080/uc/resources/taskinstance/forcefinishcancel |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
See Force Finish Cancel a Task Instance: XML and JSON Examples. |
Request Properties |
See Force Finish/Cancel a Task Instance: Request Properties. |
Example Response |
See Force Finish Cancel a Task Instance: XML and JSON Examples. |
Force Finish/Cancel a Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Force Finish/Cancel a Task Instance: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
Prevents successor task instances of the specified task instance in a Workflow from being run. |
Boolean. Valid values: true/false. Default is false. |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 |
|
Hold a Task Instance
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/hold |
HTTP Method |
POST |
Description |
Hold a task instance. |
Example URI |
http://localhost:8080/uc/resources/taskinstance/hold |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
Hold a Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Hold a Task Instance: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 |
|
Issue Set Completed Command for a Manual Task Instance
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/setcompleted |
HTTP Method |
POST |
Description |
Issues a Set Completed command for a Manual Task instance. |
Example URI |
http://localhost:8080/uc/resources/taskinstance/setcompleted |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
See Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples. |
Request Properties |
See Issue Set Completed Command for a Manual Task Instance: Request Properties. |
Example Response |
See Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples. |
Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Issue Set Completed Command for a Manual Task Instance: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 |
|
Issue Set Started Command for a Manual Task Instance
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/setstarted |
HTTP Method |
POST |
Description |
Issues a Set Started command for a Manual Task instance. |
Example URI |
http://localhost:8080/uc/resources/taskinstance/setstarted |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
See Issue Set Started Command for a Manual Task Instance: XML and JSON Examples. |
Request Properties |
See Issue Set Started Command for a Manual Task Instance: Request Properties |
Example Response |
See Issue Set Started Command for a Manual Task Instance: XML and JSON Examples. |
Issue Set Started Command for a Manual Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Issue Set Started Command for a Manual Task Instance: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Specific task instance with this task instance |
Valid values:
Default is Oldest Active Instance (1). Note Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance). |
N |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
|
Y |
|
|
Instance Name |
Name of the task instance. |
|
Y |
|
|
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 |
|
List Task Instances
|
Description |
---|---|
URI |
http://host_name/uc/resources/taskinstance/list |
HTTP Method |
POST |
Description |
Retrieves information on task instances matching specific search criteria. |
Authentication |
HTTP Basic |
Example URI |
http://localhost:8080/uc/resources/taskinstance/list |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
List Task Instances: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|