Versions Compared

Old Version 18

changes.mady.by.user Former user

Saved on

compared with

New Version 19

changes.mady.by.user Former user

Saved on

Key

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

...


Description

URI

http://host_name/uc/resources/trigger

HTTP Method

POST

Description

Retrieves information for the specified trigger.

Example URI

http://localhost:8080/uc/resources/trigger

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Anchor
Example Request
Example Request
Example Request

See Composite Trigger: XML and JSON Examples.

Trigger Properties

Trigger Component Properties

Trigger-Related Record Properties

Example Response

  • Status 200 /OK
    Successfully created the <trigger type> trigger.

...

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 />
       <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

JSON
Expand
titleXML
title

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>20212022-03-03 12:46:11 -0500</enabledTime> 
<name>test email monitor component</name>
<nextScheduleTime>20212022-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


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

"timeComponents": [ {<universalMonitorComponent>
       "<action":>Do "Do Not Trigger",Trigger</action>
      "adjustInterval": false,
      "adjustmentAmount": 1,
      "adjustmentType": "Day",
      "dateAdjective <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 universal 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 /> 
<universalMonitor>test-UM</universalMonitor> 
</universalMonitorComponent>
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":      "dateAdjustmentfalse, 
"restrictionMode": "NoneOr",       "dateNoun
"restrictionNoun": { "value": "Day" }, "restrictionNthAmount": null, "restrictionQualifier":  { "value": "DayYear" }, "restrictionSimple": false, 
"sat": false,  }
"simpleDateType": "Daily", 
"situation": "Holiday", 
"startTimeEnable": false, 
"startingAt": "*:00", 
"dateQualifiersun": {
        "valuefalse, 
"sysId": "Year"
      },
      "dayIntervalb9c462f58a624a41a9a5ed824339cc00", "thu": 2false,       "dayStyle
"time": "Simple00:00",       "description
"timeInterval": null, 
"disabledBytimeIntervalUnits": "Hours", 
"disabledTimetimeStyle": "Absolute", 
"enabledtue": truefalse, 
"enabledByvariablePrefix": null, 
"ops.admin",
wed": false } ],

 
Composite Trigger: File Monitor Component

"fileMonitorComponents": [ {
      "enabledEndaction": "00:00Do Not Trigger",
      "enabledStartdescription": "00:00",
"enabledTimenull,
"disabledBy": "2021-03-03 12:46:11 -0500", 
"eventMatchTypedisabledTime": "Single", 
"frienabled": falsetrue, 
"intervalStartingDateenabledBy": "2017-12-15ops.admin", 
"monenabledEnd": false, 
"name"00: 00"test special day",, 
"nextScheduledTimeenabledStart": "2021-03-04 00:00:00 -0500", 
"nthAmountenabledTime": 5, 
"restrictedTimes": false, 
"restriction": false, 
"restrictionAdjective": "Every", "restrictionComplex": false, 
"restrictionMode": "Or"2021-03-03 12:46:11 -0500", "fileMonitor": "file monitor 1", 
"restrictionNounname": { "value": "Day" }, "restrictionNthAmount": null, "restrictionQualifier": { "value": "Year" }, "restrictionSimpletest file monitor component",
"nextScheduledTime": "2021-03-04 00:00:00 -0500", 
"restrictedTimes": false, 
"satrestriction": false, 
"simpleDateTyperestrictionAdjective": "DailyEvery", 
"situationrestrictionComplex": "Holiday", 
"startTimeEnable": false, 
"startingAtrestrictionMode": "*:00Or", 
"sunrestrictionNoun": false,{ 
"sysIdvalue": "b9c462f58a624a41a9a5ed824339cc00Day", "thu": false }, 
"timerestrictionNthAmount": "00:00"null, 
"timeIntervalrestrictionQualifier": null,{ 
"timeIntervalUnitsvalue": "HoursYear" }, 
"timeStylerestrictionSimple": "Absolute"false, 
"tuesituation": false"Holiday", 
"variablePrefixsysId": null"4908349365b34c49998ff2a051163fa5", 
"wedvariablePrefix": falsenull } ],

 
Composite Trigger: File Task Monitor Component

"fileMonitorComponentstaskMonitorComponents": [ {
      "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 filetask 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", "4908349365b34c49998ff2a051163fa5taskMonitor": "test task monitor", "variablePrefix": null } ],

 
Composite Trigger: Task Variable Monitor Component

"taskMonitorComponentsvariableMonitorComponents": [ {
      "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 taskvariable 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": "4a557c7d82974960a1c9a45457b12eb84ccf4458aa834b11a3f24dfe994c1c44", "taskMonitorvariableMonitor": "test task monitormon-1", 
"variablePrefix": null } ],


 
Composite Trigger: Variable Email Monitor Component

"variableMonitorComponentsemailMonitorComponents": [ {
      "action": "Do Not Trigger"",
      "description": null,
      "descriptionemailMonitor": null"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 variableemail 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"2c6f4ece771b44ec858e3c2df917e9ba", 
"variablePrefix": null 
    } ]


 
Composite Trigger: Email Universal Monitor Component


"emailMonitorComponentsuniversalMonitorComponents": [ {
      "action": "Do Not Trigger",
      "description": null,
      "emailMonitoruniversalMonitor": "test-EMUM",
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledEnd": "00:00",
"enabledStart": "00:00",
"enabledTime": "20212022-03-03 12:46:11 -0500", "name": "test emailuniversal monitor component",
"nextScheduledTime": "20212022-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>
         <sysId>76ad570c64b84f84aeaf281403856b10</sysId>
         <text>testNoteText</text>
         <title>testNoteTitle</title>
   </note>
</notes>

Variables

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

Notes

Expand
titleJSON
"notes": [ {
  "sysId": "76ad570c64b84f84aeaf281403856b10",
  "text": "testNoteText",
  "title": "testNoteTitle"
} ]

...

Property

UI Field Name

Description

Specifications

Required

Anchor
emailMonitor - COMP-EM
emailMonitor - COMP-EM
emailMonitor

Name

Name of the Email Monitor task to be triggered.


Y

Anchor
Trigger Properties - Composite Trigger Variable Monitor Component
Trigger Properties - Composite Trigger Variable Monitor Component
Trigger Properties - Composite Trigger Universal Monitor Component

Property

UI Field Name

Description

Specifications

Required

Anchor
universalMonitor - COMP-UM
universalMonitor - COMP-UM
universalMonitor

Name

Name of the Universal Monitor task to be triggered.


Y

Anchor
Trigger-Related Records Properties Variables
Trigger-Related Records Properties Variables
Trigger-Related Records Properties: Variables

...