Versions Compared

Key

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

...

Universal Controller supports the following RESTful-based web services for Composite 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
<triggerComposite retainSysIds="true" version="1">
       <variables />
       <action>Do Not Trigger</action>
<notes /> <calendar>System Default</calendar> <description /> <disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledEnd>00:00</enabledEnd>
<enabledStart>05:00</enabledStart>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>test composite trigger</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime\<opswiseGroups />
<queueDepth>100</queueDepth
<rdExcludeBackup>true</rdExcludeBackup
<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><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>
<timeLimit />
<timeLimitUnits>Minutes</timeLimitUnits>
<timeZone />
</triggerComposite>
Expand
titleJSON
{
  "type": "triggerEm",
  "action": "Do Not Trigger",
  "calendar": "System Default",
  "description": null,
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledEnd": "00:00",
"enabledStart": "00:00",
"enabledTime": "2021-03-03 12:46:11 -0500",
"name": "test composite trigger",
"nextScheduledTime": "2021-03-04 00:00:00 -0500",
"notes": [ ],
"opswiseGroups": [ ],
"queueDepth": 100,
"rdExcludeBackup": true,
"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",
"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" ],
"timeLimit": null,
"timeLimitUnits": "Minutes",
"timeZone": null,
"variables": [ ],
"version": 1 }

Anchor
Example for Trigger-Related Records
Example for Trigger-Related Records
Example for Trigger-Related Records

Expand
titleXML
<variables>
   <variable>
         <description />
         <name>testVar</name>
         <value>value</value>
   </variable>
</variables>
Expand
titleJSON
"variables": [ {
  "description": "description",
  "name": "var1",
  "value": "value1",
} ]

Anchor
Example for Composite Trigger Components
Example for Composite Trigger Components
Example for Composite Trigger Components

Expand
titleXML

Anchor
Composite Trigger - Time Component Example
Composite Trigger - Time Component Example
Composite Trigger: Time Component


<timeComponent>
       <action>Do Not Trigger</action>
       <description />
<disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledEnd>00:00</enabledEnd>
<enabledStart>05:00</enabledStart>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>test special day</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime><restrictionAdjective>Every</restrictionAdjective><restrictionComplex>false</restrictionComplex><restrictionMode>Or</restrictionMode><restrictionNoun>Day</restrictionNoun>
<restrictionNthAmount />
<restrictionQualifier>Year</restrictionQualifier><restrictionSimple>false</restrictionSimple><situation>Holiday</situation><sysId>0fc6b7d9c0a801c9017b6c27c259937e</sysId>
<variablePrefix />
<adjustInterval>false</adjustInterval><adjustmentAmount>1</adjustmentAmount><adjustmentType>Day</adjustmentType><dateAdjective>Every</dateAdjective><dateAdjustment>None</dateAdjustment><dateNoun>Saturday1</dateNoun>
<dateQualifier>Year</dateQualifier>
<dayInterval>2</dayInterval>
<dayStyle>Complex</dayStyle> <eventMatchType>Single</eventMatchType>
<fri>false</fri><intervalStartingDate>2015-06-17</intervalStartingDate><mon>false</mon>
<nthAmount>5</nthAmount>
<sat>false</sat>
<simpleDateType>Daily</simpleDateType><startTimeEnable>false</startTimeEnable><startingAt>*:00</startingAt>
<sun>false</sun>
<thu>false</thu>
<time>00:00</time>
<timeInterval />
<timeIntervalUnits>Hours</timeIntervalUnits><timeStyle>Absolute</timeStyle>
<tue>false</tue>
<wed>false</wed>
</timeComponent>


 
 
 
 
 
 
 
 
 
 

Anchor
Composite Trigger - File Monitor Component Example
Composite Trigger - File Monitor Component Example
Composite Trigger: File Monitor Component


