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

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

...

Anchor
Create a

...

Universal Monitor Task
Create a

...

Universal Monitor Task
Create a

...

Universal Monitor Task

	Description
URI	http://host_name/uc/resources/task
HTTP Method	POST
Description	Creates a new Variable Universal Monitor task. To persist sysIds, use the retainSysIds property.
Example URI	http://localhost:8080/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Variable Universal Monitor Task: XML and JSON Examples, below.
Properties	See Properties.
Example Response	Status 200 /OK Successfully created the <task type> task with sysId <sysId>.

Anchor
Modify a

...

Universal Monitor Task
Modify a

...

Universal Monitor Task
Modify a

...

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

Anchor
Read a

...

Universal Monitor Task
Read a

...

Universal Monitor Task
Read a

...

Universal Monitor 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 Variable Universal Monitor Task: XML and JSON Examples.) Status 404 /Not Found A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
Properties	See Properties.

Anchor

...

Universal Monitor Task XML and JSON Examples

...

Universal Monitor Task XML and JSON Examples

...

Universal Monitor Task: XML and JSON Examples

The retainSysIds and version properties are specified as attributes in XML.

...

Examples

...

XML

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

Examples

XML

JSON

Example for Task

Expand

title	XML

<taskVariableMonitor<taskUniversalMonitor exportReleaseLevel="7.2.0.0" exportTable="ops_task_universal_monitor" 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>
       <eventTemplate <executionRestriction>Run</executionRestriction>
       <expirationAction>failed</expirationAction>
eventType>Local/<eventType>
       <firstRun>2021-03-15 13:59:37 -0400</firstRun>
executionRestriction>Run</executionRestriction>
       <holdResources>false<expirationAction>Finished</holdResourcesexpirationAction>
       <lastRun>2021-03-16 17:12:42 -0400</lastRunfilter>
       <lastRunTime>9</lastRunTime>
    <criterion>
      <lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>        <lfDayConstraint>Nth</lfDayConstraint><name>tfield</name>
         <lfDuration>00:00:00:00</lfDuration>      <operator>NOT_EQUALS</operator>
  <lfEnabled>false</lfEnabled>        <lfNthAmount>1</lfNthAmount>        <lfOffsetDuration <value>Test</>
       <lfOffsetDurationUnit>MInutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime>value>
           </criterion>
           <lfType>Time</lfType>
<logicalOperator>And</logicalOperator>
       <lsDayConstraint>Nth</lsDayConstraintfilter>
        <lsDuration>00:00:00:00</lsDuration<firstRun>2021-03-15 13:59:37 -0400</firstRun>
       <lsEnabledholdResources>false</lsEnabledholdResources>
        <lsNthAmount>7</lsNthAmount><lastRun>2021-03-16 17:12:42 -0400</lastRun>
        <lsTime>00:00</lsTime<lfDayConstraint>Nth</lfDayConstraint>
       <lsType>Time</lsType>
lfDuration>00:00:00:00</lfDuration>
       <maxRunTime>9<lfEnabled>false</maxRunTimelfEnabled>

       <maxRunTimeDisplay>9 Seconds</maxRunTimeDisplay>
       <minRunTime>3</minRunTime>
       <minRunTimeDisplay>3 Seconds</minRunTimeDisplaylfNthAmount>1</lfNthAmount>
       <lfOffsetDuration />
       <lfOffsetDurationUnit>MInutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime>
       <name>uc - Test Email</namelfType>Time</lfType>
       <opswiseGroups lsDayConstraint>Nth</lsDayConstraint> 
       <resolveNameImmediately>false</resolveNameImmediatelylsDuration>00:00:00:00</lsDuration>
       <resPriority>10<lsEnabled>false</resPrioritylsEnabled>
       <restrictionPeriod>Span<lsNthAmount>7</restrictionPeriodlsNthAmount>
       <restrictionPeriodAfterDate>2017-11-10</restrictionPeriodAfterDatelsTime>00:00</lsTime>
       <restrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime>lsType>Time</lsType>
       <name>uc <restrictionPeriodBeforeDate>2017-11-20</restrictionPeriodBeforeDate- Test Email</name>
       <restrictionPeriodBeforeTime>15:00</restrictionPeriodBeforeTimeopswiseGroups /> 
       <restrictionPeriodDateList /relativeTimeFrom>00:00</relativeTimeFrom>
       <runCount>32<relativeTimeTo /runCount>

       <runTime>108<resolveNameImmediately>false</runTimeresolveNameImmediately>
       <startHeld>false<resPriority>10</startHeldresPriority>
       <startHeldReason restrictionPeriod>Span</restrictionPeriod> 
       <summary>Test Email</summaryrestrictionPeriodAfterDate>2017-11-10</restrictionPeriodAfterDate>
       <sysId>fb59a227517a421a92c15ff5aefe3b66</sysIdrestrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime>
       <timeZonePref>restrictionPeriodBeforeDate>2017-11-20</restrictionPeriodBeforeDate>
