Panel

Table of Contents

maxlevel	1

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	agentName - LTI
	agentName - LTI

agentName

Agent

Name of the agent that this task instances is assigned to run on.

N

Anchor

	businessServices - LTI
	businessServices - LTI

businessServices

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N

Anchor

	customField1 - LTI
	customField1 - LTI

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

Anchor

	customField2 - LTI
	customField2 - LTI

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 - LTI
	executionUser - LTI

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 - LTI
	instanceNumber - LTI

instanceNumber

Instance Number

Sequentially assigned number, maintained per task, representing the creation order of the instance.

Integer value.

N

Anchor

	late - LTI
	late - LTI

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 - LTI
	lateEarly - LTI

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 - LTI
	name - LTI

name

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

operationalMemo Operational Memo User-defined operational memo. N

sort

n/a

Sort task instances by a specified field and direction.

The sort field can be either startTime (default) or updatedTime.

The sort direction can be either ASC (ascending - default) or DESC (descending).

If sort is not included in the request payload, the legacy default behavior applies: the results will be sorted by startTime ASC (ascending start time).

Note

title	Note

If the sort is specified in the request payload, but both the field and direction are left unspecified, no sort on the startTime or the updatedTime will be applied.

N

Anchor

	status - LTI
	status - LTI

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 - LTI
	statusDescription - LTI

statusDescription

Status Description

Description (if any) of the current status of the Task Instance.

Wildcards are supported.

N

Anchor

	sysId - LTI
	sysId - LTI

sysId

n/a

sys_id used within the Controller to identify a task instance.

Y
(unless name
is specified)

name

Anchor

	taskId - LTI
	taskId - LTI

taskId

n/a

sys_id of the task definition that this Task Instance was created from.

N

taskName

Anchor

	taskName - LTI
	taskName - LTI

taskName

n/a

Name of the task definition that this Task Instance was created from.

N

taskId

Anchor

	templateId - LTI
	templateId - LTI

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

Anchor

	templateName - LTI
	templateName - LTI

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

Anchor

	triggerId - LTI
	triggerId - LTI

triggerId

n/a

sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger).

N

triggerName

Anchor

	triggerName - LTI
	triggerName - LTI

triggerName

n/a

Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.)

N

triggerId

Anchor

	type - LTI
	type - LTI

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

	updateTime - LTI
	updateTime - LTI

updatedTime

n/a

If updatedTimeType = Offset; -offset period.

Valid values:

mn (minutes)

h (hours)

d (days)

Default is d.

Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days).

If updatedTimeType is Since; date/time value
( yyyy-MM-dd [HH:mm:ss] )

If 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

title	Note

The time is relative to the Time Zone specified for the User.

Y
(if updatedTimeType
is Offset, Since,
or Older Than.)

Anchor

	updatedTimeType - LTI
	updatedTimeType - LTI

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
As String = Between, As Value = 5

N

Anchor

	workflowDefinitionId - LTI
	workflowDefinitionId - LTI

workflowDefinitionId

n/a

sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).

N

workflowDefinitionName

Anchor

	workflowDefinitionName - LTI
	workflowDefinitionName - LTI

workflowDefinitionName

n/a

Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).

N

workflowDefinitionId

Anchor

	workflowInstanceCriteria - LTI
	workflowInstanceCriteria - LTI

workflowInstanceCriteria

n/a

Specification for how workflowInstanceName finds the matching workflow.

Valid values:

As String = Oldest Active Instance, As Value = 1
As String = Newest Active Instance, As Value = 2
As String = Oldest Instance, As Value = 3
As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).

Note

title	Note

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).

N

Anchor

	workflowInstanceId - LTI
	workflowInstanceId - LTI

workflowInstanceId

n/a

sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed.

N

workflowInstanceName

Anchor

	workflowInstanceName - LTI
	workflowInstanceName - LTI

workflowInstanceNameworkflowinstancename

Workflow

Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed.

N

workflowInstanceId

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	agentName - LTI
	agentName - LTI

agentName

Agent

Name of the agent that this task instances is assigned to run on.

N

Anchor

	businessServices - LTI
	businessServices - LTI

businessServices

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N

Anchor

	customField1 - LTI
	customField1 - LTI

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

Anchor

	customField2 - LTI
	customField2 - LTI

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 - LTI
	executionUser - LTI

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 - LTI
	instanceNumber - LTI

instanceNumber

Instance Number

Sequentially assigned number, maintained per task, representing the creation order of the instance.

