...
The following web services are common to all Task types:
Detailed information for each of these web services is provided on this page.
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|
| Anchor |
|---|
| agentName - LT |
|---|
| agentName - LT |
|---|
|
agentName | Agent | Agent on which this task was run. |
| N |
|
| Anchor |
|---|
| businessServices - LT |
|---|
| businessServices - LT |
|---|
|
businessServices | Member of Business Services | Business Services that this task belongs to. | Comma-separated list. | N |
|
| Task Name | Name or partial name of one or more tasks. | Wildcards are supported. | N |
|
| Anchor |
|---|
| templateId - LT |
|---|
| templateId - LT |
|---|
|
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 - LT |
|---|
| templateName - LT |
|---|
|
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 |
| n/a | Task Type of tasks to list. | Valid values: One of the following (not case sensitive): - As String = Workflow, As Value = 1
- As String = Timer, As Value = 2
- As String = Windows, As Value = 3
- As String = Linux/Unix, As Value = 4
- As String = z/OS, As Value = 5
- As String = Agent File Monitor, As Value = 6
- As String = Manual, As Value = 7
- As String = Email, As Value = 8
- As String = File Transfer, As Value = 9
- As String = SQL, As Value = 10
- As String = Remote File Monitor, As Value = 11
- As String = Task Monitor, As Value = 12
- As String = Stored Procedure, As Value = 13
- As String = Universal Command, As Value = 14
- As String = System Monitor, As Value = 15
- As String = Application Control, As Value = 16
- As String = SAP, As Value = 17
- As String = Variable Monitor, As Value = 18
- As String = Web Service, As Value = 19
- As String = Email Monitor, As Value = 20
- As String = PeopleSoft, As Value = 21
- As String = Recurring, As Value = 22
- As String = Universal Monitor, As Value = 23
- As String = IBM i, As Value = 24
- As String = z/OS Monitor, As Value = 25
- As String = Universal, As Value = 99
To list tasks for all task types, enter <type></type> in the request. | N |
|
| Anchor |
|---|
| updatedTime - LT |
|---|
| updatedTime - LT |
|---|
|
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 Today; updatedTime is ignored.
| Note |
|---|
| The time is relative to the Time Zone specified for the User. |
| Y
(if updatedTimeType
is Offset, Since,
or Older Than.) |
|
| Anchor |
|---|
| updatedTimeType - LT |
|---|
| updatedTimeType - LT |
|---|
|
updatedTimeType | n/a | Type of updateTime. | Valid values: - As String = Today, As Value = 1
- As String = Offset, As Value = 2
- As String = Since, As Value = 3
- As String = Older Than, As Value = 4
| N |
|
| Anchor |
|---|
| workflowid - LT |
|---|
| workflowid - LT |
|---|
|
workflowid | n/a | ID used within the Controller to identify a workflow. | If workflowid or workflowname is specified, List Tasks returns a list of tasks within that workflow. | N | workflowname
|
| Anchor |
|---|
| workflowname - LT |
|---|
| workflowname - LT |
|---|
|
workflowname | Task Name | Name of a workflow. | If workflowid or workflowname is specified, List Tasks returns a list of tasks within that workflow. | N | workflowid
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|
| Anchor |
|---|
| agentname - LT |
|---|
| agentname - LT |
|---|
|
agentname | Agent | Agent on which this task was run. |
| N |
|
| Anchor |
|---|
| businessServices - LT |
|---|
| businessServices - LT |
|---|
|
businessServices | Member of Business Services | Business Services that this task belongs to. | Comma-separated list. | N |
|
| Anchor |
|---|
| taskname - LT |
|---|
| taskname - LT |
|---|
|
taskname | Task Name | Name or partial name of one or more tasks. | Wildcards are supported. | N |
|
| 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 |
| 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 |
| n/a | Task Type of tasks to list. | Valid values: One of the following (not case sensitive): - As String = Workflow, As Value = 1
- As String = Timer, As Value = 2
- As String = Windows, As Value = 3
- As String = Linux/Unix, As Value = 4
- As String = z/OS, As Value = 5
- As String = Agent File Monitor, As Value = 6
- As String = Manual, As Value = 7
- As String = Email, As Value = 8
- As String = File Transfer, As Value = 9
- As String = SQL, As Value = 10
- As String = Remote File Monitor, As Value = 11
- As String = Task Monitor, As Value = 12
- As String = Stored Procedure, As Value = 13
- As String = Universal Command, As Value = 14
- As String = System Monitor, As Value = 15
- As String = Application Control, As Value = 16
- As String = SAP, As Value = 17
- As String = Variable Monitor, As Value = 18
- As String = Web Service, As Value = 19
- As String = Email Monitor, As Value = 20
- As String = PeopleSoft, As Value = 21
- As String = Recurring, As Value = 22
- As String = Universal Monitor, As Value = 23
- As String = IBM i, As Value = 24
- As String = z/OS Monitor, As Value = 25
- As String = Universal, As Value = 99
To list tasks for all task types, enter <type></type> in the request. | N |
|
| Anchor |
|---|
| updatedTime - LT |
|---|
| updatedTime - LT |
|---|
|
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 Today; updatedTime is ignored.
| Note |
|---|
| The time is relative to the Time Zone specified for the User. |
| Y
(if updatedTimeType
is Offset, Since,
or Older Than.) |
|
| Anchor |
|---|
| updatedTimeType - LT |
|---|
| updatedTimeType - LT |
|---|
|
updatedTimeType | n/a | Type of updateTime. | Valid values: - As String = Today, As Value = 1
- As String = Offset, As Value = 2
- As String = Since, As Value = 3
- As String = Older Than, As Value = 4
| N |
|
| Anchor |
|---|
| workflowiId - LT |
|---|
| workflowiId - LT |
|---|
|
workflowid | n/a | ID used within the Controller to identify a workflow. | If workflowid or workflowname is specified, List Tasks returns a list of tasks within that workflow. | N | workflowname
|
| Anchor |
|---|
| workflowname - LT |
|---|
| workflowname - LT |
|---|
|
workflowname | Task Name | Name of a workflow. | If workflowid or workflowname is specified, List Tasks returns a list of tasks within that workflow. | N | workflowid
|
...
