Versions Compared

Key

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

...

Universal Controller supports the following RESTful-based web services for Manual Task operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

...


Description

URI

http://host_name/uc/resources/task

HTTP Method

POST

Description

Creates a new Manual task.

Example URI

http://localhost:8080/uc/resources/task

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

See Manual Task: XML and JSON Examples, below.

Properties

See Manual Task Web Services#Properties Properties.

Example Response

  • Status 200 /OK
    Successfully created the <task type> task with sysId <sysId>.

...


Description

URI

http://host_name/uc/resources/task

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

HTTP Method

PUT

Description

Modifies the task specified by the sysId in the request.
 
To modify Manual Task properties without modifying related records, use the excludeRelated property.

Example

See Manual Task: XML and JSON Examples.

Properties

See Manual Task Web Services#Properties Properties.

Example Response

  • Status 200 /OK
    Successfully updated the <task type> task with sysId <sysId> to version <version>.

...

&gt;
<notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       <notifyOnLateFinish>false</notifyOnLateFinish>
       
&lt;

notifyOnLateFinish

Examples

XML

JSON

Example for Task


Expand
titleXML
<taskManual exportReleaseLevel="7.2.0.0" exportTable="ops_task_manual" retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <virtualResources />
       <exclusiveTasks />
<avgRunTime>3</avgRunTime>
<avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay> <cpDuration /> <cpDurationUnit>Minutes</cpDurationUnit> <credentials /> <credentialsVar /> <customField1 label="Domain">web.com</customField1> <customField2 /> <efDayConstraint>Nth</efDayConstraint> <efDuration>00:00:00:00</efDuration> <efEnabled>false</efEnabled> <efNthAmount>10</efNthAmount>        <efOffsetDuration />
       <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime> <efType>Time</efType> <executionRestriction>Run</executionRestriction>
<firstRun>2021-03-15 13:59:37 -0400</firstRun> <holdResources>false</holdResources>
<lastRun>2021-03-16 17:12:42 -0400</lastRun>
<lastRunTime>9</lastRunTime>
<lastRunTimeDisplay>9 seconds</lastRunTimeDisplay> <lfDayConstraint>Nth</lfDayConstraint> <lfDuration>00:00:00:00</lfDuration> <lfEnabled>false</lfEnabled> <lfNthAmount>1</lfNthAmount>        <lfOffsetDuration />
       <lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime> <lfType>Time</lfType> <lsDayConstraint>Nth</lsDayConstraint> <lsDuration>00:00:00:00</lsDuration> <lsEnabled>false</lsEnabled> <lsNthAmount>7</lsNthAmount> <lsTime>00:00</lsTime> <lsType>Time</lsType>
<maxRunTime>9</maxRunTime>
<maxRunTimeDisplay>9 Seconds</maxRunTimeDisplay>
<minRunTime>3</minRunTime>
<minRunTimeDisplay>3 Seconds</minRunTimeDisplay> <name>uc - Test Email</name> <opswiseGroups /> <resolveNameImmediately>false</resolveNameImmediately> <resPriority>10</resPriority> <restrictionPeriod>Span</restrictionPeriod> 
<restrictionPeriodAfterDate
>2017-11-10</restrictionPeriodAfterDate> <restrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime> <restrictionPeriodBeforeDate>2017-11-20</restrictionPeriodBeforeDate> <restrictionPeriodBeforeTime>15:00</restrictionPeriodBeforeTime> <restrictionPeriodDateList />
<runCount>32</runCount>
<runTime>108</runTime> <startHeld>false</startHeld> <startHeldReason /> <summary>Test Email</summary> <sysId>fb59a227517a421a92c15ff5aefe3b66</sysId> <timeZonePref>-- System Default --</timeZonePref> <twDelayAmount /> <twDelayDuration>00:00:00:00</twDelayDuration> <twDelayType>None</twDelayType> <twWaitAmount /> <twWaitDayConstraint>NONE</twWaitDayConstraint> <twWaitDuration>00:00:00:00</twWaitDuration> <twWaitTime>00:00</twWaitTime> <twWaitType>None</twWaitType> <twWorkflowOnly>-- System Default --</twWorkflowOnly> <userEstimatedDuration /> </taskManual>