Integer value.

N

instanceOutputType

Output Type

Type of task instance output to retrieve.

String; Valid values:

As String = STDOUT, As Value = 1
As String = STDERR, As Value = 2
As String = FILE, As Value = 3
As String = JOBLOG, As Value = 4
As String = SCRIPT, As Value = 5
As String = SAP JOBDEF, As Value = 6
As String = SAP JOBSTAT, As Value = 7
As String = SAP JOBLOG, As Value = 8
As String = SAP SPOOLLIST, As Value = 9
As String = SAP PURGE, As Value = 10
As String = SAP ABORT, As Value = 11
As String = SAP INTERRUPT, As Value = 12
As String = SAP CHAIN - PLAN, As Value = 13
As String = SAP CHAIN - INSTANCE, As Value = 14
As String = SAP CHAINSTAT, As Value = 15
As String = SAP CHAINLOG, As Value = 16
As String = SAP CHAIN RESTART, As Value = 17
As String = WEB SERVICE, As Value = 18
As String = EXTENSION, As Value = 19
As String = COMMAND, As Value = 20
As String = SQL, As Value = 21
As String = STOREDPROC, As Value = 22
As String = EXCLUDE (excludes output from response)
Default is All

N

Anchor

	late - LTI
	late - LTI

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 - LTI
	lateEarly - LTI

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 - LTI
	name - LTI

name

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

operationalMemo Operational Memo User-defined operational memo. N

responseFields

N/A

Allowed Response fields

Comma separated list of any of the following fields can be viewed.

Note

"*" returns all fields listed below.

If left empty, the default fields will be returned.

sysId - Default
name - Default
type
status
operationalMemo
triggerTime
launchTime
queuedTime
startTime
endTime
updatedTime
triggeredBy
lateStart
lateFinish
earlyFinish
startedLate
finishedLate
finishedEarly
exitCode
executionUser
agent
credentials
instanceNumber
taskId
taskName
sourceVersion
triggerId
triggerName
workflowDefinitionId
workflowDefinitionName
workflowInstanceId
workflowInstanceName
statusDescription
businessServices
customField1
customField2
progress
extensionStatus
templateId
templateName

N

sort

n/a

Sort task instances by a specified field and direction.

The sort field can be either startTime (default) or updatedTime.

The sort direction can be either ASC (ascending - default) or DESC (descending).

If sort is not included in the request payload, the legacy default behavior applies: the results will be sorted by startTime ASC (ascending start time).

Note

title	Note

If the sort is specified in the request payload, but both the field and direction are left unspecified, no sort on the startTime or the updatedTime will be applied.

N

Anchor

	status - LTI
	status - LTI

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 - LTI
	statusDescription - LTI

statusDescription

Status Description

Description (if any) of the current status of the Task Instance.

Wildcards are supported.

N

Anchor

	sysId - LTI
	sysId - LTI

sysId

n/a

sys_id used within the Controller to identify a task instance.

Y
(unless name
is specified)

name

Anchor

	taskId - LTI
	taskId - LTI

taskId

n/a

sys_id of the task definition that this Task Instance was created from.

N

taskName

Anchor

	taskName - LTI
	taskName - LTI

taskName

n/a

Name of the task definition that this Task Instance was created from.

N

taskId

Anchor

	templateId - LTI
	templateId - LTI

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

Anchor

	templateName - LTI
	templateName - LTI

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

Anchor

	triggerId - LTI
	triggerId - LTI

triggerId

n/a

sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger).

N

triggerName

Anchor

	triggerName - LTI
	triggerName - LTI

triggerName

n/a

Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.)

N

triggerId

Anchor

	type - LTI
	type - LTI

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

	updateTime - LTI
	updateTime - LTI

updatedTime

n/a

If updatedTimeType = Offset; -offset period.

Valid values:

mn (minutes)
h (hours)
d (days)

Default is d.

Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days).

If updatedTimeType is Since; date/time value
( yyyy-MM-dd [HH:mm:ss] )

If 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

title	Note

The time is relative to the Time Zone specified for the User.

Y
(if updatedTimeType
is Offset, Since,
or Older Than.)

Anchor

	updatedTimeType - LTI
	updatedTimeType - LTI

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
As String = Between, As Value = 5

N

Anchor

	workflowDefinitionId - LTI
	workflowDefinitionId - LTI

workflowDefinitionId

n/a

sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).

N

workflowDefinitionName

