Versions Compared

Old Version 16

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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

...

Examples

XML

JSON

Example Request for Task


Expand
titleXML
<task-launch>
    <variables<variables/> 
    <virtual<virtual-resources /> 
    <name>Timer<name>Timer 0</name>name>
    <timeZone>America<timeZone>America/Halifax</timeZone>timeZone>
    <virtualResourcePriority>10</virtualResourcePriority><virtualResourcePriority>10</virtualResourcePriority>
    <hold>yes</hold><hold>yes</hold>
    <holdReason>Waiting<holdReason>Waiting for input</holdReason>holdReason>
</task-launch>



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


Example Request for Task-Related Records


Expand
titleXML

Anchor
Variables for Task-Related Records
Variables for Task-Related Records
Variables

<variables>
   <variable>
         <name>testVar</name><name>testVar</name>
         <value>value</value><value>value</value>
   </variable>
</variables>

Anchor
Virtual Resources for Task-Related Records
Virtual Resources for Task-Related Records
Virtual Resources

<virtual-resources> 
    <virtual-resource>
        <name>uc<name>uc - Solo</name>name>
        <limit>2</limit><limit>2</limit>
    </virtual-resource>
</virtual-resources>



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


Example Response


Expand
titleXML


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




Expand
titleJSON


html-bobswift
Panel
<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>


 Anchor
Launch a Task Request Properties
Launch a Task Request Properties
Launch a Task: Request Properties
...
Examples
XML
JSON
Example Request

 Expand
titleXML
<generic-query-filter>
      <name>*</name>
      <type>Timer</type>
      <updatedTimeType>offset</updatedTimeType>
      <updatedTime>-10d</updatedTime>
      <agentName>SBUS30 - AGNT0005</agentName>
      <businessServices>bService1,bService2</businessServices>
</generic-query-filter>

or
<generic-query-filter>
      <name>*</name>
      <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

 Expand
titleXML
<tasks>
    <task>
        <description>description</description>
        <name>test task 1</name>
        <sysID>410d6c0bc0a801c901838d8ac43b3279</sysID>
        <type>Windows</type>
        <version>2</version>
    </task>
    <task>
        <description>description</description>
        <name>test task 2</name>
        <sysID>410d6880c0a801c90196685fcc1ecb47</sysID>
        <type>Windows</type>
        <version>9</version>
    </task>
</tasks>


 Expand
titleJSON
[ {
  "description": "Description",
  "name": "test task 1",
  "sysId": "371be743130a4b18a9fc49961650593c",
  "type": "Timer",
  "version": 23
}, {
  "description": "Description",
  "name": "test task 2",
  "sysId": "10d58f96ab2b42e69d7e9bdde2ed21a7",
  "type": "Timer",
  "version": 2
} ]

...