System  Default --</timeZonePref     <restrictionPeriodBeforeTime>15:00</restrictionPeriodBeforeTime>
       <twDelayAmountrestrictionPeriodDateList />
       <runCount>32</runCount>
     <twDelayDuration>00:00:00:00</twDelayDuration  <runTime>108</runTime>
       <twDelayType>None<startHeld>false</twDelayTypestartHeld>
       <twWaitAmountstartHeldReason /> 
      <twWaitDayConstraint>NONE</twWaitDayConstraint <summary>Test Email</summary>
       <twWaitDuration>00:00:00:00</twWaitDuration>sysId>fb59a227517a421a92c15ff5aefe3b66</sysId>
        <twWaitTime>00:00</twWaitTime><taskUniversal>Sample1</taskUniversal>
        <twWaitType>None</twWaitType><template>Test Template</template>
        <twWorkflowOnly>-- System Default --</twWorkflowOnly>templateEventTemplate label="Test Event B">test_event_b</templateEventTemplate>
       <timeScope>-- None --<userEstimatedDuration /timeScope>
       <timeLimit>12</timeLimittimeZonePref>-- System Default --</timeZonePref>
       <timeLimitUnit>Hours<twDelayAmount /timeLimitUnit>
       <value>val</valuetwDelayDuration>00:00:00:00</twDelayDuration>
       <valueCondition>regex<twDelayType>None</valueConditiontwDelayType>
       <valueMonitorType>Current<twWaitAmount /valueMonitorType>
       <variableName>demo_ops_global</variableName>
</taskVariableMonitor>

Expand

title	JSON

