Versions Compared

Old Version 11

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 12

changes.mady.by.user Stonebranch

Saved on

Key

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


Panel
Table of Contents
maxlevel1

...

Examples

XML

JSON

Example Request


Expand
titleXML
<generic-query-filter>
      <name><name>*</name>name>
      <type>Timer</type><type>Timer</type>
      <updatedTimeType>offset</updatedTimeType><updatedTimeType>offset</updatedTimeType>
      <updatedTime><updatedTime>-10d</updatedTime>updatedTime>
      <agentName>SBUS30<agentName>SBUS30 - AGNT0005</agentName>agentName>
      <businessServices>bService1<businessServices>bService1,bService2</businessServices>businessServices>
</generic-query-filter>
or
<generic-query-filter>
      <name><name>*</name>name>
      <templateId>16467DFG47231012663T2434FSAW342F</templateId><templateId>16467DFG47231012663T2434FSAW342F</templateId>
      <workflowid>1463438057231012663TP5JP5EA8O1YS</workflowid><workflowid>1463438057231012663TP5JP5EA8O1YS</workflowid>
</generic-query-filter>



Expand
titleJSON
All tasks in the last three minutes.
{
      "name": "*",
      "updatedTimeType": "offset",
      "updatedTime": "-3mn",
      "agentName": "SBUS30 - AGNT0005"
 }    

 Or

{
      "name": "*",
      "templateId": "b21c68bba02c43919d5a6d6042a3f082"
      "workflowid": "a21c68bba02c43919d5a6d6042a3f082"
}


Example Response


Expand
titleXML


<pre> &lt;tasks&gt;
<tasks>
    <task>
&lt;task&gt;
&lt;description&gt;description&lt;/description&gt;
<description>description</description>
&lt;name&gt;test
<name>test task
1&lt;/name&gt;
1</name>
&lt;sysID&gt;410d6c0bc0a801c901838d8ac43b3279&lt;/sysID&gt;
<sysID>410d6c0bc0a801c901838d8ac43b3279</sysID>
&lt;type&gt;Windows&lt;/type&gt;
<type>Windows</type>
&lt;version&gt;2&lt;/version&gt;
<version>2</version>
&lt;/task&gt;
</task>
&lt;task&gt;
<task>
&lt;description&gt;description&lt;/description&gt;
<description>description</description>
&lt;name&gt;test
<name>test task
2&lt;/name&gt;
2</name>
&lt;sysID&gt;410d6880c0a801c90196685fcc1ecb47&lt;/sysID&gt;
<sysID>410d6880c0a801c90196685fcc1ecb47</sysID>
&lt;type&gt;Windows&lt;/type&gt;
<type>Windows</type>
&lt;version&gt;9&lt;/version&gt;
<version>9</version>
&lt;/task&gt; &lt;/tasks&gt;
</task>
</
pre>
tasks>
Panel
Html bobswift




Expand
titleJSON


<pre> 
[ {
  "description": "Description",
  "name": "test task 1",
  "sysId": "371be743130a4b18a9fc49961650593c",
  "type": "Timer",
  "version": 23
}, {
  "description": "Description",
  "name": "test task 2",
  "sysId": "10d58f96ab2b42e69d7e9bdde2ed21a7",
  "type": "Timer",
  "version": 2
} ]
</pre>
 Panel
 Html bobswift


 Anchor
List Tasks Request Properties
List Tasks Request Properties
List Tasks: Request Properties
Property
UI Field Name
Description
Specifications
Required
Mutually Exclusive With
 Anchor
agentName - LT
agentName - LT
agentName
AgentAgent 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
name - LT
name - LT
name
Task Name
Name or partial name of one or more tasks.
Wildcards are supported.
N

 Anchor
templateId - LT
templateId - LT
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 - LT
templateName - LT
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
type - LT
type - LT
type
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 = 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
titleNote
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
AgentAgent 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.
/wiki/spaces/UC71x/pages/5215217 are supported.
N

 Anchor
templateId
templateId
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
templateName
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
type - LT
type - LT
type
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 = 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
titleNote
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
...