Versions Compared

Old Version 15

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version 16

changes.mady.by.user Stonebranch

Saved on

Key

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

...

>
<name>Timer 0</name>
&lt;

timeZone

Examples

XML

JSON

Example Request for Task


<pre> &lt;task-launch&gt;
<task-launch>
&lt;

variables

/&gt;
<variables/>
&lt;
<virtual-resources
 /
&gt;
>
&lt;

name

Expand
titleXML
Panel
Html bobswift
Html bobswift
Html bobswift
Html bobswift
&gt;Timer 0&lt;

/name

Html bobswift
Html bobswift
&gt;America/Halifax&lt;

/timeZone

Html bobswift&gt;
<timeZone>America/Halifax</timeZone>
&lt;

virtualResourcePriority

Html bobswift
&gt;10&lt;

/virtualResourcePriority

Html bobswift&gt;
<virtualResourcePriority>10</virtualResourcePriority>
&lt;

hold

Html bobswift
&gt;yes&lt;

/hold

Html bobswift&gt;
<hold>yes</hold>
&lt;

holdReason

Html bobswift&gt;Waiting
<holdReason>Waiting for
input&lt;
input</holdReason
Html bobswift&gt; &lt;
>
</task-
launch&gt; </pre>
launch>



<pre>

variables

{
    "
variables": null, 
    "
virtual-resources
": null, 
    "
name
": "Timer 0",
    "
timeZone
": "America/Halifax",
    "
virtualResourcePriority
": 10,
    "
hold
": "yes",
    "
holdReason
": "Waiting for input"
}
</pre>
 Expand
titleJSON
 Panel
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

Example Request for Task-Related Records

<pre>
&lt;variables&gt;
<variables>
   <variable>

&lt;variable&gt;
         
 &lt;
name
 Expand
titleXML
 Anchor
Variables for Task-Related Records
Variables for Task-Related Records
Variables
 Panel
 Html bobswift
 Html bobswift
&gt;testVar&lt;
/name
 Html bobswift&gt;
<name>testVar</name>
         
&lt;
value
 Html bobswift
&gt;value&lt;
/value
 Html bobswift&gt;
<value>value</value>
   
&lt;/variable&gt;
&lt;/variables&gt;
</pre>
</variable>
</variables>
 Anchor
Virtual Resources for Task-Related Records
Virtual Resources for Task-Related Records
Virtual Resources
 Panel Html bobswift<pre>
&lt;virtual-resources&gt;
<virtual-resources> 
    
 &lt;virtual-resource&gt;
<virtual-resource>
        
&lt;
name
 Html bobswift&gt;uc
<name>uc - 
Solo&lt;
Solo</name
 Html bobswift&gt;
>
        
&lt;
limit
 Html bobswift
&gt;2&lt;
/limit
 Html bobswift&gt;
<limit>2</limit>
    
&lt;
</virtual-
resource&gt;
&lt;
resource>
</virtual-
resources&gt; 
</pre>
resources> 


<pre>

{
    "variables": [{
      "
name
": "testvar",
      "
value
": "abc"
    }],
    "virtualResources": [ {
      "
name
": "aaaaa",
      "
limit
": 2
    } ], 
    "
name
": "Timer 0",
    "
virtualResourcePriority
": 10,
    "
hold
": "yes"
}

</pre>
 Expand
titleJSON
 Panel
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

Example Response

 Expand
titleXML

 Panel

 Html bobswift
<pre>
&lt;command-response&gt;
    &lt;type&gt;launch&lt;/type&gt;
    &lt;success&gt;true&lt;/success&gt;
    &lt;info&gt;Successfully launched the Timer task Timer 0.&lt;/info&gt;
    &lt;sysId&gt;1484021712811013671DQNWR5P2F9846&lt;/sysId&gt;
    &lt;errors /&gt;
&lt;/command-response&gt; 
</pre>




 Expand
titleJSON

 Panel

 Html bobswift
<pre>
{
"type": "launch",
"success": true,
"info": "Successfully launched the Timer task "Timer 0" with task instance sys_id 15136440261151733518FCQUD1BNHITA with hold on start.",
"errors": "",
"sysId": "15136440261151733518FCQUD1BNHITA"
}
</pre>



...
&gt;
<name>WF_A</name>
        
&lt;
sysId
Examples
XML
JSON
Example Response

<pre>
&lt;
<?xml version="1.0" encoding="UTF-8" standalone="yes"?
&gt;
&lt;workflows&gt;
>
<workflows>
    
&lt;workflow&gt;
<workflow>
        
&lt;
name
 Expand
titleXML
 Panel
 Html bobswift
 Html bobswift
&gt;WF_A&lt;
/name
 Html bobswift
 Html bobswift
&gt;2be1385324ab410995fda3f0292c07ee&lt;
/sysId
 Html bobswift&gt;
<sysId>2be1385324ab410995fda3f0292c07ee</sysId>
        
&lt;
description
 Html bobswift
<description /
&gt;
>
        