<fileMonitorComponent> <action>Do Not Trigger</action> <description /> <disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledEnd>00:00</enabledEnd>
<enabledStart>05:00</enabledStart>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>test file monitor component</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime> <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> <situation>Holiday</situation> <sysId>5d2ac48e2dd64b5894bef1809a0e4d33</sysId>
<variablePrefix />
<fileMonitor>file monitor 1</fileMonitor>
</fileMonitorComponent>

 
 
 
 
 

Anchor
Composite Trigger - Task Monitor Component Example
Composite Trigger - Task Monitor Component Example
Composite Trigger: Task Monitor Component


<taskMonitorComponent> <action>Do Not Trigger</action> <description /> <disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledEnd>00:00</enabledEnd>
<enabledStart>05:00</enabledStart>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>test task monitor component</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime> <restrictionComplex>false</restrictionComplex> <restrictionMode>Or</restrictionMode> <restrictionAdjective>Every</restrictionAdjective> <restrictionNoun>Day</restrictionNoun>
<restrictionNthAmount /> <restrictionQualifier>Year</restrictionQualifier> <restrictedTimes>false</restrictedTimes> <restriction>false</restriction> <restrictionComplex>false</restrictionComplex> <restrictionMode>Or</restrictionMode> <restrictionSimple>false</restrictionSimple> <situation>Holiday</situation> <sysId>2445dbd9e58546b69e5d5032f12646a4</sysId>
<variablePrefix />
<taskMonitor>test task monitor</taskMonitor> </taskMonitorComponent>

 
 
 
 
 

Anchor
Composite Trigger - Variable Monitor Component Example
Composite Trigger - Variable Monitor Component Example
Composite Trigger: Variable Monitor Component


<variableMonitorComponent>
       <action>Do Not Trigger</action>
       <description />
<disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledEnd>00:00</enabledEnd>
<enabledStart>05:00</enabledStart>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>test variable monitor component</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime> <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> <situation>Holiday</situation> <sysId>2445dbd9e58546b69e5d5032f12646a4</sysId>
<variablePrefix />
<variableMonitor>mon-1</variableMonitor> </variableMonitorComponent>

 
 
 
 

Anchor
Composite Trigger - Email Monitor Component Example
Composite Trigger - Email Monitor Component Example
Composite Trigger: Email Monitor Component


<emailMonitorComponent>
       <action>Do Not Trigger</action>
       <description />
<disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledEnd>00:00</enabledEnd>
<enabledStart>05:00</enabledStart>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>test email monitor component</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime> <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> <situation>Holiday</situation> <sysId>2445dbd9e58546b69e5d5032f12646a4</sysId>
<variablePrefix />
<emailMonitor>test-EM</emailMonitor> </emailMonitorComponent>
Expand
titleJSON

Composite Trigger: Time Component

"timeComponents": [ {
      "action": "Do Not Trigger",
      "adjustInterval": false,
      "adjustmentAmount": 1,
      "adjustmentType": "Day",
      "dateAdjective": "Every",
      "dateAdjustment": "None",
      "dateNoun": {
        "value": "Day"
      },
      "dateQualifier": {
        "value": "Year"
      },
      "dayInterval": 2,
      "dayStyle": "Simple",
      "description": null,
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin", "enabledEnd": "00:00", "enabledStart": "00:00",
"enabledTime": "2021-03-03 12:46:11 -0500", "eventMatchType": "Single", "fri": false, "intervalStartingDate": "2017-12-15", "mon": false, "name": "test special day",
"nextScheduledTime": "2021-03-04 00:00:00 -0500", "nthAmount": 5, "restrictedTimes": false, "restriction": false, "restrictionAdjective": "Every", "restrictionComplex": false, "restrictionMode": "Or", "restrictionNoun": { "value": "Day" }, "restrictionNthAmount": null, "restrictionQualifier": { "value": "Year" }, "restrictionSimple": false, "sat": false, "simpleDateType": "Daily", "situation": "Holiday", "startTimeEnable": false, "startingAt": "*:00", "sun": false, "sysId": "b9c462f58a624a41a9a5ed824339cc00", "thu": false, "time": "00:00", "timeInterval": null, "timeIntervalUnits": "Hours", "timeStyle": "Absolute", "tue": false, "variablePrefix": null, "wed": false } ],

 
Composite Trigger: File Monitor Component