Expand
titleJSON
{
  "type": "taskManual",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },
"avgRunTime": 3,
"avgRunTimeDisplay": "3 Seconds", "cpDuration": null, "cpDurationUnit": "Minutes", "credentials": null, "credentialsVar": null, "customField1": { "label": "Domain", "value": "http://qa-cntlr-mssql:8080/uc/" }, "customField2": { "label": null, "value": null }, "efDayConstraint": "Nth Day", "efDuration": "00:00:00:00", "efEnabled": false, "efNthAmount": 10,   "efOffsetDuration": null, 
  "efOffsetDurationUnit": "Minutes",
  "efOffsetPercentage": 0,
  "efOffsetType": "Percentage",
  "efTime": "00:00", "efType": "Time", "excludeRelated": false, "exclusiveTasks": [], "executionRestriction": "Run",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_task_manual",
"firstRun": "2021-03-15 13:59:37 -0400", "holdResources": false,
"lastRun": "2021-03-16 17:12:42 -0400",
"lastRunTime": 9,
"lastRunTimeDisplay": "9 Seconds", "lfDayConstraint": "Nth Day", "lfDuration": "00:00:00:00", "lfEnabled": false, "lfNthAmount": 1,   "lfOffsetDuration": null, 
  "lfOffsetDurationUnit": "Minutes",
  "lfOffsetPercentage": 0,
  "lfOffsetType": "Percentage",
  "lfTime": "00:00", "lfType": "Time", "lsDayConstraint": "Nth Day", "lsDuration": "00:00:00:00", "lsEnabled": false, "lsNthAmount": 7, "lsTime": "00:00", "lsType": "Time",
"maxRunTime": 9,
"maxRunTimeDisplay": "9 Seconds",
"minRunTime": 3,
"minRunTimeDisplay": "3 Seconds", "name": "uc - Test Email", "notes": [], "opswiseGroups": null, "resolveNameImmediately": false, "resPriority": 10, "restrictionPeriod": "Span", "restrictionPeriodAfterDate": "2017-11-10", "restrictionPeriodAfterTime": "10:30", "restrictionPeriodBeforeDate": "2017-11-20", "restrictionPeriodBeforeTime": "15:00", "restrictionPeriodDateList": [], "retainSysIds": true,
"runCount": 32,
"runTime": 108, "startHeld": false, "startHeldReason": null, "summary": "Test Email", "sysId": "fb59a227517a421a92c15ff5aefe3b66", "timeZonePref": "-- System Default --", "twDelayAmount": null, "twDelayDuration": "00:00:00:00", "twDelayType": "None", "twWaitAmount": null, "twWaitDayConstraint": "NONE", "twWaitDuration": "00:00:00:00", "twWaitTime": "00:00", "twWaitType": "None", "twWorkflowOnly": "-- System Default --", "userEstimatedDuration": null, "variables": [], "version": 1, "virtualResources": [] }


Anchor
Examples for Task Actions
Examples for Task Actions
Examples for Task Actions


<pre> &lt;abortAction&gt;
<abortAction>
       
&lt;

description

<description /
&gt;
>
       
&lt;

exitCodes

<exitCodes /
&gt;
>
       
&lt;

notifyOnEarlyFinish

Expand
titleXML

Anchor
Abort
Abort
Abort

Panel
Html bobswift
Html bobswift
Html bobswift
Html bobswift
&gt;false&lt;

/notifyOnEarlyFinish

Html bobswift
Html bobswift
&gt;false&lt;

/notifyOnLateFinish

Html bobswift&gt;
<notifyOnLateStart>false</notifyOnLateStart>
       
&lt;

notifyOnLateStart

Html bobswift
&gt;false&lt;

/notifyOnLateStart

Html bobswift&gt;
<status>Waiting</status>
       
&lt;

status

Html bobswift
&gt;Waiting&lt;

/status

Html bobswift&gt;
<sysId>ad42c3268468425db6e1580cd53f57f0</sysId>
       <cancelProcess>false</cancelProcess>
       
&lt;

sysId

Html bobswift
&gt;ad42c3268468425db6e1580cd53f57f0&lt;

/sysId

Html bobswift&gt;
<haltOnFinish>false</haltOnFinish>
       <overrideExitCode 