Anchor

	workflowDefinitionName - LTI
	workflowDefinitionName - LTI

workflowDefinitionName

n/a

Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).

N

workflowDefinitionId

Anchor

	workflowInstanceCriteria - LTI
	workflowInstanceCriteria - LTI

workflowInstanceCriteria

n/a

Specification for how workflowInstanceName finds the matching workflow.

Valid values:

As String = Oldest Active Instance, As Value = 1
As String = Newest Active Instance, As Value = 2
As String = Oldest Instance, As Value = 3
As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).

Note

title	Note

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).

N

Anchor

	workflowInstanceId - LTI
	workflowInstanceId - LTI

workflowInstanceId

n/a

sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed.

N

workflowInstanceName

Anchor

	workflowInstanceName - LTI
	workflowInstanceName - LTI

workflowInstanceName

Workflow

Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed.

N

workflowInstanceId

...

XML

JSON

Expand

title	XML

<showVariables>
    <instanceName>Complete_Order</instanceName>
    <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
    <status>Running</status>
    <statusDescription></statusDescription>
    <invokedBy>Workflow: Submit_Order_Sub_Workflow</invokedBy>
    <executionUser>ops.admin</executionUser>
    <variables>
        <variable>
            <name>ops_agent_id</name>
            <value>c140722e9a744fcfb648388aa1d7f733</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_attempt</name>
            <value>1</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_avg_estimated_end_time</name>
            <value>2018-10-25 16:49:30 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_hostname</name>
            <value>jmwin7</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_id</name>
            <value>jmwin7:9081-ops6204</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_ipaddr</name>
            <value>10.253.1.49</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_mode</name>
            <value>Active</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_name</name>
            <value>jmwin7:9081-ops6204</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_start_time</name>
            <value>2018-10-25 14:46:33 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_uptime</name>
            <value>2 Hours 1 Minute 5 Seconds</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cmd</name>
            <value>C:\orders\bin\do_order.bat</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cmd_parms</name>
            <value>C:\orders\342\67.csv</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_custom_field1</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_custom_field2</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_description</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_execution_user</name>
            <value>ops.admin</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_exit_code</name>
            <value>0</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_highest_estimated_end_time</name>
            <value>2018-10-25 16:53:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_launch_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_lowest_estimated_end_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_queued_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_retry_count</name>
            <value>0</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_retry_interval</name>
            <value>60</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_retry_maximum</name>
            <value>0</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_script_id</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_script_name</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_script_parms</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_start_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_status</name>
            <value>RUNNING</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_status_description</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_system_identifier</name>
            <value>DEV</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_id</name>
            <value>1540493193934844131JT6DW8IKYH2MM</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_name</name>
            <value>Complete_Order</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_ref_count</name>
            <value>2</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_time_zone</name>
            <value>America/New_York</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_type</name>
            <value>Windows</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_type_value</name>
            <value>3</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_top_level_workflow_id</name>
            <value>1540493193934840131AAC49YBBVB4BB</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_vertex_id</name>
            <value>2</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_workflow_id</name>
            <value>1540493193934842131RCD2RVA6OQX9G</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_workflow_name</name>
            <value>Submit_Order_Sub_Workflow</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>order_file</name>
            <value>C:\orders\${client_no}\${order_no}.csv</value>
            <valueResolved>\orders\342\67.csv</valueResolved>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>order_no</name>
            <value>67</value>
            <instanceName>Submit_Order_Sub_Workflow</instanceName>
            <instanceId>1540493193934842131RCD2RVA6OQX9G</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>recipients</name>
            <value>${client_contact},orders@stonebranch.com</value>
            <valueResolved>client@stonebranch.com,orders@stonebranch.com</valueResolved>
            <instanceName>Submit_Order_Sub_Workflow</instanceName>
            <instanceId>1540493193934842131RCD2RVA6OQX9G</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>client_contact</name>
            <value>client@stonebranch.com</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>client_no</name>
            <value>342</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>ops_time_zone</name>
            <value>America/New_York</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>ops_trigger_name</name>
            <value>Client_Workflow #TRIGGER#</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>ops_trigger_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>ops_trigger_time_tz</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>recipients</name>
            <value>${client_contact}</value>
            <valueResolved>client@stonebranch.com</valueResolved>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>false</inherited>
        </variable>
        <variable>
            <name>DATE_YYYY_MM_DD</name>
            <value>${_date('yyyy-MM-dd')}</value>
            <valueResolved>2018-10-25</valueResolved>
            <inherited>true</inherited>
        </variable>
    </variables>
