Versions Compared

Old Version 1

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 2

changes.mady.by.user Stonebranch

Saved on

Key

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

...

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.

Links to detailed information about the properties used in these web services also is located on this page.
 

For information on Task web services that are applicable to all task types, see:

Anchor
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 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 Universal Monitor Task: XML and JSON Examples, below.

Properties

See Properties 206384670.

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 Universal Monitor Task properties without modifying related records, use the excludeRelated property.

Example

See Universal Monitor Task: XML and JSON Examples.

Properties

See Properties 206384670.

Example Response

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

...


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

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Properties

See Properties 206384670.

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.

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

...

Examples

XML

JSON

Example for Task


Expandcode
titlelanguageXMLtext
<taskUniversalMonitor<?xml exportReleaseLevelversion="7.2.01.0" exportTable="ops_encoding="UTF-8" standalone="yes"?>
<taskUniversalMonitor exportReleaseLevel="7.5.0.0" exportTable="ops_task_universal_monitor" retainSysIds="true" version="14">
    <variables/>
   <actions <notes/>
    <eventBusinessServiceCriteria>Member of Specific <variablesBusiness />Services or Unassigned</eventBusinessServiceCriteria>
    <eventBusinessServices>
<notes />        <virtualResources /><businessService>X</businessService>
       <exclusiveTasks <businessService>Y</>
businessService>
      <avgRunTime>3</avgRunTime>
  <businessService>Z</businessService>
    <avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay>/eventBusinessServices>
    <cpDuration />
 <cpDuration />  <cpDurationUnit>Minutes</cpDurationUnit>
     <cpDurationUnit>Minutes<<customField1/cpDurationUnit>
       <credentials <customField2/>
    <efDayConstraint>None</efDayConstraint>
  <credentialsVar />
 <efDuration>00:00:00:00</efDuration>
    <efEnabled>false</efEnabled>
 <customField1 label="Domain">web.com</customField1>  <efNthAmount>5</efNthAmount>
    <efOffsetDuration <customField2 />
    <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>
    <efDayConstraint>Nth</efDayConstraint><efOffsetPercentage>0</efOffsetPercentage>
    <efOffsetType>Percentage</efOffsetType>
    <efDuration>00:00:00<efTime>00:00</efDuration>efTime>
       <efEnabled>false</efEnabled>
       <efNthAmount>10</efNthAmount>
       <efOffsetDuration />
       <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime>
       <efType>Time</efType>
       <eventTemplate />
       <eventType>Local/<eventType>
       <executionRestriction>Run</executionRestriction>
       <expirationAction>Finished</expirationAction>
       <filter>
           <criterion>
               <name>tfield</name>
               <operator>NOT_EQUALS</operator>
               <value>Test</value>
           </criterion>
           <logicalOperator>And</logicalOperator>
       </filter>
       <firstRun>2021-03-15 13:59:37 -0400</firstRun>
       <holdResources>false</holdResources>
       <lastRun>2021-03-16 17:12:42 -0400</lastRun>
       <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>
       <name>uc - Test Email</name>
       <opswiseGroups /> 
       <relativeTimeFrom>00:00</relativeTimeFrom>
       <relativeTimeTo />
       <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>
       <taskUniversal>Sample1</taskUniversal>
       <taskUniversalVariables>
           <variable>
               <name>v_enabled</name>
               <value>${var}</value>
               <resolution>Enabled</resolution>
           </variable>
           <variable>
               <name>v_disabled</name>
               <value>${var}</value>
               <resolution>Disabled</resolution>
           </variable>
       </taskUniversalVariables>
       <template>Test Template</template>
       <templateEventTemplate label="Test Event B">test_event_b</templateEventTemplate>
       <timeScope>-- None --</timeScope>
       <timeZonePref>-- System Default --</timeZonePref>
       <twDelayAmount<efType>Time</efType>
    <enforceVariables>false</enforceVariables>
    <eventTemplate label="UAC - Agent Changed">uac_agent_changed</eventTemplate>
    <eventType>Global</eventType>
    <exclusiveWithSelf>false</exclusiveWithSelf>
    <executionRestriction>None</executionRestriction>
    <expirationAction>Failed</expirationAction>
    <filter>
        <logicalOperator>And</logicalOperator>
    </filter>
    <firstRun></firstRun>
    <holdResources>false</holdResources>
    <lastRun></lastRun>
    <lfDayConstraint>None</lfDayConstraint>
    <lfDuration>00:00:00:00</lfDuration>
    <lfEnabled>false</lfEnabled>
    <lfNthAmount>5</lfNthAmount>
    <lfOffsetDuration />
    <lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>
    <lfOffsetPercentage>0</lfOffsetPercentage>
    <lfOffsetType>Percentage</lfOffsetType>
    <lfTime>00:00</lfTime>
    <lfType>Time</lfType>
    <lockVariables>false</lockVariables>
    <logLevel>Inherited</logLevel>
    <lsDayConstraint>None</lsDayConstraint>
    <lsDuration>00:00:00:00</lsDuration>
    <lsEnabled>false</lsEnabled>
    <lsNthAmount>5</lsNthAmount>
    <lsTime>00:00</lsTime>
    <lsType>Time</lsType>
    <name>UM</name>
    <actions/>
    <opswiseGroups/>
    <relativeTimeFrom>00:00</relativeTimeFrom>
    <relativeTimeTo />
    <resPriority>10</resPriority>
    <resolveNameImmediately>false</resolveNameImmediately>
    <restrictionPeriod>None</restrictionPeriod>
    <restrictionPeriodAfterDate />
    <restrictionPeriodAfterTime />
    <restrictionPeriodBeforeDate />
    <restrictionPeriodBeforeTime />
    <restrictionPeriodDateList/>
    <runCount>0</runCount>
    <runTime>0</runTime>
    <simulation>false</simulation>
    <startHeld>false</startHeld>
    <startHeldReason />
       <twDelayDuration>00:00:00:00</twDelayDuration<summary />
    <sysId>36d6cd11669741098963c8f3eb2250ef</sysId>
  <twDelayType>None</twDelayType  <exclusiveTasks/>
    <virtualResources/>
  <twWaitAmount />  <taskUniversal />
    <twWaitDayConstraint>NONE<<taskUniversalVariables/twWaitDayConstraint>
       <twWaitDuration>00:00:00:00</twWaitDuration<template />
    <templateEventTemplate   <twWaitTime>00:00</twWaitTime>
    <timeScope>-- None  --<twWaitType>None</twWaitType>timeScope>
       <twWorkflowOnly><timeZonePref>-- System Default --</twWorkflowOnly/timeZonePref>
    <twDelayAmount />
    <twDelayDuration>00:00:00:00</twDelayDuration>
   <userEstimatedDuration <twDelayType>None</>