&lt;

cancelProcess

Html bobswift
&gt;false&lt;

/cancelProcess

Html bobswift
&gt;
       &lt;

haltOnFinish

Html bobswift
&gt;false&lt;

/haltOnFinish

Html bobswift
&gt;
       &lt;

overrideExitCode

Html bobswift
 /&gt;
&lt;/abortAction&gt;
</pre>
 
AnchorEmail NotificationEmail NotificationEmail Notification Panel Html bobswift<pre> &lt;emailNotification&gt;
/>
</abortAction>


 

Anchor
Email Notification
Email Notification
Email Notification

<emailNotification>
       <description />
       <exitCodes />
       <notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       
&lt;

description

Html bobswift /&gt;
<notifyOnLateFinish>false</notifyOnLateFinish>
       <notifyOnLateStart>false</notifyOnLateStart>
 
&lt;

exitCodes

Html bobswift
 
/&gt;
     
&lt;

notifyOnEarlyFinish

Html bobswift
&gt;false&lt;

/notifyOnEarlyFinish

Html bobswift&gt;
<status>Success</status>
       
&lt;

notifyOnLateFinish

Html bobswift
&gt;false&lt;

/notifyOnLateFinish

Html bobswift&gt;
<sysId>2b72cdaaf3a145e4bbae5a7ddd24baff</sysId>
      
&lt;

notifyOnLateStart

Html bobswift
&gt;false&lt;

/notifyOnLateStart

Html bobswift
&gt;
       &lt;

status

Html bobswift
&gt;Success&lt;

/status

Html bobswift
&gt;
       &lt;

sysId

Html bobswift
&gt;2b72cdaaf3a145e4bbae5a7ddd24baff&lt;

/sysId

Html bobswift
&gt;
       &lt;

attachFile

Html bobswift
&gt;false&lt;

/attachFile

Html bobswift&gt;
 <attachFile>false</attachFile>
       
&lt;

attachJobLog

Html bobswift
&gt;false&lt;

/attachJobLog

Html bobswift&gt;
<attachJobLog>false</attachJobLog>
       
&lt;

attachStdError

Html bobswift
&gt;false&lt;

/attachStdError

Html bobswift&gt;
<attachStdError>false</attachStdError>
       
&lt;

attachStdOut

Html bobswift
&gt;true&lt;

/attachStdOut

Html bobswift&gt;
<attachStdOut>true</attachStdOut>
       
&lt;

bcc

Html bobswift /&gt;
<bcc />
       
&lt;

body

Html bobswift
&gt;test body&lt;

/body

Html bobswift&gt;
<body>test body</body>
       
&lt;

cc

Html bobswift /&gt;
<cc />
       
&lt;

emailConnection

Html bobswift&gt;uc
<emailConnection>uc - Gmail 
Account&lt;
Account</emailConnection
Html bobswift&gt;
>
       
&lt;

emailTemplate

Html bobswift /&gt;
<emailTemplate />
       
&lt;

emailTemplateVar

Html bobswift /&gt;
<emailTemplateVar />
       
&lt;

fileName

Html bobswift /&gt;
<fileName />
       
&lt;

fileNumLines

Html bobswift
&gt;100&lt;

/fileNumLines

Html bobswift&gt;
<fileNumLines>100</fileNumLines>
       
&lt;

fileScanText

Html bobswift /&gt;
<fileScanText />
       
&lt;

fileStartLine

Html bobswift
&gt;1&lt;

/fileStartLine

Html bobswift&gt;
<fileStartLine>1</fileStartLine>
       
&lt;

joblogNumLines

Html bobswift
&gt;100&lt;

/joblogNumLines

Html bobswift&gt;
<joblogNumLines>100</joblogNumLines>
       
&lt;

joblogScanText

Html bobswift /&gt;
<joblogScanText />
       
&lt;

joblogStartLine

Html bobswift
&gt;1&lt;

/joblogStartLine

Html bobswift&gt;
<joblogStartLine>1</joblogStartLine>
       
&lt;

replyTo

Html bobswift
&gt;replyTo@test.com&lt;

/replyTo

Html bobswift&gt;
<replyTo>replyTo@test.com</replyTo>
       
&lt;

report