</showVariables>

Expand

title	JSON

{
    "instanceName": "Complete_Order",
    "instanceId": "1540493193934844131JT6DW8IKYH2MM",
    "status": "Running",
    "statusDescription": "",
    "invokedBy": "Workflow: Submit_Order_Sub_Workflow",
    "executionUser": "ops.admin",
    "variables": [
        {
            "name": "ops_agent_id",
            "value": "c140722e9a744fcfb648388aa1d7f733",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_attempt",
            "value": "1",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_avg_estimated_end_time",
            "value": "2018-10-25 16:49:30 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_hostname",
            "value": "jmwin7",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_id",
            "value": "jmwin7:9081-ops6204",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_ipaddr",
            "value": "10.253.1.49",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_mode",
            "value": "Active",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_name",
            "value": "jmwin7:9081-ops6204",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_start_time",
            "value": "2018-10-25 14:46:33 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_uptime",
            "value": "2 Hours 2 Minutes 5 Seconds",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cmd",
            "value": "C:\\orders\\bin\\do_order.bat",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cmd_parms",
            "value": "C:\\orders\\342\\67.csv",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_custom_field1",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_custom_field2",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_description",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_execution_user",
            "value": "ops.admin",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_exit_code",
            "value": "0",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_highest_estimated_end_time",
            "value": "2018-10-25 16:53:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_launch_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_lowest_estimated_end_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_queued_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_retry_count",
            "value": "0",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_retry_interval",
            "value": "60",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_retry_maximum",
            "value": "0",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_script_id",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_script_name",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_script_parms",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_start_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_status",
            "value": "RUNNING",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_status_description",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_system_identifier",
            "value": "DEV",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_id",
            "value": "1540493193934844131JT6DW8IKYH2MM",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_name",
            "value": "Complete_Order",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_ref_count",
            "value": "2",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_time_zone",
            "value": "America/New_York",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_type",
            "value": "Windows",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_type_value",
            "value": "3",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_top_level_workflow_id",
            "value": "1540493193934840131AAC49YBBVB4BB",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_vertex_id",
            "value": "2",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_workflow_id",
            "value": "1540493193934842131RCD2RVA6OQX9G",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_workflow_name",
            "value": "Submit_Order_Sub_Workflow",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "order_file",
            "value": "C:\\orders\\${client_no}\\${order_no}.csv",
            "valueResolved": "\\orders\\342\\67.csv",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "order_no",
            "value": "67",
            "instanceName": "Submit_Order_Sub_Workflow",
            "instanceId": "1540493193934842131RCD2RVA6OQX9G",
            "inherited": true
        },
        {
            "name": "recipients",
            "value": "${client_contact},orders@stonebranch.com",
            "valueResolved": "client@stonebranch.com,orders@stonebranch.com",
            "instanceName": "Submit_Order_Sub_Workflow",
            "instanceId": "1540493193934842131RCD2RVA6OQX9G",
            "inherited": true
        },
        {
            "name": "client_contact",
            "value": "client@stonebranch.com",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "client_no",
            "value": "342",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "ops_time_zone",
            "value": "America/New_York",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "ops_trigger_name",
            "value": "Client_Workflow #TRIGGER#",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "ops_trigger_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "ops_trigger_time_tz",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "recipients",
            "value": "${client_contact}",
            "valueResolved": "client@stonebranch.com",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": false
        },
        {
            "name": "DATE_YYYY_MM_DD",
            "value": "${_date('yyyy-MM-dd')}",
            "valueResolved": "2018-10-25",
            "inherited": true
        }
    ]
}

Anchor

	Release Read a Task Instance from HoldRelease
	Read a Task Instance from Hold

...

Read a Task Instance

...

Description
URI
http://host_name/uc/resources/taskinstance
/release
HTTP Method
POSTReleasing a Task Instance from
GET
Description
Releases the specified task instance from hold.

For Workflow task instances, if the `recursive` property is set to true, all children task instances will be released from hold.