</taskUniversalMonitor>
Expand
titleJSON
{twDelayType>
     "type": "taskUniversalMonitor",<twWaitAmount />
   "actions": { <twWaitDayConstraint>None</twWaitDayConstraint>
    "abortActions": [],<twWaitDuration>00:00:00:00</twWaitDuration>
    "emailNotifications": [],<twWaitTime>00:00</twWaitTime>
     "setVariableActions": [],<twWaitType>None</twWaitType>
    <twWorkflowOnly>-- System "snmpNotifications": [],Default --</twWorkflowOnly>
    "systemOperations": []
  },
  "cpDuration": null,<userEstimatedDuration />
</taskUniversalMonitor>



Code Block
languagetext
{
    "cpDurationUnittype": "MinutestaskUniversalMonitor",
    "customField1actions": {
        "labelabortActions": "Domain",[],
        "valueemailNotifications": "http://qa-cntlr-mssql:8080/uc/"
  }[],
  "customField2": {     "labelsetVariableActions": null[],
        "valuesnmpNotifications": null[],
  },   "efDayConstraint": "Nth Day",
  "efDurationsystemOperations": "00:00:00:00", []
   "efEnabled": false},

 "efNthAmount": 10,   "efOffsetDurationcpDuration": null, 
   
  "efOffsetDurationUnitcpDurationUnit": "Minutes",
 
    "efOffsetPercentagecustomField1": 0,
  "efOffsetType {
        "label": "Percentage",
  "efTime": "00:00",
  "efType": "Time",null,
        "eventTemplatevalue": null,

    },
    "eventTypecustomField2": "Local", {
        "exclusiveTaskslabel": []null,
        "executionRestrictionvalue": "Run",
null
   "expirationAction": "Finished",
 },
    "exportReleaseLevelefDayConstraint": "7.2.0.0None",

    "exportTableefDuration": "ops_task_universal_monitor",
