...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
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 |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
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 |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:Default is
Note |
Default is Oldest Active Instance (1).
| N | |||||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||||||
predecessorName | n/a | Name of the predecessor task instance for which you want to clear dependency. | * = Clears dependencies from all predecessor task instances. | Y | ||||||||||||||||
workflowinstancename 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 |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
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 |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
resourceName | n/a | Name of the virtual resource for which you want to clear dependency. | * = Clears dependencies from all virtual resources. | Y | ||||||||||||
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 |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Instance (3).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
recursive | 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 |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
halt | 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 | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
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 |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
halt | 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 | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename 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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename 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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:Default is
Note |
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| |||||||||||||
name | Instance Name | Name of the task instance. | Y |
| |||||||||||||
workflowinstancename 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 |
...
Examples | XML | JSON | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | agentName - LTI | agentName - LTI | Agent | Name of the agent that this task instances is assigned to run on. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | businessServices - LTI | businessServices - LTI | Member of Business Services | Business Services that this task instance belongs to. | Comma-separated list. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | customField1 - LTI | customField1 - LTI | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | customField2 - LTI | customField2 - LTI | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | executionUser - LTI | executionUser - LTI | Execution User | Execution User of a task instance that determines the security context under which the task instance runs. | System-supplied. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | instanceNumber - LTI | instanceNumber - LTI | Instance Number | Sequentially assigned number, maintained per task, representing the creation order of the instance. | Integer value. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | late - LTI | late - LTI | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | lateEarly - LTI | lateEarly - LTI | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | name - LTI | name - LTI | Instance name | Name or partial name of one or more task instances. | Wildcards are supported. | Y |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | status - LTI | status - LTI | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | statusDescription - LTI | statusDescription - LTI | Status Description | Description (if any) of the current status of the Task Instance
|
...
|
|
Anchor | ||||
---|---|---|---|---|
|
* Workflows cannot go to Failed status.
...
Description
...
URI
...
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
...
- http://host_name/uc/resources/taskinstance/showvariables?taskinstancename=Complete_Order
- http://host_name/uc/resources/taskinstance/showvariables?taskinstancename=Complete_Order&fetchglobal=true
- http://host_name/uc/resources/taskinstance/showvariables?taskinstanceid=1540493193934844131JT6DW8IKYH2MM
...
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.
...
UI Field Name
Description
Specifications
Required
Mutually Exclusive With
criteria
n/a
Used if taskinstancename
is specified; Specific task instance with this taskinstancename
.
String; URI parameter. Valid values:
Default is Oldest Active Instance (1).
N
taskinstanceid
UUID
UUID of the task instance for which you want to list variables.
String; URI parameter.
Y
(unless taskinstancename
is specified.)
taskinstancename
taskinstancename
Instance Name
Name of the task instance for which you want to list variables.
String; URI parameter.
Y
(unless taskinstanceid
is specified.)
taskinstanceid
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.
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agentName | Agent | Name of the agent that this task instances is assigned to run on. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
businessServices | Member of Business Services | Business Services that this task instance belongs to. | Comma-separated list. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customField1 | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sysId | n/a | sys_id used within the Controller to identify a task instance. | Y |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | taskId - LTI | taskId - LTI | n/a | sys_id of the task definition that this Task Instance was created from. | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | taskName - LTI | taskName - LTI | n/a | Name of the task definition that this Task Instance was created from. | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | triggerId - LTI | triggerId - LTI | n/a | sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | triggerName - LTI | triggerName - LTI | n/a | Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | type - LTI | type - LTI | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | updateTime - LTI | updateTime - LTI | n/a | If |
Note | ||
---|---|---|
| ||
The time is relative to the Time Zone specified for the User. |
Y
(if updatedTimeType
is Offset
, Since
,
or Older Than
.)
updatedTimeType
n/a
Type of updateTime
.
Valid values:
- As String = Today, As Value = 1
- As String = Offset, As Value = 2
- As String = Since, As Value = 3
- As String = Older Than, As Value = 4
N
Anchor
workflowDefinitionId
customField2
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
Anchor | ||||
---|---|---|---|---|
|
executionUser
Execution User
Execution User of a task instance that determines the security context under which the task instance runs.
System-supplied.
N
Anchor | ||||
---|---|---|---|---|
|
instanceNumber
Instance Number
Sequentially assigned number, maintained per task, representing the creation order of the instance.
Integer value.
N
Anchor | ||||
---|---|---|---|---|
|
late
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
Anchor | ||||
---|---|---|---|---|
|
lateEarly
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
Anchor | ||||
---|---|---|---|---|
|
name
Instance name
Name or partial name of one or more task instances.
Wildcards are supported.
Y
(unless sysId
is specified)
sysId
Anchor | ||||
---|---|---|---|---|
|
status
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.
To list task instances for all statuses, enter <status></status>
in the request.
To list task instances for all statuses except one or more specific statuses, enter the status code or name for each status to be excluded with a preceding exclamation mark ( ! ). For example, !200.
N
Anchor | ||||
---|---|---|---|---|
|
statusDescription
Status Description
Description (if any) of the current status of the Task Instance.
Wildcards are supported.
N
Anchor | ||||
---|---|---|---|---|
|
sysId
n/a
sys_id used within the Controller to identify a task instance.
Y
(unless name
is specified)
name
Anchor | ||||
---|---|---|---|---|
|
taskId
n/a
sys_id of the task definition that this Task Instance was created from.
N
taskName
Anchor | ||||
---|---|---|---|---|
|
taskName
n/a
Name of the task definition that this Task Instance was created from.
N
taskId
Anchor | ||||
---|---|---|---|---|
|
triggerId
n/a
sys_id of the parent workflow task definition for Trigger that launched the Task Instance (if it was invoked from a WorklfowTrigger).
N
workflowDefinitionName
triggerName
Anchor | ||||
---|---|---|---|---|
|
triggerName
n/a
Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.)
N
triggerId
workflowinstancename
finds the matching workflowAnchor | |||
---|---|---|---|
|
workflowDefinitionName
n/a
Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).
N
workflowDefinitionId
workflowInstanceCriteria
n/a
|
type
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.
To list task instances for all task types, enter <type></type>
in the request.
N
Anchor | ||||
---|---|---|---|---|
|
updatedTime
n/a
If updatedTimeType
= Offset; -offset period.
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
workflowInstanceId
n/a
sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed.
N
workflowInstanceName
workflowInstanceName
Workflow
Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed.
N
workflowInstanceId
...
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.
...
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.
...
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.
...
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
...
80
...
All
...
The task is running. For Agent-based tasks, the Agent has started running the program.
...
81
...
Workflow
...
One or more tasks within the workflow has one of the following statuses:
- Cancelled
- Confirmation Required
- Failure
- In Doubt
- Running/Problems (for sub-workflows)
- Start Failure
- Undeliverable
...
Skipped
...
180
...
All
...
The task was skipped by a user.
...
120
...
All
...
The task was unable to start.
...
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.
...
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.
...
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.
Default is d.
| Y | |||||||||||||||
updatedTimeType | n/a | Type of | Valid values:
| N | ||||||||||||
workflowDefinitionId | n/a | sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowDefinitionName | n/a | Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowInstanceCriteria | n/a | Specification for how | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
workflowInstanceId | n/a | sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
| ||||||||||||
workflowInstanceName | Workflow | Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
|
Anchor | ||||
---|---|---|---|---|
|
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. | ||||||
| 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. | ||||||
| 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. | ||||||
| 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 | ||||||
| 80 | All | The task is running. For Agent-based tasks, the Agent has started running the program. | ||||||
| 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. | ||||||
| 120 | All | The task was unable to start. | ||||||
| 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. | ||||||
| 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. | ||||||
| 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.
Anchor | ||||
---|---|---|---|---|
|
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. |
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Used if | String; URI parameter. Valid values:
Default is Oldest Active Instance (1). | N | |||||||
taskinstanceid | UUID | UUID of the task instance for which you want to list variables. | String; URI parameter. | Y |
| ||||||
taskinstancename | Instance Name | Name of the task instance for which you want to list variables. | String; URI parameter. | Y |
| ||||||
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 |
Anchor | ||||
---|---|---|---|---|
|
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Iinstance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance | Y |
| ||||||||||||
recursive | 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 | ||||||||||||
workflowinstancename 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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
recursive | n/a | Indication of whether or not tasks within sub-workflows will qualify for rerun. | Valid values: true/false. Default is false. | N | ||||||||||||
taskStatus | 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 | ||||||||||||
workflowinstancename 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 |
...
Description | ||||||
---|---|---|---|---|---|---|
URI | http://host_name/uc/resources/taskinstance/retrieveoutput | |||||
HTTP Method | GET | |||||
Description | Retrieves the output of a task instance.
| |||||
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. |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Used if | String; URI parameter. Valid values:Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
numlines | Number of Lines | Number of lines to retrieve. | Integer | N | ||||||||||||
outputtype | Output Type | Type of task instance output to retrieve. | String; URI parameter. Valid values:
Default is OUTERR (0). | Y | ||||||||||||
scantext | Scan Text | Scan the data for the text specified and retrieve only that. | String; URI parameter. | N | ||||||||||||
startline | Start Line | Retrieve data beginning at the line indicated. | Integer; URI parameter. Default is 1. | N | ||||||||||||
taskinstanceid | UUID | UUID of the task instance for which you want to retrieve output. | String; URI parameter. | Y |
| |||||||||||
taskinstancename | Instance Name | Name of the task instance for which you want to retrieve output. | String; URI parameter. | Y |
| |||||||||||
workflowinstancename 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 |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
delayDuration | Delay Duration | If | Format: DD:HH:MM:SS | Y | ||||||||||||
delaySeconds | Delay Duration In Seconds | If | Format: SS | Y | ||||||||||||
delayType | Delay On Start | Amount of time to delay the start of a task once it is eligible to start. | Valid values:
| Y | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance | Y |
| ||||||||||||
waitDayConstraint | Wait Day Constraint | If | Valid values:
| N | ||||||||||||
waitDuration | Wait Duration | If | Format: DD:HH:MM:SS | Y | ||||||||||||
waitSeconds | Wait Duration In Seconds | If | Format: SS | Y | ||||||||||||
waitTime | Wait Time | If | Format: HH:MM | Y | ||||||||||||
waitType | Wait To Start | Amount of time to wait before starting a task after it has been launched. | Valid values:
| Y | ||||||||||||
workflowinstancename 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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
priorityType | n/a | Sets the priority for this task instance. | Valid values: low, medium, high; Case-insensitive. | Y | ||||||||||||
workflowinstancename 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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename 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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename 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 |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename 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 |
...
UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Used if | String; URI parameter. Valid values:
Default is Oldest Active Instance (1). | N | |||||||
taskinstanceid | UUID | UUID of the task instance for which you want to update the Operational Memo. | String; URI parameter. | Y |
| ||||||
taskinstancename | Instance Name | Name of the task instance for which you want to update the Operational Memo. | String; URI parameter. | Y |
| ||||||
workflowinstancename 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 |
...