See
Read a Task instance
Authentication
HTTP Basic
Example URI
http://localhost:8080/uc/resources/taskinstance?taskinstanceid=1732128562210071957E1725WW8Q0UVU
http://localhost:8080/uc/resources/taskinstance?criteria=4&taskinstancename=task-1
http://localhost:8080/uc/resources/taskinstance?criteria=4&taskinstancename=task-1&includeOutput=true
Consumes Content-Type
n/a
Produces Content-Type
application/xml, application/json
Request Properties
See Read a Task Instance: Request Properties
Example Response
Status 200
Successful response.
See Task Instance Read Web Service Responses
Status 400
Error message.
Status 403
Operation prohibited due to security constraints.
Status 404
A task with name “{name}” does not exist.
A task with id "{uuid}" does not exist.
Status 500
Unexpected request failure. See log(s) for more details.
Anchor
Read a Task Instance Request Properties
Read a Task Instance Request Properties

Read a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	criteria - READ
	criteria - READ

criteria

n/a

Used if taskinstancename is specified; Specific task instance with specified criteria record will be read

String; URI parameter. Valid values:

As String = Oldest Active Instance, As Value = 1
As String = Newest Active Instance, As Value = 2
As String = Oldest Instance, As Value = 3
As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).

N

Anchor

	includeOutput - READ
	includeOutput - READ

includeOutput

n/a

Specifies whether or not to include the output details

true|false (default: false)

N

Anchor

	taskinstanceid - READ
	taskinstanceid - READ

taskinstanceid

UUID

Unique ID for this task instance.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor

	taskinstancename - READ
	taskinstancename - READ

taskinstancename

Instance Name

Name of the task instance.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor

	workflowInstanceName - READ
	workflowInstanceName - READ

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

	Release a Task Instance from Hold
	Release a Task Instance from Hold

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. For Workflow task instances, if the `recursive` property is set to true, all children task instances will be released from hold. See Releasing a Task Instance from Hold for a description of behavior and restrictions.
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	See Release a Task Instance from Hold: Request Properties
Example Response	See Release a Task Instance from Hold: XML and JSON Examples.

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	criteria - RET
	criteria - RET

criteria

n/a

Used if taskinstancename is specified; Specific task instance with this taskinstancename.

String; URI parameter. Valid values:

As String = Oldest Active Instance, As Value = 1
As String = Newest Active Instance, As Value = 2
As String = Oldest Instance, As Value = 3
As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).

Note

title	Note

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).

N

Anchor

	numlines - RET
	numlines - RET

numlines

Number of Lines

Number of lines to retrieve.

Integer

N

Anchor

	outputtype - RET
	outputtype - RET

outputtype

Output Type

Type of task instance output to retrieve.

String; URI parameter. Valid values:

As String = OUTERR, As Value = 0
As String = STDOUT, As Value = 1
As String = STDERR, As Value = 2

Default is OUTERR (0).

Y
(except for z/OS
task instances:
output defaults to
z/OS joblog)

Anchor

	scantext - RET
	scantext - RET

scantext

Scan Text

Scan the data for the text specified and retrieve only that.

String; URI parameter.

N

Anchor

	startline - RET
	startline - RET

startline

Start Line

Retrieve data beginning at the line indicated.

Integer; URI parameter. Default is 1.

N

Anchor

	taskinstanceid - RET
	taskinstanceid - RET

taskinstanceid

UUID

UUID of the task instance for which you want to retrieve output.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor

	taskinstancename - RET
	taskinstancename - RET

taskinstancename

Instance Name

Name of the task instance for which you want to retrieve output.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor

	workflowInstanceName - RET
	workflowInstanceName - RET

workflowInstanceNameworkflowinstancename

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

Anchor

	criteria - LIST
	criteria - LIST

criteria

n/a

Used if taskinstancename is specified; Specific task instance with this taskinstancename.

String; URI parameter. Valid values:

As String = Oldest Active Instance, As Value = 1

As String = Newest Active Instance, As Value = 2

As String = Oldest Instance, As Value = 3

As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).

N

Anchor

	taskinstanceid - LIST
	taskinstanceid - LIST

taskinstanceid

UUID

UUID of the task instance for which you want to update the Operational Memo.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor

	taskinstancename - LIST
	taskinstancename - LIST

taskinstancename

Instance Name

Name of the task instance for which you want to update the Operational Memo.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor

	workflowInstanceName - LIST
	workflowInstanceName - LIST

workflowInstanceNameworkflowinstancename

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

...

Version	Old Version 4	New Version Current
Changes made by	Alec Berger	Alec Berger
Saved on	Jan 14, 2025	Jan 16, 2025

Versions Compared

Key

Read a Task Instance

Read a Task Instance: Request Properties

Release a Task Instance from Hold

Content Comparison

Versions Compared

Key

Read a Task Instance

Read a Task Instance: Request Properties

Release a Task Instance from Hold