Html bobswift&gt;
<report>
             
&lt;groupName
<groupName /
&gt;
>
             
&lt;title&gt;report1&lt;/title&gt;
<title>report1</title>
             
&lt;userName&gt;ops.admin&lt;/userName&gt;
<userName>ops.admin</userName>
       
&lt;
</report
Html bobswift&gt;
>
     
&lt;

stderrNumLines

Html bobswift
&gt;100&lt;

/stderrNumLines

Html bobswift&gt;
  <stderrNumLines>100</stderrNumLines>
       
&lt;

stderrScanText

Html bobswift /&gt;
<stderrScanText />
       
&lt;

stderrStartLine

Html bobswift
&gt;1&lt;

/stderrStartLine

Html bobswift&gt;
<stderrStartLine>1</stderrStartLine>
       
&lt;

stdoutNumLines

Html bobswift
&gt;100&lt;

/stdoutNumLines

Html bobswift&gt;
<stdoutNumLines>100</stdoutNumLines>
       
&lt;

stdoutScanText

Html bobswift /&gt;
<stdoutScanText />
       
&lt;

stdoutStartLine

Html bobswift
&gt;1&lt;

/stdoutStartLine

Html bobswift&gt;
<stdoutStartLine>1</stdoutStartLine>
       
&lt;

subject

Html bobswift /&gt;
<subject />
       
&lt;

to

Html bobswift
&gt;test@test.com&lt;

/to

Html bobswift
&gt;
&lt;/emailNotification&gt;
</pre>
 
<to>test@test.com</to>
</emailNotification>


 

Anchor
Set Variable
Set Variable
Set Variable

Panel Html bobswift<pre> &lt;setVariableAction&gt;

<setVariableAction>
       
&lt;

description

Html bobswift /&gt;
<description />
       
&lt;

exitCodes

Html bobswift /&gt;
<exitCodes />
       
&lt;

notificationOption

Html bobswift
&gt;Operation Failure&lt;

/notificationOption

Html bobswift&gt;
<notificationOption>Operation Failure</notificationOption>
       
&lt;

notifyOnEarlyFinish

Html bobswift
&gt;false&lt;

/notifyOnEarlyFinish

Html bobswift&gt;
<notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       
&lt;

notifyOnLateFinish

Html bobswift
&gt;false&lt;

/notifyOnLateFinish

Html bobswift&gt;
<notifyOnLateFinish>false</notifyOnLateFinish>
       
&lt;

notifyOnLateStart

Html bobswift
&gt;false&lt;

/notifyOnLateStart

Html bobswift&gt;
<notifyOnLateStart>false</notifyOnLateStart>
       
&lt;

status

Html bobswift
&gt;Waiting&lt;

/status

Html bobswift&gt;
<status>Waiting</status>
       
&lt;

sysId

Html bobswift
&gt;f7824e38add745c2bf41017b07697bdf&lt;

/sysId

Html bobswift&gt;
<sysId>f7824e38add745c2bf41017b07697bdf</sysId>
       
&lt;

variableName

Html bobswift
&gt;name&lt;

/variableName

Html bobswift&gt;
<variableName>name</variableName>
       
&lt;

variableScope

Html bobswift
&gt;Self&lt;

/variableScope

Html bobswift&gt;
<variableScope>Self</variableScope>
       
&lt;

variableValue

Html bobswift /&gt; &lt;/setVariableAction&gt;
<variableValue />
</
pre>
setVariableAction>

 
 

Anchor
SNMP Notification
SNMP Notification
SNMP Notification

Panel Html bobswift<pre> &lt;snmpNotification&gt;


<snmpNotification>
       
&lt;

description

Html bobswift /&gt;
<description />
       
&lt;

exitCodes

Html bobswift /&gt;
<exitCodes />
       
&lt;

notifyOnEarlyFinish

Html bobswift
&gt;false&lt;

/notifyOnEarlyFinish

Html bobswift&gt;
<notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       
&lt;

notifyOnLateFinish

Html bobswift
&gt;false&lt;

/notifyOnLateFinish

Html bobswift&gt;
<notifyOnLateFinish>false</notifyOnLateFinish>
       
&lt;

notifyOnLateStart

Html bobswift
&gt;false&lt;

