Panel | ||||
---|---|---|---|---|
|
...
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
predecessorName | n/a | Name of the predecessor task instance for which you want to clear dependency. | * = Clears dependencies from all predecessor task instances. | Y | ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||||||||
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 | ||||||||||||
executionUser | Execution User | Execution User of a task instance that determines the security context under which the task instance runs. | System-supplied. | N | ||||||||||||
instanceNumber | Instance Number | Sequentially assigned number, maintained per task, representing the creation order of the instance. | Integer value. | N | ||||||||||||
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 | ||||||||||||
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 | ||||||||||||
name | Instance name | Name or partial name of one or more task instances. | Wildcards are supported. | Y |
| |||||||||||
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. | N | ||||||||||||
statusDescription | Status Description | Description (if any) of the current status of the Task Instance. | Wildcards are supported. | N | ||||||||||||
sysId | n/a | sys_id used within the Controller to identify a task instance. | Y |
| ||||||||||||
taskId | n/a | sys_id of the task definition that this Task Instance was created from. | N |
| ||||||||||||
taskName | n/a | Name of the task definition that this Task Instance was created from. | N |
| ||||||||||||
templateId | 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 | |||||||||||
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 | |||||||||||
triggerId | n/a | sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). | N |
| ||||||||||||
triggerName | n/a | Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) | N |
| ||||||||||||
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. | N | ||||||||||||
updatedTime | n/a | If | Valid values:
Default is d. If
| 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 |
|
...
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 | ||||||||||||
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 | ||||||||||||
executionUser | Execution User | Execution User of a task instance that determines the security context under which the task instance runs. | System-supplied. | N | ||||||||||||
instanceNumber | 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 | ||||||||||||
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 | ||||||||||||
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 | ||||||||||||
name | 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.
| N | ||||||||||||
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. | N | ||||||||||||
statusDescription | Status Description | Description (if any) of the current status of the Task Instance. | Wildcards are supported. | N | ||||||||||||
sysId | n/a | sys_id used within the Controller to identify a task instance. | Y |
| ||||||||||||
taskId | n/a | sys_id of the task definition that this Task Instance was created from. | N |
| ||||||||||||
taskName | n/a | Name of the task definition that this Task Instance was created from. | N |
| ||||||||||||
templateId | 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 | |||||||||||
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 | |||||||||||
triggerId | n/a | sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). | N |
| ||||||||||||
triggerName | n/a | Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) | N |
| ||||||||||||
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. | N | ||||||||||||
updatedTime | 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])
| 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 |
|
...
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 | 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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 | 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 | 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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 | 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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
priorityType | n/a | Sets the priority for this task instance. | Valid values: low, medium, high; Case-insensitive. | 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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
| ||||||||||||
operationalMemo | Operational Memo | User-defined operational memo. | N | |||||||||||||
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 |
...