00:00:00:00",
    "filterefEnabled": {
false,
     "criteriaefNthAmount": [
5,
    "efOffsetDuration": null,
   {
  "efOffsetDurationUnit": "Minutes",
    "efOffsetPercentage": 0,
    "typeefOffsetType": "criterionPercentage",

    "efTime": "00:00",
       "nameefType": "tfieldTime",

    "enforceVariables": false,
       "operator": "NOT_EQUALS",
        "eventBusinessServiceCriteria": "Member of Specific Business Services or Unassigned",
     "valueeventBusinessServices": "Test"
[
        "X",
}
      ],
  "Y",
   "logicalOperator": "And",
  }
  "firstRunZ": "2021-03-15 13:59:37 -0400",
    ],
    "holdResourceseventTemplate": false,
 {
        "lastRunlabel": "2021-03UAC -16 17:12:42 -0400",
Agent Changed",
        "lastRunTimevalue": 9,
  "lastRunTimeDisplay": "9 Seconds""uac_agent_changed"
    },
    "lfDayConstrainteventType": "Nth DayGlobal",
    "lfDurationexclusiveTasks": "00:00:00:00"[],
    "lfEnabledexclusiveWithSelf": false,
    "lfNthAmountexecutionRestriction": 1"None",
  "lfOffsetDuration": null,  
  "lfOffsetDurationUnitexpirationAction": "MinutesFailed",
 
    "lfOffsetPercentageexportReleaseLevel": "7.5.0.0,
 ",
    "lfOffsetTypeexportTable": "Percentageops_task_universal_monitor",
 
    "lfTimefilter": "00:00",{
        "lfTypelogicalOperator": "TimeAnd",
  "lsDayConstraint": "Nth Day"},
    "lsDurationfirstRun": "00:00:00:00",
    "lsEnabledholdResources": false,
    "lsNthAmountlastRun": 7"",
    "lsTimelfDayConstraint": "00:00None",
    "lsTypelfDuration": "Time00:00:00:00",

    "namelfEnabled": "uc - Test Email", false,
    "noteslfNthAmount": []5,
    "opswiseGroupslfOffsetDuration": null,
  
  "relativeTimeFromlfOffsetDurationUnit": "00:00Minutes",

    "relativeTimeTolfOffsetPercentage": null0,
    "resolveNameImmediatelylfOffsetType": false"Percentage",
    "resPrioritylfTime": 10,"00:00",
    "restrictionPeriodlfType": "SpanTime",,
    "restrictionPeriodAfterDatelockVariables": "2017-11-10"false,
    "restrictionPeriodAfterTimelogLevel": "10:30Inherited",
    "restrictionPeriodBeforeDatelsDayConstraint": "2017-11-20None",
    "restrictionPeriodBeforeTimelsDuration": "1500:00:00:00",
  "restrictionPeriodDateList": [],
  "retainSysIdslsEnabled": truefalse,

 "runCount": 32,
  "runTimelsNthAmount": 1085,
    "startHeldlsTime": false,"00:00",
    "startHeldReasonlsType": null"Time",
    "summaryname": "Test EmailUM",
    "sysIdnotes": "fb59a227517a421a92c15ff5aefe3b66",
[],
    "taskUniversalopswiseGroups": "Sample1",
[],
    "relativeTimeFrom"taskUniversalVariables: "00:00",
[
    "relativeTimeTo": null,
    {
 "resPriority": 10,
      "resolveNameImmediately": false,
     "namerestrictionPeriod": "v_enabledNone",

      "restrictionPeriodAfterDate": null,
      "resolutionrestrictionPeriodAfterTime": "Enabled"null,

        "restrictionPeriodBeforeDate": null,
    "valuerestrictionPeriodBeforeTime": "${var}"
null,
         },
"restrictionPeriodDateList": [],
    "retainSysIds": true,
   {
 "runCount": 0,
    "runTime": 0,
     "namesimulation": "v_disabled"false,

        "startHeld": false,
    "resolutionstartHeldReason": "Disabled"null,

        "summary": null,
    "valuesysId": "${var}"
36d6cd11669741098963c8f3eb2250ef",
      "taskUniversal": null,
  }
  ]
  "templatetaskUniversalVariables": "Test Template",
  "templateEventTemplate":
 [],
    "labeltemplate": "Test Event B",
null,
     "valuetemplateEventTemplate": test_event_b"
 null,
  },
  "timeScope": "-- None --",
    "timeZonePref": "-- System Default --",
    "twDelayAmount": null,
    "twDelayDuration": "00:00:00:00",
    "twDelayType": "None",
    "twWaitAmount": null,
    "twWaitDayConstraint": "NONENone",
    "twWaitDuration": "00:00:00:00",
    "twWaitTime": "00:00",
    "twWaitType": "None",
    "twWorkflowOnly": "-- System Default --",
    "userEstimatedDuration": null,
    "variables": [],
    "version": 14,
    "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