{
  "type": "taskVariableMonitor",
  "actionstwWaitDayConstraint>NONE</twWaitDayConstraint>
       <twWaitDuration>00:00:00:00</twWaitDuration>
       <twWaitTime>00:00</twWaitTime>
       <twWaitType>None</twWaitType>
       <twWorkflowOnly>-- System Default --</twWorkflowOnly>
       <userEstimatedDuration />
</taskUniversalMonitor>

Expand

title	JSON

{
  "type": "taskUniversalMonitor",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "customField1": {
    "label": "Domain",
    "value": "http://qa-cntlr-mssql:8080/uc/"
  },
  "customField2": {
    "abortActionslabel": []null,
    "emailNotificationsvalue": [] null
  },
  "efDayConstraint": "Nth Day",
  "setVariableActionsefDuration": [],
 "00:00:00:00",
  "efEnabled": false,
  "snmpNotificationsefNthAmount": []10,
  "efOffsetDuration": null,  
  "systemOperationsefOffsetDurationUnit": []
  }"Minutes",
   "avgRunTimeefOffsetPercentage": 30,
   "avgRunTimeDisplayefOffsetType": "3 SecondsPercentage",
 
  "cpDurationefTime": null,
  "cpDurationUnit"00:00",
  "efType": "MinutesTime",
  "credentialseventTemplate": null,

  "credentialsVareventType": null"Local",
  "customField1exclusiveTasks": {[],
    "labelexecutionRestriction": "DomainRun",
  "expirationAction": "Finished",
  "valueexportReleaseLevel": "http://qa-cntlr-mssql:8080/uc/"
  },
7.2.0.0",
  "customField2exportTable": {
  "ops_task_universal_monitor",
  "labelfilter": null,{
      "valuecriteria": null
  },[
    "efDayConstraint": "Nth Day",   "efDuration": "00:00:00:00", {
    "efEnabled": false,   "efNthAmount": 10,   "efOffsetDuration": null,  
  "efOffsetDurationUnittype": "Minutescriterion",
  "efOffsetPercentage": 0,
  "efOffsetType              "name": "Percentagetfield",
               "efTimeoperator": "00:00NOT_EQUALS",
   "efType           "value": "Time",Test"
          }
 "excludeRelated": false,   "exclusiveTasks": [],
      "executionRestrictionlogicalOperator": "RunAnd",
  "expirationAction": "regex",}
  "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 "00:00",
  "lsType": "Time",
  "name": "uc - Test Email",
  "lsTypenotes": "Time",
[],
  "maxRunTimeopswiseGroups": 9null, 
  "maxRunTimeDisplayrelativeTimeFrom": "9 Seconds00:00",
  "minRunTimerelativeTimeTo": 3null,

  "minRunTimeDisplayresolveNameImmediately": false,
  "3 Seconds"resPriority": 10,
  "namerestrictionPeriod": "uc - Test EmailSpan",
  "notesrestrictionPeriodAfterDate": []"2017-11-10",
  "opswiseGroupsrestrictionPeriodAfterTime": null"10:30",
   "resolveNameImmediatelyrestrictionPeriodBeforeDate": false"2017-11-20",
  "resPriorityrestrictionPeriodBeforeTime": 10"15:00",
  "restrictionPeriodrestrictionPeriodDateList": "Span"[],
  "restrictionPeriodAfterDateretainSysIds": "2017-11-10",
true,
  "restrictionPeriodAfterTimerunCount": "10:30",
32,
  "restrictionPeriodBeforeDaterunTime": "2017-11-20"108,
  "restrictionPeriodBeforeTimestartHeld": "15:00"false,
  "restrictionPeriodDateListstartHeldReason": []null,  
  "retainSysIdssummary": "Test trueEmail",

  "runCountsysId": 32"fb59a227517a421a92c15ff5aefe3b66",
  "runTimetaskUniversal": 108"Sample1",

  "startHeldtemplate": "Test falseTemplate",
   "startHeldReasontemplateEventTemplate":
 null,     "summarylabel": "Test EmailEvent B",
      "sysIdvalue": "fb59a227517a421a92c15ff5aefe3b66",test_event_b"
  },
   "timeLimittimeScope": 12,"--   "timeLimitUnit": "HoursNone --",
  "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,

 "value": "val",
  "valueCondition": "regex",
  "valueMonitorType": "Current",
  "variableName": "demo_ops_global",
  "variables": [],
  "version": 1,
  "virtualResources": []
}

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

...

See All Tasks Properties
See Variable Universal Monitor Task Properties

Versions Compared

Old Version 1

New Version Current

Key

Anchor
Create a

Universal Monitor Task
Create a

Universal Monitor Task
Create a

Universal Monitor Task

Anchor
Modify a

Universal Monitor Task
Modify a

Universal Monitor Task
Modify a

Universal Monitor Task

Anchor
Read a

Universal Monitor Task
Read a

Universal Monitor Task
Read a

Universal Monitor Task

Anchor

Universal Monitor Task XML and JSON Examples

Universal Monitor Task XML and JSON Examples

Universal Monitor Task: XML and JSON Examples

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

AnchorCreate a

Universal Monitor TaskCreate a

Universal Monitor TaskCreate a

Universal Monitor Task

AnchorModify a

Universal Monitor TaskModify a

Universal Monitor TaskModify a

Universal Monitor Task

AnchorRead a

Universal Monitor TaskRead a

Universal Monitor TaskRead a

Universal Monitor Task

Anchor

Universal Monitor Task XML and JSON Examples

Universal Monitor Task XML and JSON Examples

Universal Monitor Task: XML and JSON Examples

Anchor
Create a

Universal Monitor Task
Create a

Universal Monitor Task
Create a

Anchor
Modify a

Universal Monitor Task
Modify a

Universal Monitor Task
Modify a

Anchor
Read a

Universal Monitor Task
Read a

Universal Monitor Task
Read a