Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxlevel1

...

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

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/aID 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.NtemplateName

Anchor
templateName - LTI
templateName - LTI
templateName

Template NameName of a template.If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template.NtemplateId

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
titleNote

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
titleNote

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

...

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

  • 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

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

  • 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

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/aID 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.NtemplateName

Anchor
templateName - LTI
templateName - LTI
templateName

Template NameName of a template.If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template.NtemplateId

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
titleNote

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
titleNote

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

...