...

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

Recurring Task Web Services#Create Create a Recurring TaskRecurring Task Web Services#Modify
Modify a Recurring Task
Recurring Task Web Services#Read Read a Recurring Task

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

...

Anchor

	Create a Recurring Task
	Create a Recurring Task

Create a Recurring Task

	Description
URI	http://host_name/uc/resources/task
HTTP Method	POST
Description	Creates a new Recurring task.
Example URI	http://localhost:8080/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Recurring Task: XML and JSON Examples, below.
Properties	See Recurring Task Web Services#Properties Properties.
Example Response	Status 200 /OK Successfully created the <task type> task with sysId <sysId>.

Anchor

	Modify a Recurring Task
	Modify a Recurring Task

Modify a Recurring Task

	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, below. To modify Reecurring Task properties without modifying related records, use the excludeRelated property.
Example	See Recurring Task: XML and JSON Examples.
Properties	See Recurring Task Web Services#Properties Properties.
Example Response	Status 200 /OK Successfully updated the <task type> task with sysId <sysId> to version <version>.

Anchor

	Read a Recurring Task
	Read a Recurring Task

Read a Recurring Task

	Description
URI	http://host_name/uc/resources/task
HTTP Method	GET
Description	Retrieves information on the specified task.
Request Parameters	`taskid` or `taskname`
Mutually Exclusive Parameters	`taskid` and `taskname`
Example URI	http://localhost:8080/uc/resources/task?taskname=testTask http://localhost:8080/uc/resources/task?taskid=d26265a2c4f345359d9b356f18a462c1
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	Status 200 /OK (See Recurring Task: XML and JSON Examples.) Status 404 /Not Found A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
Properties	See Recurring Task Web Services#Properties Properties.

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 XML.

...

Examples

XML

JSON

Example for Task

Expand

title	XML

<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

title	JSON

{
  "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.

See Task Web Services - Task-Related Records for XML and JSON examples of task-related records.

Anchor

	Properties
	Properties

Properties

See All Tasks Properties
See Recurring Task Properties

...

Versions Compared

Old Version 1

New Version Current

Key

Create a Recurring Task

Modify a Recurring Task

Read a Recurring Task

Recurring Task: XML and JSON Examples

Properties

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Create a Recurring Task

Modify a Recurring Task

Read a Recurring Task

Recurring Task: XML and JSON Examples

Properties