"fileMonitorComponents": [ {
      "action": "Do Not Trigger",
      "description": null,
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledEnd": "00:00",
"enabledStart": "00:00",
"enabledTime": "2021-03-03 12:46:11 -0500", "fileMonitor": "file monitor 1", "name": "test file monitor component",
"nextScheduledTime": "2021-03-04 00:00:00 -0500", "restrictedTimes": false, "restriction": false, "restrictionAdjective": "Every", "restrictionComplex": false, "restrictionMode": "Or", "restrictionNoun": { "value": "Day" }, "restrictionNthAmount": null, "restrictionQualifier": { "value": "Year" }, "restrictionSimple": false, "situation": "Holiday", "sysId": "4908349365b34c49998ff2a051163fa5", "variablePrefix": null } ],

 
Composite Trigger: Task Monitor Component

"taskMonitorComponents": [ {
      "action": "Do Not Trigger",
      "description": null,
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledEnd": "00:00",
"enabledStart": "00:00",
"enabledTime": "2021-03-03 12:46:11 -0500", "name": "test task monitor component",
"nextScheduledTime": "2021-03-04 00:00:00 -0500", "restrictedTimes": false, "restriction": false, "restrictionAdjective": "Every", "restrictionComplex": false, "restrictionMode": "Or", "restrictionNoun": { "value": "Day" }, "restrictionNthAmount": null, "restrictionQualifier": { "value": "Year" }, "restrictionSimple": false, "situation": "Holiday", "sysId": "4a557c7d82974960a1c9a45457b12eb8", "taskMonitor": "test task monitor", "variablePrefix": null } ],

 
Composite Trigger: Variable Monitor Component

"variableMonitorComponents": [ {
      "action": "Do Not Trigger",
      "description": null,
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledEnd": "00:00",
"enabledStart": "00:00",
"enabledTime": "2021-03-03 12:46:11 -0500", "name": "test variable monitor component",
"nextScheduledTime": "2021-03-04 00:00:00 -0500", "restrictedTimes": false, "restriction": false, "restrictionAdjective": "Every", "restrictionComplex": false, "restrictionMode": "Or", "restrictionNoun": { "value": "Day" }, "restrictionNthAmount": null, "restrictionQualifier": { "value": "Year" }, "restrictionSimple": false, "situation": "Holiday", "sysId": "4ccf4458aa834b11a3f24dfe994c1c44", "variableMonitor": "mon-1", "variablePrefix": null } ]


 
Composite Trigger: Email Monitor Component

"emailMonitorComponents": [ {
      "action": "Do Not Trigger",
      "description": null,
      "emailMonitor": "test-EM",
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledEnd": "00:00",
"enabledStart": "00:00",
"enabledTime": "2021-03-03 12:46:11 -0500", "name": "test email monitor component",
"nextScheduledTime": "2021-03-04 00:00:00 -0500", "restrictedTimes": false, "restriction": false, "restrictionAdjective": "Every", "restrictionComplex": false, "restrictionMode": "Or", "restrictionNoun": { "value": "Day" }, "restrictionNthAmount": null, "restrictionQualifier": { "value": "Year" }, "restrictionSimple": false, "situation": "Holiday", "sysId": "2c6f4ece771b44ec858e3c2df917e9ba", "variablePrefix": null
    
} ]
Examples for Trigger-Related Records

Variables

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

Notes

Expand
titleXML
<notes>
   <note>
         <Composite Trigger Web Services#sysIdsysId>76ad570c64b84f84aeaf281403856b10</Composite Trigger Web Services#sysIdsysId>
         <Composite Trigger Web Services#texttext>testNoteText</Composite Trigger Web Services#texttext>
         <Composite Trigger Web Services#titletitle>testNoteTitle</Composite Trigger Web Services#titletitle>
   </note>
</notes>

Variables

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

Notes

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

Anchor
Properties
Properties
Properties

...