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 Instances - Advanced
- 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.
Task Instance Status Types
The following table describes all possible task instance statuses for all task types.
Note
The format of multi-word task status names specified in the Task Instance Status Web Service differs from the format of task status names used in the Controller user interface. In Task Instance Status, the words are separated by an underscore character; in the user interface, they are separated by a space.
Status Name |
Status Code |
Task Type |
Description |
---|---|---|---|
Action_Required |
60 |
Manual |
When a manual task launches, it goes into Action Required status, meaning a user must perform some manual activity. For details, see Manual task. |
Cancel_Pending |
99 |
A process running on the Agent needs to be terminated. When the Cancel command is issued, the task instance will go into a Cancel Pending status until the Agent reports back that the process has been cancelled. At that point, the task instance will transition into the Cancelled status. |
|
Cancelled |
130 |
All |
The task was cancelled by a user. |
Confirmation_Required |
125 |
z/OS |
If you make JCL changes and restart a z/OS task, Universal Controller will put the task into Confirmation Required status and prompt you for a confirmation. For detailed processing steps, see Rerunning a z/OS Task. |
Defined |
0 |
All |
The new task instance has been created (the task has been launched). |
Exclusive_Requested |
22 |
All |
All tasks with a mutually exclusive task defined go immediately to a status of Exclusive Requested. If the task is available to run exclusively, the task then moves to the next appropriate processing status. |
Exclusive_Wait |
23 |
All |
The task is mutually exclusive with one or more other tasks, and it is waiting for those tasks to finish before it will run. |
Execution_Wait |
33 |
The task must wait to be completed; either the Agent/Agent Cluster running the task has reached its Task Execution Limit, or the ability of the Agent/Agent Cluster to run tasks has been suspended. |
|
Failed |
140 |
All* |
The task ran to a failure status. |
Finished |
190 |
All |
The task was forced by the user to finish. The user may do this in cases where the task had a Cancelled or Failed status, and the user needed to release other task instances depending on the successful completion of this task instance in a workflow. For more information, see Force Finishing a Task. |
Held |
20 |
All |
The task has been put on hold by a user. |
In_Doubt |
110 |
The Agent is "in doubt" about the current status of the task instance. This may occur if an Agent or Agent connection goes down. In this case, the Agent restarts and reviews its data about tasks in progress. If the Agent finds a task still running, it resumes normal monitoring. If the Agent cannot find the task, this usually indicates that the task completed, but the Agent considers the task status to be "in doubt." |
|
Queued |
40 |
The task has been queued on a resource. |
|
Resource_Requested |
25 |
All |
All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is available, the task then moves to the next appropriate processing status. |
Resource_Wait |
30 |
All |
All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is not available, the task goes to a status of Resource Wait. When the resource becomes available, the task moves to the next appropriate processing status |
Running |
80 |
All |
The task is running. For Agent-based tasks, the Agent has started running the program. |
Running/Problems |
81 |
Workflow |
One or more tasks within the workflow has one of the following statuses:
|
Skipped |
180 |
All |
The task was skipped by a user. |
Start Failure |
120 |
All |
The task was unable to start. |
Started |
70 |
Agent-based, Manual |
The task has started. For Agent-based tasks, this means the Agent has received the task. |
Submitted |
43 |
z/OS |
The task has been submitted to the z/OS Job Entry subsystem and scheduled by the z/OS Job Scheduler. |
Success |
200 |
All |
The task has completed successfully. Workflows will transition to Success status when all of its tasks have transitioned to Success, Finished, or Skipped status. |
Time_Wait |
15 |
All (except Timer) |
The task is waiting to start based on a Wait To Start and/or Delay On Start specification. |
Undeliverable |
35 |
The Agent is unavailable. |
|
Waiting |
10 |
All |
The task has been loaded by a workflow and is waiting on a predecessor. |
* Workflows cannot go to Failed status.
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 |
|
|
List Task Instances: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
Agent |
Name of the agent that this task instances is assigned to run on. |
N |
||
|
Member of Business Services |
Business Services that this task instance belongs to. |
Comma-separated list. |
N |
|
|
Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.) |
User-defined task field 1. |
Wildcards are supported. |
N |
|
|
Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.) |
User-defined task field 2. |
Wildcards are supported. |
N |
|
|
Execution User |
Execution User of a task instance that determines the security context under which the task instance runs. |
System-supplied. |
N |
|
|
Instance Number |
Sequentially assigned number, maintained per task, representing the creation order of the instance. |
Integer value. |
N |
|
|
Started Late / Finished Late |
Indication of whether or not to list all task instances that started late or finished late. |
Valid values: true/false. |
N |
|
|
Started Late / Finished Late / Finished Early |
Indication of whether or not to list all task instances that started late, finished late, or finished early. |
Valid values: true/false. |
N |
|
|
Instance name |
Name or partial name of one or more task instances. |
Wildcards are supported. |
Y |
|
|
Status |
List of comma-separated task instance status codes and/or names (not case sensitive). |
Specifying one or more statuses automatically excludes task instances in all other statuses. |
N |
|
|
Status Description |
Description (if any) of the current status of the Task Instance. |
Wildcards are supported. |
N |
|
|
n/a |
sys_id used within the Controller to identify a task instance. |
Y |
|
|
|
n/a |
sys_id of the task definition that this Task Instance was created from. |
N |
|
|
|
n/a |
Name of the task definition that this Task Instance was created from. |
N |
|
|
|
n/a | ID used within the controller to identify a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. |
N | templateName |
|
Template Name | Name of a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. |
N | templateId |
|
n/a |
sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). |
N |
|
|
|
n/a |
Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) |
N |
|
|
|
n/a |
Task type of this task instance. |
Valid values: One of the following (not case sensitive): application_control, email, email_monitor, agent_file_monitor, ftp, remote_file_monitor, indesca / universal_command / ucmd, manual, sap, sql, stored_procedure, system_monitor, task_monitor, timer, universal, unix, variable_monitor, web_service, windows, workflow, zos. |
N |
|
|
n/a |
If |
Valid values:
Default is d. If Note The time is relative to the Time Zone specified for the User. |
Y |
|
|
n/a |
Type of |
Valid values:
|
N |
|
|
n/a |
sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). |
N |
|
|
|
n/a |
Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). |
N |
|
|
|
n/a |
Specification for how |
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 of the parent workflow task instance. Only task instances within this workflow task instance will be listed. |
N |
|
|
|
Workflow |
Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed. |
N |
|
List Task Instances: Advanced
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/listadv http://host_name/uc/resources/taskinstance/listAdv |
HTTP Method |
POST |
Description |
List Task instance output details |
Example URI |
|
Authentication |
HTTP Basic |
Produces Content-Type |
|
Consumes Content-Type |
Application/XML & Application/JSON |
Example Request |
See List Task Instances - Advanced: XML and JSON Request Examples. |
Example Response |
See List Task Instances - Advanced: XML and JSON Response Examples. |
Request Properties |
List Task Instances - Advanced: XML and JSON Request Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
List Task Instances - Advanced: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
Agent |
Name of the agent that this task instances is assigned to run on. |
N |
||
|
Member of Business Services |
Business Services that this task instance belongs to. |
Comma-separated list. |
N |
|
|
Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.) |
User-defined task field 1. |
Wildcardsare supported. |
N |
|
|
Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.) |
User-defined task field 2. |
Wildcards are supported. |
N |
|
|
Execution User |
Execution User of a task instance that determines the security context under which the task instance runs. |
System-supplied. |
N |
|
|
Instance Number |
Sequentially assigned number, maintained per task, representing the creation order of the instance. |
Integer value. |
N |
|
|
Output Type |
Type of task instance output to retrieve. |
String; Valid values:
|
N |
|
|
Started Late / Finished Late |
Indication of whether or not to list all task instances that started late or finished late. |
Valid values: true/false. |
N |
|
|
Started Late / Finished Late / Finished Early |
Indication of whether or not to list all task instances that started late, finished late, or finished early. |
Valid values: true/false. |
N |
|
|
Instance name |
Name or partial name of one or more task instances. |
Wildcards are supported. |
Y |
|
|
N/A |
Allowed Response fields |
Comma separated list of any of the following fields can be viewed. "*" returns all fields listed below. If left empty, the default fields will be returned.
|
N |
|
|
Status |
List of comma-separated task instance status codes and/or names (not case sensitive). |
Specifying one or more statuses automatically excludes task instances in all other statuses. |
N |
|
|
Status Description |
Description (if any) of the current status of the Task Instance. |
Wildcards are supported. |
N |
|
|
n/a |
sys_id used within the Controller to identify a task instance. |
Y |
|
|
|
n/a |
sys_id of the task definition that this Task Instance was created from. |
N |
|
|
|
n/a |
Name of the task definition that this Task Instance was created from. |
N |
|
|
|
n/a | ID used within the controller to identify a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. |
N | templateName |
|
Template Name | Name of a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. |
N | templateId |
|
n/a |
sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). |
N |
|
|
|
n/a |
Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) |
N |
|
|
|
n/a |
Task type of this task instance. |
Valid values: One of the following (not case sensitive): application_control, email, email_monitor, agent_file_monitor, ftp, remote_file_monitor, indesca / universal_command / ucmd, manual, sap, sql, stored_procedure, system_monitor, task_monitor, timer, universal, unix, variable_monitor, web_service, windows, workflow, zos. |
N |
|
|
n/a |
If |
Valid values:
Default is d. updatedTimeType is Between; date/time values (start date/time inclusive, end date/time exclusive)( yyyy-MM-dd [HH:mm:ss], yyyy-MM-dd [HH:mm:ss]) Note The time is relative to the Time Zone specified for the User. |
Y |
|
|
n/a |
Type of |
Valid values:
|
N |
|
|
n/a |
sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). |
N |
|
|
|
n/a |
Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). |
N |
|
|
|
n/a |
Specification for how |
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 of the parent workflow task instance. Only task instances within this workflow task instance will be listed. |
N |
|
|
|
Workflow |
Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed. |
N |
|
List Task Instance Variables (Show Variables)
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/showvariables |
HTTP Method |
GET |
Description |
Retrieve the variables for a specific task instance. (Comparable to the Show Variables functionality in the user interface.) |
Authentication |
HTTP Basic |
Example URI |
|
Consumes Content-Type |
n/a |
Produces Content-Type |
application/xml, application/json |
Example URI Properties |
See List Task Instance Variables (Show Variables): Example URI Properties. |
Example Response |
See List Task Instance Variables (Show Variables): XML and JSON Response Examples. |
List Task Instance Variables (Show Variables): Example URI Properties
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
|
---|---|---|---|---|---|
|
n/a |
Used if |
String; URI parameter. Valid values:
Default is Oldest Active Instance (1). |
N |
|
|
UUID |
UUID of the task instance for which you want to list variables. |
String; URI parameter. |
Y |
|
|
Instance Name |
Name of the task instance for which you want to list variables. |
String; URI parameter. |
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 Instance Variables (Show Variables): XML and JSON Response Examples
XML |
JSON |
---|---|
|
|
Release a Task Instance from Hold
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/release |
HTTP Method |
POST |
Description |
Releases the specified task instance from hold. |
Authentication |
HTTP Basic |
Example URI |
http://localhost:8080/uc/resources/taskinstance/release |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
See Release a Task Instance from Hold: XML and JSON Examples. |
Request Properties |
|
Example Response |
See Release a Task Instance from Hold: XML and JSON Examples. |
Release a Task Instance from Hold: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Release a Task Instance from Hold: 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 Iinstance (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 |
For Workflow task instances only; Specification for whether or not to release from hold all children task instances of the task instance. |
Boolean; Valid values: true/false. Default is false. |
N |
|
|
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 |
Rerun a Task Instance
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/rerun |
HTTP Method |
POST |
Description |
Rerun a task instance. |
Example URI |
http://localhost:8080/uc/resources/taskinstance/rerun |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
Rerun a Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Rerun 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 |
|
|
|
n/a |
Indication of whether or not tasks within sub-workflows will qualify for rerun. |
Valid values: true/false. Default is false. |
N |
|
|
Status |
If matched task instance is workflow type; List of comma-separated status codes or case-insensitive status names. All tasks within the matching workflow with a matching status will be queued for rerun. |
Valid statuses:
|
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 |
Retrieve Task Instance Output
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/retrieveoutput |
HTTP Method |
GET |
Description |
Retrieves the output of a task instance. Note When Universal Controller requests the output from the associated Agent, only the output type specified by the outputtype property will be requested. However, the Universal Controller response will also include any output previously associated with the task instance in the database, regardless of output type. |
Example URI |
|
Consumes Content-Type |
n/a |
Produces Content-Type |
application/xml, application/json |
Example URI Properties |
|
Example Response |
See Retrieve Task Instance Output: XML and JSON Response Examples. |
Retrieve Task Instance Output: XML and JSON Response Examples
XML |
JSON |
---|---|
|
|
Retrieve Task Instance Output: Example URI Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
n/a |
Used if |
String; URI parameter. 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 |
|
|
Number of Lines |
Number of lines to retrieve. |
Integer |
N |
|
|
Output Type |
Type of task instance output to retrieve. |
String; URI parameter. Valid values:
Default is OUTERR (0). |
Y |
|
|
Scan Text |
Scan the data for the text specified and retrieve only that. |
String; URI parameter. |
N |
|
|
Start Line |
Retrieve data beginning at the line indicated. |
Integer; URI parameter. Default is 1. |
N |
|
|
UUID |
UUID of the task instance for which you want to retrieve output. |
String; URI parameter. |
Y |
|
|
Instance Name |
Name of the task instance for which you want to retrieve output. |
String; URI parameter. |
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 |
Set or Modify Wait Time/Duration for Task Instance
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/settimewait |
HTTP Method |
POST |
Description |
Sets or modifies a wait time/duration for a task instance. |
Authentication |
HTTP Basic |
Example URI |
http://localhost:8080/uc/resources/taskinstance/settimewait |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
See Set or Modify Wait Time/Duration for Task Instance: XML and JSON Examples. |
Request Properties |
See Set or Modify Wait Time/Duration for Task Instance: Request Properties. |
Example Response |
See Set or Modify Wait Time/Duration for Task Instance: XML and JSON Examples. |
Set or Modify Wait Time/Duration for Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Set or Modify Wait Time/Duration for 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 |
|
|
Delay Duration |
If |
Format: DD:HH:MM:SS |
Y |
|
|
Delay Duration In Seconds |
If |
Format: SS |
Y |
|
|
Delay On Start |
Amount of time to delay the start of a task once it is eligible to start. |
Valid values:
|
Y |
|
|
n/a |
sys_id used within the Controller to identify this task instance. |
Y |
|
|
|
Instance Name |
Name of the task instance |
Y |
|
|
|
Wait Day Constraint |
If |
Valid values:
|
N |
|
|
Wait Duration |
If |
Format: DD:HH:MM:SS |
Y |
|
|
Wait Duration In Seconds |
If |
Format: SS |
Y |
|
|
Wait Time |
If |
Format: HH:MM |
Y |
|
|
Wait To Start |
Amount of time to wait before starting a task after it has been launched. |
Valid values:
|
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 |
Set Priority for a Task Instance
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/setpriority |
HTTP Method |
POST |
Description |
Set priority for a task instance (Linux/Unix, Windows, Universal, or z/OS). |
Example URI |
http://localhost:8080/uc/resources/taskinstance/setpriority |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
See Set Priority for a Task Instance: XML and JSON Examples. |
Request Properties |
|
Example Response |
See Set Priority for a Task Instance: XML and JSON Examples. |
Set Priority for a Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Set Priority for 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 |
|
|
|
n/a |
Sets the priority for this task instance. |
Valid values: low, medium, high; Case-insensitive. |
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 |
Skip a Task Instance
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/skip |
HTTP Method |
POST |
Description |
Skip a task instance. |
Example URI |
http://localhost:8080/uc/resources/taskinstance/skip |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
Skip a Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Skip 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 |
Skip a Task Instance Path
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/skippath |
HTTP Method |
POST |
Description |
Skip a task instance and all of its dependent task instances. |
Example URI |
http://localhost:8080/uc/resources/taskinstance/skippath |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
Skip a Task Instance Path: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Skip a Task Instance Path: 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 |
Unskip a Task Instance
Description |
|
---|---|
URI |
http://host_name/uc/resources/taskinstance/unskip |
HTTP Method |
POST |
Description |
Unskip a task instance. |
Example URI |
http://localhost:8080/uc/resources/taskinstance/unskip |
Authentication |
HTTP Basic |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
application/xml, application/json |
Example Request |
|
Request Properties |
|
Example Response |
Unskip a Task Instance: XML and JSON Examples
Examples |
XML |
JSON |
---|---|---|
Example Request |
|
|
Example Response |
|
|
Unskip 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 |
Update a Task Instance Operational Memo
Description |
|
---|---|
URI |
|
HTTP Method |
PUT |
Description |
Update the operational memo for a task instance record. |
Example URI |
|
Authentication |
HTTP Basic |
Consumes Content-Type |
text/plain |
Produces Content-Type |
text/plain |
Example URI Properties |
See Update a Task Instance Operational Memo: Example URI Properties. |
Example Request Body | See Update a Task Instance Operational Memo: Text/Plain Examples. |
Example Response Body | See Update a Task Instance Operational Memo: Text/Plain Examples. |
Update a Task Instance Operational Memo: Text/Plain Examples
Examples |
Text/Plain |
---|---|
Example Request Body |
Ticket# 15243
|
Example Response Body |
Updated the operational memo for record with task instance id 15832561207058159886SCGSSDF53H7Q. |
Update a Task Instance Operational Memo: Example URI Properties
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
|
---|---|---|---|---|---|
|
n/a |
Used if |
String; URI parameter. Valid values:
Default is Oldest Active Instance (1). |
N |
|
|
UUID |
UUID of the task instance for which you want to update the Operational Memo. |
String; URI parameter. |
Y |
|
|
Instance Name |
Name of the task instance for which you want to update the Operational Memo. |
String; URI parameter. |
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 |