/notifyOnLateStart

Html bobswift&gt;
<notifyOnLateStart>false</notifyOnLateStart>
       
&lt;

status

Html bobswift
&gt;Resource Requested&lt;

/status

Html bobswift&gt;
<status>Resource Requested</status>
       
&lt;

sysId

Html bobswift
&gt;1a1ddf2fa7f7466db8b5fc7863fc4ea3&lt;

/sysId

Html bobswift&gt;
<sysId>1a1ddf2fa7f7466db8b5fc7863fc4ea3</sysId>
    
&lt;

severity

Html bobswift
&gt;Normal&lt;

/severity

Html bobswift&gt;
   <severity>Normal</severity>
       
&lt;

snmpManager

Html bobswift
&gt;test manager&lt;

/snmpManager

Html bobswift
&gt;
&lt;/snmpNotification&gt;
</pre>
 
 
<snmpManager>test manager</snmpManager>
</snmpNotification>


 

Anchor
System Operation
System Operation
System Operation

Panel Html bobswift<pre> &lt;systemOperation&gt;
<systemOperation>
       
&lt;

description

Html bobswift /&gt;
<description />
       
&lt;

exitCodes

Html bobswift /&gt;
<exitCodes />
       
&lt;

notifyOnEarlyFinish

Html bobswift
&gt;false&lt;

/notifyOnEarlyFinish

Html bobswift&gt;
<notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       
&lt;

notifyOnLateFinish

Html bobswift
&gt;false&lt;

/notifyOnLateFinish

Html bobswift&gt;
<notifyOnLateFinish>false</notifyOnLateFinish>
       
&lt;

notifyOnLateStart

Html bobswift
&gt;false&lt;

/notifyOnLateStart

Html bobswift&gt;
<notifyOnLateStart>false</notifyOnLateStart>
       
&lt;

status

Html bobswift
&gt;Held&lt;

/status

Html bobswift&gt;
<status>Held</status>
       
&lt;

sysId

Html bobswift
&gt;742beaf652834054b1edc37e6423700d&lt;

/sysId

Html bobswift&gt;
<sysId>742beaf652834054b1edc37e6423700d</sysId>
       
&lt;

agent

Html bobswift /&gt;
<agent />
       
&lt;

agentCluster

Html bobswift /&gt;
<agentCluster />
       
&lt;

agentClusterVar

Html bobswift /&gt;
<agentClusterVar />
       
&lt;

agentVar

Html bobswift /&gt;
<agentVar />
       
&lt;

execCommand

Html bobswift
&gt;Cancel&lt;

/execCommand

Html bobswift&gt;
<execCommand>Cancel</execCommand>
       
&lt;

execCriteria

Html bobswift&gt;Oldest
<execCriteria>Oldest Active 
Instance&lt;
Instance</execCriteria
Html bobswift&gt;
>
       
&lt;

execId

Html bobswift /&gt;
<execId />
       
&lt;

execLookupOption

Html bobswift
&gt;Task&lt;

/execLookupOption

Html bobswift&gt;
<execLookupOption>Task</execLookupOption>
       
&lt;

execName

Html bobswift /&gt;
<execName />
       
&lt;

execWorkflowNameCond

Html bobswift /&gt;
<execWorkflowNameCond />
       
&lt;

execWorkflowName

Html bobswift /&gt;
<execWorkflowName />
       
&lt;

limit

Html bobswift /&gt;
<limit />
       
&lt;

notificationOption

Html bobswift
&gt;Operation Failure&lt;

/notificationOption

Html bobswift&gt;
<notificationOption>Operation Failure</notificationOption>
       
&lt;

operation

Html bobswift&gt;Run
<operation>Run Task Instance 
Command&lt;
Command</operation
Html bobswift&gt;
>
       
&lt;

task

Html bobswift&gt;uc
<task>uc - B=${B}
&lt;
</task
Html bobswift&gt;
>
       
&lt;

taskLimitType

Html bobswift
&gt;Unlimited&lt;

/taskLimitType

Html bobswift&gt;
<taskLimitType>Unlimited</taskLimitType>
       
&lt;

taskVar

Html bobswift /&gt;
<taskVar />
       
&lt;

trigger

Html bobswift /&gt;
<trigger />
       
