Content Comparison

Agent

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

N

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N

Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.)

User-defined task field 1.

Wildcards are supported.

N

Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.)

User-defined task field 2.

Wildcards are supported.

N

Execution User

Execution User of a task instance that determines the security context under which the task instance runs.

System-supplied.

N

Instance Number

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

Integer value.

N

Started Late / Finished Late

Indication of whether or not to list all task instances that started late or finished late.

Valid values: true/false.

N

Started Late / Finished Late / Finished Early

Indication of whether or not to list all task instances that started late, finished late, or finished early.

Valid values: true/false.

N

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

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).

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

Status Description

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

Wildcards are supported.

N

n/a

sys_id used within the Controller to identify a task instance.

Y
(unless name
is specified)

name

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

taskId

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

triggerId

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

n/a

If updatedTimeType = Offset; -offset period.

• mn (minutes)

• h (hours)

• d (days)

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

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

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

workflowDefinitionId

n/a

Specification for how workflowInstanceName finds the matching workflow.

N

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

workflowInstanceId

Agent

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

N

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N

Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.)

User-defined task field 1.

Wildcards are supported.

N

Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.)

User-defined task field 2.

Wildcards are supported.

N

Execution User

Execution User of a task instance that determines the security context under which the task instance runs.

System-supplied.

N

Instance Number

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

Integer value.

N

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

Started Late / Finished Late

Indication of whether or not to list all task instances that started late or finished late.

Valid values: true/false.

N

Started Late / Finished Late / Finished Early

Indication of whether or not to list all task instances that started late, finished late, or finished early.

Valid values: true/false.

N

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

responseFields

N/A

Allowed Response fields

N

Status

List of comma-separated task instance status codes and/or names (not case sensitive).

Specifying one or more statuses automatically excludes task instances in all other statuses.
 
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

Status Description

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

Wildcards are supported.

N

n/a

sys_id used within the Controller to identify a task instance.

Y
(unless name
is specified)

name

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

taskId

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

triggerId

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

n/a

If updatedTimeType = Offset; -offset period.

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

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

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

workflowDefinitionId

n/a

Specification for how workflowInstanceName finds the matching workflow.

N

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

workflowInstanceId