Versions Compared

Key

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

...

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

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

...

Examples

XML

JSON

Example for Trigger

Expand
titleXML
<triggerVm retainSysIds="true" version="1">
       <variables />
       <action>Do Not Trigger</action>
<notes /> <calendar>System Default</calendar> <description>description</description>
<disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>test variable monitor trigger</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime>
<opswiseGroups />
<rdExcludeBackup>true</rdExcludeBackup>
<restrictedTimes>false</restrictedTimes>
<restriction>false</restriction>
<restrictionAdjective>Every</restrictionAdjective>
<restrictionComplex>false</restrictionComplex>
<restrictionMode>Or</restrictionMode>
<restrictionNoun>Day</restrictionNoun>
<restrictionNthAmount />
<restrictionQualifier>Year</restrictionQualifier>
<restrictionSimple>false</restrictionSimple>
<retentionDuration>1</retentionDuration>
<retentionDurationPurge>true</retentionDurationPurge>
<retentionDurationUnit>Days</retentionDurationUnit>
<simulationOption>-- System Default --</simulationOption>
<situation>Holiday</situation>
<skipAfterDate>2020-05-28</skipAfterDate>
<skipAfterTime>02:15</skipAfterTime>
<skipBeforeDate>2020-05-30</skipBeforeDate>
<skipBeforeTime>17:30</skipBeforeTime>
<skipCondition>None</skipCondition>
<skipCount>0</skipCount>
<skipDateList />
<skipRestriction>Span</skipRestriction>
<sysId>0fc6b7d9c0a801c9017b6c27c259937e</sysId>
<tasks>
<task>Sleep 30</task>
</tasks>
<timeZone />
<enabledEnd>00:00</enabledEnd>
<enabledStart>00:00</enabledStart>
<restrictedTimes>false</restrictedTimes>
<variableMonitor>test vm</variableMonitor>
</triggerVm>
Expand
titleJSON
{
  "type": "triggerVm",
  "action": "Do Not Trigger",
  "calendar": "System Default",
  "description": "description",
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledTime": "2021-03-03 12:46:11 -0500",
"enabledEnd": "00:00",
"enabledStart": "00:00",
"name": "test variable monitor trigger",
"nextScheduledTime": "2021-03-04 00:00:00 -0500",
"notes": [],
"opswiseGroups": [ ],
"rdExcludeBackup": true,
"restrictedTimes": false,
"restriction": false,
"restrictionAdjective": "Every",
"restrictionComplex": false,
"restrictionMode": "Or",
"restrictionNoun": { "value": "Day" },
"restrictionNthAmount": null,
"restrictionQualifier": { "value": "Year" },
"restrictionSimple": false,
"retainSysIds": true,
"retentionDuration": 1,
"retentionDurationPurge": true,
"retentionDurationUnit": "Days",
"simulationOption": "-- System Default --",
"situation": "Holiday",
"skipAfterDate": "2020-05-28",
"skipAfterTime": "02:15",
"skipBeforeDate": "2020-05-30",
"skipBeforeTime": "17:30",
"skipCondition": "None",
"skipCount": 0,
"skipDateList": [ ],
"skipRestriction": "Span",
"sysId": "9c659c9c2c72460c9a2057663257b0be",
"tasks": [ "Sleep 30" ],
"timeZone": null,
"variableMonitor": "test vm",
"variables": [ ],
"version": 1 }
Examples for Trigger-Related Records

Variables

Expand
titleXML
<variables>
   <variable>
         <description />
         <name>testVar</name>
         <value>value</value>
   </variable>
</variables>

Notes

Expand
titleXML
<notes>
   <note>
         <Variable Monitor Trigger Web Services#sysId>76ad570c64b84f84aeaf281403856b10</Variable Monitor Trigger Web Services#sysIdsysId>76ad570c64b84f84aeaf281403856b10</sysId>
         <Variable Monitor Trigger Web Services#text>testNoteText</Variable Monitor Trigger Web Services#texttext>testNoteText</text>
         <Variable Monitor Trigger Web Services#title>testNoteTitle</Variable Monitor Trigger Web Services#titletitle>testNoteTitle</title>
   </note>
</notes>

Variables

Expand
titleJSON
"variables": [ {
  "description": "description",
  "name": "var1",
  "value": "value1"
} ]

Notes

Expand
titleJSON
"notes": [ {
  "Variable Monitor Trigger Web Services#sysIdsysId": "76ad570c64b84f84aeaf281403856b10",
  "Variable Monitor Trigger Web Services#texttext": "testNoteText",
  "Variable Monitor Trigger Web Services#titletitle": "testNoteTitle"
} ]

Anchor
Properties
Properties
Properties

...