&lt;

triggerVar

Html bobswift /&gt;
<triggerVar />
       
&lt;

variables

Html bobswift&gt;
<variables>
             
&lt;variable&gt;
<variable>
                   
&lt;

name

Html bobswift
&gt;var1&lt;

/name

Html bobswift&gt;
<name>var1</name>
                 
&lt;

value

Html bobswift
&gt;val1&lt;

/value

Html bobswift&gt;
  <value>val1</value>
             
&lt;/variable&gt;
</variable>
             
&lt;variable&gt;
<variable>
                   
&lt;

name

Html bobswift
&gt;var2&lt;

/name

Html bobswift&gt;
<name>var2</name>
                   
&lt;

value

Html bobswift
&gt;val2&lt;

/value

Html bobswift&gt;
<value>val2</value>
             
&lt;/variable&gt;
</variable>
       
&lt;
</variables
Html bobswift&gt;
>
       
&lt;

variablesUnresolved

Html bobswift
&gt;false&lt;

/variablesUnresolved

Html bobswift&gt;
<variablesUnresolved>false</variablesUnresolved>
       
&lt;

variablesUnresolved

Html bobswift /&gt;
<variablesUnresolved />
       
&lt;

virtualResource

Html bobswift /&gt;
<virtualResource />
       
&lt;

virtualResourceVar

Html bobswift /&gt; &lt;/systemOperation&gt;
<virtualResourceVar />
</
pre>
systemOperation>



Expand
titleJSON

Anchor
Abort
Abort
Abort

Panel


Html bobswift
<pre>
"abortActions": [ { 
  "

cancelProcess

Html bobswift
": false,
  "

description

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

haltOnFinish

Html bobswift
": true,
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

overrideExitCode

Html bobswift
": null,
  "

status

Html bobswift
": "Waiting",
  "

sysId

Html bobswift
": "ad42c3268468425db6e1580cd53f57f0"
} ],
</pre>


 
 

Anchor
Email Notification
Email Notification
Email Notification

Panel


Html bobswift
<pre>
"emailNotifications": [ { 
  "

attachFile

Html bobswift
": false,
  "

attachJobLog

Html bobswift
": false,
  "

attachStdError

Html bobswift
": false,
  "

attachStdOut

Html bobswift
": true,
  "

bcc

Html bobswift
": null,
  "

body

Html bobswift
": "test body",
  "

cc

Html bobswift
": null,
  "

description

Html bobswift
": null,
  "

emailConnection

Html bobswift
": "uc - Gmail Account",
  "

emailTemplate

Html bobswift
": null,
  "

emailTemplateVar

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

fileName

Html bobswift
": null,
  "

fileNumLines

Html bobswift
": 100,
  "

fileScanText

Html bobswift
": null,
  "

fileStartLine

Html bobswift
": 1,
  "

joblogNumLines

Html bobswift
": 100,
  "

joblogScanText

Html bobswift
": null,
  "

joblogStartLine

Html bobswift
": 1,
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

replyTo

Html bobswift
": "replyTo@test.com",
  "

report

Html bobswift
": {
    "groupName": null,
    "title": "report1",
    "userName": "ops.admin"
  },
  "

status

Html bobswift
": "Success",
  "

stderrNumLines

Html bobswift
": 100,
  "

stderrScanText

Html bobswift
": null,
  "

stderrStartLine

Html bobswift
": 1,
  "

stdoutNumLines

Html bobswift
": 100,
  "

stdoutScanText

Html bobswift
": null,
  "

stdoutStartLine

Html bobswift
": 1,
  "

subject

Html bobswift
": null,
  "

sysId

Html bobswift
": "2b72cdaaf3a145e4bbae5a7ddd24baff",
  "

to

Html bobswift
": "test@test.com"
  }  
],   
</pre>


 

Anchor
Set Variable
Set Variable
Set Variable

Panel


Html bobswift
<pre>
"setVariableActions": [ {
  "

description

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

notificationOption

Html bobswift
": "Operation Failure",
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

status

Html bobswift
": "Waiting",
  "

sysId

Html bobswift
": "f7824e38add745c2bf41017b07697bdf",
  "

variableName

Html bobswift
": "name",
  "

variableScope

Html bobswift
": "Self",
  "

variableValue

Html bobswift
": null
  } 
],
</pre>


 

