Versions Compared

Key

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

...

Anchor
Recurring Task XML and JSON Examples
Recurring Task XML and JSON Examples
Recurring Task: XML and JSON Examples

The retainSysIds and version properties are specified as attributes in the <task type> element XML.

The exportReleaseLevel and /wiki/spaces/UC71x/pages/5179227 properties are specified as attributes in XML. 


Examples

XML

JSON

Example for Task

Expand
titleXML
<taskRecurring exportReleaseLevel="7.2.0.0" exportTable="ops_task_recurring" 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>
<indefiniteRecurrences>false</indefiniteRecurrences>
<intervalEndTime>11:05</intervalEndTime>
<intervalEndDayConstraint>none</intervalEndDayConstraint
>
<intervalStartDayConstraint>none</intervalStartDayConstraint> 
<intervalStartTime>10:06</intervalStartTime>
<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>rec-Test3</name>
<numberOfRecurrences>1</numberOfRecurrences>
<opswiseGroups />
<overrideVariables> <variable> <name>Summary</name>
<resolution>Disabled</resolution> <value>Recurring Task Instance with id ${recurring_task_id}.</value> </variable> <variable> <name>recurring_task_id</name>
<resolution>Enabled</resolution> <value>${ops_task_id}</value> </variable>
<variable> <name>count</name>
<resolution>Enabled Every Recurrence</resolution> <value>${ops_recurrence_count}</value> </variable> </overrideVariables> <recurrenceInterval>10</recurrenceInterval> <recurrenceIntervalUnit>1</recurrenceIntervalUnit>
<recurrenceTimeList /> <recurrenceType>Interval</recurrenceType>
<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 />
<rdExcludeBackupRt>true</rdExcludeBackupRt>
<retentionDurationRt>1</retentionDurationRt>

<retentionDurationPurgeRt>true</retentionDurationPurgeRt>
<retentionDurationUnitRt>Hours</retentionDurationUnitRt>
<retryIndefinitely>false</retryIndefinitely> <retryInterval>60</retryInterval> <retryMaximum>0</retryMaximum> <retrySuppressFailure>false</retrySuppressFailure>
<runCount>32</runCount>
<runTime>108</runTime>
<skipCondition>None</skipCondition>
<startHeld>false</startHeld>
<startHeldReason />
<summary />
<sysId>3309586343d26172001d662b049d90c8</sysId>
  <targetTask>win-1</targetTask>
  <targetTaskMonitorCondition>First Recurrence</targetTaskMonitorCondition>
  <targetTaskStatusText>Finished, Success</targetTaskStatusText>
<timeWindow>true</timeWindow>

<timeZonePref>-- System Default --</timeZonePref>
<twDelayAmount />
<twDelayDuration>00:00:00:00</twDelayDuration>
<twDelayType>None</twDelayType>
<twWaitAmount />
<twWaitDayConstraint />
<twWaitDuration>00:00:00:00</twWaitDuration>
<twWaitTime>00:00</twWaitTime>
<twWaitType>None</twWaitType>
<twWorkflowOnly>-- System Default --</twWorkflowOnly>
<userEstimatedDuration />
</taskRecurring>
Expand
titleJSON
{
  "type": "taskRecurring",
  "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", "exclusiveTasks": [], "executionRestriction": "Run",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_task_manual",
"firstRun": "2021-03-15 13:59:37 -0400", "holdResources": false,
"indefiniteRecurrences": false,
"intervalEndTime": "11:05", "intervalEndDayConstraint": "none",
"intervalStartTime": "10:06", "intervalStartDayConstraint": "none",
"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": "rec-test3",
"notes": [],
"numberOfRecurrences": 1,
"opswiseGroups": null,
"overrideVariables": [ { "name": "Summary",
"resolution": "Disabled", "value": "Recurring Task Instance with id ${recurring_task_id}." },
{ "name": "recurring_task_id",
"resolution": "Enabled", "value": "${ops_task_id}" },
{ "name": "count",
"resolution": "Enabled Every Recurrence", "value": "${ops_recurrence_count}" } ],
 
"recurrenceInterval": "10", "recurrenceIntervalUnit": "1",
"recurrenceTimeList": null, "recurrenceType": "Interval",
"resPriority": 10,
"restrictionPeriod": "Span",
"restrictionPeriodAfterDate": "2017-11-10",
"restrictionPeriodAfterTime": "10:30",
"restrictionPeriodBeforeDate": "2017-11-20",
"restrictionPeriodBeforeTime": "15:00",
"restrictionPeriodDateList": [],
"rdExcludeBackupRt": true,
"retentionDurationRt": 1,
"retentionDurationPurgeRt": true,
"retentionDurationUnitRt": "Hours",
"retainSysIds": true,
"retryIndefinitely": false, "retryInterval": 60, "retryMaximum": 0, "retrySuppressFailure": false,
"runCount": 32,
"runTime": 108,
"skipCondition": "None",
"startHeld": false,
"startHeldReason": null,
"summary": null,
"sysId": "fb59a227517a421a92c15ff5aefe3b66",
"targetTask": "win-1",
"targetTaskMonitorCondition": "First Recurrence",
"targetTaskStatusText": "Finished,\nSuccess",
"timeWindow": true,
"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": []
}


See Task Web Services - Task Actions for XML and JSON examples of task actions.

...