&lt;
version
 Html bobswift
&gt;2&lt;
/version
 Html bobswift&gt;
<version>2</version>
        
&lt;
vertexName
 Html bobswift
&gt;SB_JOB&lt;
/vertexName
 Html bobswift&gt;
<vertexName>SB_JOB</vertexName>
        
&lt;
vertexId
 Html bobswift
&gt;2&lt;
/vertexId
 Html bobswift&gt;
<vertexId>2</vertexId>
    
&lt;/workflow&gt;
</workflow>
    
&lt;workflow&gt;
<workflow>
        
&lt;name&gt;WF_B&lt;/name&gt;
  
<name>WF_B</name>
     
&lt;sysId&gt;c8d5ad7cee3f46288482872dbd63770c&lt;/sysId&gt;
   <sysId>c8d5ad7cee3f46288482872dbd63770c</sysId>
        
&lt;description
<description /
&gt;
>
        
&lt;version&gt;43&lt;/version&gt;
<version>43</version>
        
&lt;vertexName&gt;SB_JOB&lt;/vertexName&gt;
<vertexName>SB_JOB</vertexName>
        
&lt;vertexId&gt;2&lt;/vertexId&gt;
<vertexId>2</vertexId>
    
&lt;/workflow&gt;
</workflow>
    
&lt;workflow&gt;
<workflow>
        
&lt;name&gt;WF_C&lt;/name&gt;
<name>WF_C</name>
        
&lt;sysId&gt;830105616cc74d7d8d394bedc1c47a43&lt;/sysId&gt;
<sysId>830105616cc74d7d8d394bedc1c47a43</sysId>
        
&lt;description
<description /
&gt;
>
        
&lt;version&gt;6&lt;/version&gt;
<version>6</version>
        
&lt;vertexName&gt;SB
<vertexName>SB_JOB.
1&lt;/vertexName&gt;
1</vertexName>
        
&lt;vertexId&gt;2&lt;/vertexId&gt;
<vertexId>2</vertexId>
    
&lt;/workflow&gt;
</workflow>
    
&lt;workflow&gt;
<workflow>
        
&lt;name&gt;WF_C&lt;/name&gt;
<name>WF_C</name>
        
&lt;sysId&gt;830105616cc74d7d8d394bedc1c47a43&lt;/sysId&gt;
<sysId>830105616cc74d7d8d394bedc1c47a43</sysId>
        
&lt;description
<description /
&gt;
>
        
&lt;version&gt;6&lt;/version&gt;
<version>6</version>
        
&lt;vertexName&gt;SB
<vertexName>SB_JOB.
2&lt;/vertexName&gt;
2</vertexName>
        
&lt;vertexId&gt;3&lt;/vertexId&gt;
<vertexId>3</vertexId>
    
&lt;/workflow&gt;
&lt;/workflows&gt;
</pre> Expand
titleJSON
 Panel Html bobswift<pre>

</workflow>
</workflows>


[ {
  "
name
 Html bobswift
": "WF_A",
  "
sysId
 Html bobswift
": "2be1385324ab410995fda3f0292c07ee",
  "
description
 Html bobswift
": null,
  "
version
 Html bobswift
": 2,
  "
vertexName
 Html bobswift
": "SB_JOB",
  "
vertexId
 Html bobswift
": "2"
}, {
  "name": "WF_B",
  "sysId": "c8d5ad7cee3f46288482872dbd63770c",
  "description": null,
  "version": 43,
  "vertexName": "SB_JOB",
  "vertexId": "2"
}, {
  "name": "WF_C",
  "sysId": "830105616cc74d7d8d394bedc1c47a43",
  "description": null,
  "version": 6,
  "vertexName": "SB_JOB.1",
  "vertexId": "2"
}, {
  "name": "WF_C",
  "sysId": "830105616cc74d7d8d394bedc1c47a43",
  "description": null,
  "version": 6,
  "vertexName": "SB_JOB.2",
  "vertexId": "3"
} ]

</pre>
 Anchor
List All Workflows That a Task Belongs To Response Properties
List All Workflows That a Task Belongs To Response Properties
List All Workflows That a Task Belongs To: Response Properties
...
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>
      <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": "*",
      "workflowid": "a21c68bba02c43919d5a6d6042a3f082"
}    

Example Response

<pre>
&lt;tasks&gt;
<tasks>
    
&lt;task&gt;
<task>
        
&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>
 Expand
titleXML
 Panel
 Html bobswift


<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>
 Expand
titleJSON
 Panel
 Html bobswift

 Anchor
List Tasks Request Properties
List Tasks Request Properties
List Tasks: Request Properties
<ul>
<li> 
  • mn 
 
  •  (minutes)

<li> 
  • h 
 
  •  (hours)

<li> 
  • d 
 
  •  (days)

</ul>
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.
 
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
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:
 Html bobswift
 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
...
<ul>
<li>  
<li>  
<li>  
</ul>
Default is d.
 
Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days
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
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:
 Html bobswift
 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:
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
...