Anchor
SNMP Notification
SNMP Notification
SNMP Notification

Panel


Html bobswift
<pre>
"snmpNotifications": [ {
  "

description

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

severity

Html bobswift
": "Normal",
  "

snmpManager

Html bobswift
": "test manager",
  "

status

Html bobswift
": "Resource Requested",
  "

sysId

Html bobswift
": "1a1ddf2fa7f7466db8b5fc7863fc4ea3"
  }
],
</pre>


 

Anchor
System Operation
System Operation
System Operation

Panel


Html bobswift
<pre>
"systemOperations": [ {
  "

agent

Html bobswift
": null,
  "

agentCluster

Html bobswift
": null,
  "

agentClusterVar

Html bobswift
": null,
  "

agentVar

Html bobswift
": null,
  "

description

Html bobswift
": null,
  "

execCommand

Html bobswift
": "Cancel",
  "

execCriteria

Html bobswift
": "Oldest Active Instance",
  "

execId

Html bobswift
": null,
  "

execLookupOption

Html bobswift
": "Task",
  "

execName

Html bobswift
": null,
  "

execWorkflowNameCond

Html bobswift
": null,
  "

execWorkflowName

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

limit

Html bobswift
": null,
  "

notificationOption

Html bobswift
": "Operation Failure",
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

operation

Html bobswift
": "Run Task Instance Command",
  "

task

Html bobswift
": "uc - B=${B}",
  "

taskLimitType

Html bobswift
": "Unlimited",
  "

taskVar

Html bobswift
": null,
  "

trigger

Html bobswift
": null,
  "

triggerVar

Html bobswift
": null,
  "

status

Html bobswift
": "Held",
  "

sysId

Html bobswift
": "742beaf652834054b1edc37e6423700d",
  "

variables

Html bobswift
": [ {
    "

name

Html bobswift
": "var1",
    "

value

Html bobswift
": "val1"
  },
  {
    "

name

Html bobswift
": "var2",
    "

value

Html bobswift
": "val2"
  } ],
  "

variablesUnresolved

Html bobswift
": false,
  "

virtualResource

Html bobswift
": null,
  "

virtualResourceVar

Html bobswift
": null
  } ]
</pre>




Anchor
Examples for Task-Related Records
Examples for Task-Related Records
Examples for Task-Related Records


Expand
titleXML

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks

Panel


Html bobswift
<pre>
&lt;exclusiveTasks&gt;
      &lt;exclusiveTask&gt;
            &lt;

sysId

Html bobswift
&gt;5d2c0886b69745aa916a755602a1b77f&lt;

/sysId

Html bobswift
&gt;
            &lt;

task

Html bobswift
&gt;Sleep 0&lt;

task

Html bobswift
&gt;            
            &lt;

type

Html bobswift
&gt;Direct&lt;

type

Html bobswift
&gt;
      &lt;/exclusiveTask&gt;
      &lt;exclusiveTask&gt;
            &lt;

sysId

Html bobswift
&gt;c1342b7597f9492e927ce24c5126f9d4&lt;

/sysId

Html bobswift
&gt;
            &lt;

task

Html bobswift
&gt;Sleep 30&lt;

/task

Html bobswift
&gt;
            &lt;

type

Html bobswift
&gt;Direct&lt;

/type

Html bobswift
&gt;
      &lt;/exclusiveTask&gt;
&lt;/exclusiveTasks&gt;
</pre>


 

Anchor
Notes
Notes
Notes

Panel


Html bobswift
<pre>
&lt;notes&gt;
      &lt;note&gt;
            &lt;

sysId

Html bobswift
&gt;8122cc80fbdb4e12b2c7118c172038fc&lt;

/sysId

Html bobswift
&gt;
            &lt;

text

Html bobswift
&gt;note2 text&lt;

/text

Html bobswift
&gt;
            &lt;

title

Html bobswift
&gt;note2&lt;

/title

Html bobswift
&gt;
      &lt;/note&gt;
      &lt;note&gt;
            &lt;

sysId

Html bobswift
&gt;eb95737f44664bd3bd4002690e00d715&lt;

/sysId

Html bobswift
&gt;
            &lt;

text

Html bobswift
&gt;note1 text&lt;

/text

Html bobswift
&gt;
            &lt;

title

Html bobswift
&gt;note1&lt;

/title

Html bobswift
&gt;
      &lt;/note&gt;
&lt;/notes&gt;
</pre>


 

Anchor
Variables in Tasks
Variables in Tasks
Variables

Panel


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

description

Html bobswift
&gt;description&lt;

/description

Html bobswift
&gt;
             &lt;

name

Html bobswift
&gt;var1&lt;

/name

Html bobswift
&gt;
             &lt;

sysId

Html bobswift
&gt;76af48c246954c128ef90da254044618&lt;

/sysId

Html bobswift
&gt;
             &lt;

value

Html bobswift
&gt;value1&lt;

/value

Html bobswift
&gt;
       &lt;/variable&gt;
       &lt;variable&gt;
             &lt;

description

Html bobswift
 /&gt;
             &lt;

name

Html bobswift
&gt;var2&lt;

/name

Html bobswift
&gt;
             &lt;

sysId

Html bobswift
&gt;899912878e4b4a36848269dc8a75dc1c&lt;

/sysId

Html bobswift
&gt;
             &lt;

value

Html bobswift
&gt;value2&lt;

/value

Html bobswift
&gt;
       &lt;/variable&gt;
&lt;/variables&gt;
</pre>


 

Anchor
Virtual Resources
Virtual Resources
Virtual Resources

Panel


Html bobswift
<pre>
&lt;virtualResources&gt;
       &lt;

virtualResource

Html bobswift
&gt;
             &lt;

amount

Html bobswift
&gt;1&lt;

/amount

Html bobswift
&gt;
             &lt;

resource

Html bobswift
&gt;uc - Solo&lt;

/resource

Html bobswift
&gt;
             &lt;

sysId

Html bobswift
&gt;4f5bb3fda5874dac8bb1897382d1317d&lt;

/sysId

Html bobswift
&gt;
       &lt;

/virtualResource

Html bobswift
&gt;
&lt;/virtualResources&gt;
</pre>





Expand
titleJSON

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks

Panel


Html bobswift
<pre>
"exclusiveTasks": [ {
  "

sysId

Html bobswift
": "5d2c0886b69745aa916a755602a1b77f",
  "

task

Html bobswift
": "Sleep 0",            
  "

type

Html bobswift
": "Direct"
  },
  {
  "

sysId

Html bobswift
": "c1342b7597f9492e927ce24c5126f9d4",
  "

task

Html bobswift
": "Sleep 30",
  "

type

Html bobswift
": "Direct"
  } ]
</pre>


 
 
 

Anchor
Notes
Notes
Notes

Panel


Html bobswift
<pre>
"notes": [ {
  "

sysId

Html bobswift
": "8122cc80fbdb4e12b2c7118c172038fc",
  "

text

Html bobswift
": "note2 text",
  "

title

Html bobswift
": "note2"
  },
  {
  "

sysId

Html bobswift
": "eb95737f44664bd3bd4002690e00d715",
  "

text

Html bobswift
": "note1 text",
  "

title

Html bobswift
": "note1"
  } ]
</pre>


 
 
 

Anchor
Variables in Tasks
Variables in Tasks
Variables

Panel


Html bobswift
<pre>
"variables": [ {
  "

description

Html bobswift
": "description",
  "

name

Html bobswift
": "var1",
  "

sysId

Html bobswift
": "76af48c246954c128ef90da254044618",
  "

value

Html bobswift
": "value1"
  },
  {
  "

description

Html bobswift
": null,
  "

name

Html bobswift
": "var2",
  "

sysId

Html bobswift
": "899912878e4b4a36848269dc8a75dc1c",
  "

value

Html bobswift
": "value2"
  } ]
</pre>


 
 
 

Anchor
Virtual Resources
Virtual Resources
Virtual Resources

Panel


Html bobswift
<pre>
"virtualResources": [ {
  "

amount

Html bobswift
": 1,
  "

resource

Html bobswift
": "uc - Solo",
  "

sysId

Html bobswift
": "4f5bb3fda5874dac8bb1897382d1317d"
  } ]
</pre>




...