Composite Trigger Web Services

Owned by Former user (Deleted)
Last updated: Jan 30, 2023 by Stonebranch (Deactivated)

Overview

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.
 

Note

For information on Trigger web services that are applicable to all trigger types, see:

Create a Composite Trigger


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

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.

Modify a Composite Trigger


Description

URI

http://host_name/uc/resources/trigger

HTTP Method

PUT

Description

Modifies the trigger specified by the sysId in the Example Request.
 
To modify Composite Trigger properties without modifying related records, use the excludeRelated property.

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Composite Trigger: XML and JSON Examples.

Trigger Properties

Trigger Component Properties

Trigger-Related Record Properties

Example Response

  • Status 200 /OK
    Successfully updated the <trigger type> trigger to version <version>.

Read a Composite Trigger


Description

URI

http://host_name/uc/resources/trigger

HTTP Method

GET

Description

Retrieves information for the specified trigger.

URI Parameters

See Read a Composite Trigger: URI Parameters.

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Trigger Properties

Trigger Component Properties

Trigger-Related Record Properties

Example Response

Read a Composite Trigger: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

triggerid

Unique ID for this trigger.


Y
(unless triggername
is specified)

triggername

triggername

Name used within the Controller to identify this trigger.

Maximum 40 alphanumerics.

Y
(unless triggerid
is specified)

triggerid

Composite Trigger: XML and JSON Examples

In the XML web service, the exportReleaseLevel, exportTable, retainSysIds, and version properties are specified as attributes in the <trigger> element.


Examples

XML

JSON

Example for Trigger

 XML
<triggerComposite exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_composite" 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>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <opswiseGroups />
   <queueDepth>100</queueDepth
   <rdExcludeBackup>true</rdExcludeBackup
   <restriction>false</restriction>
   <restrictionAdjective>Every</restrictionAdjective>
   <restrictionComplex>false</restrictionComplex>
   <restrictionMode>Or</restrictionMode>
   <restrictionNouns>
      <restrictionNoun>Day</restrictionNoun>
   </restrictionNouns>
   <restrictionNthAmount />
   <restrictionQualifiers>
      <restrictionQualifier>Year</retsrictionQualifier>
   </restrictionQualifiers>
   <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>
 JSON
{ 
   "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",
   "exportReleaseLevel": "7.2.0.0",
   "exportTable": "ops_trigger_composite",
   "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",
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "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 
}

Example for Trigger-Related Records

 XML
<variables>
   <variable>
         <description />
         <name>testVar</name>
         <value>value</value>
   </variable>
</variables>
 JSON
"variables": [ {
  "description": "description",
  "name": "var1",
  "value": "value1",
} ]

Example for Composite Trigger Components

 XML
 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>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <restrictionAdjective>Every</restrictionAdjective>
   <restrictionComplex>false</restrictionComplex
   <restrictionMode>Or</restrictionMode>
   <restrictionNouns>
      <restrictionNoun>Day</restrictionNoun>
   </restrictionNouns>
   <restrictionNthAmount />
   <restrictionQualifiers>
      <restrictionQualifier>Year</retsrictionQualifier>
   </restrictionQualifiers>
   <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>


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>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <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>


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>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <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>



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>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <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>


 
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>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <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>

Composite Trigger: Universal Monitor Component

<universalMonitorComponent>
   <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 universal monitor component</name>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <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>


 JSON

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", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "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", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "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", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "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", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "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", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "value": "Year"
      }
   ],
   "restrictionSimple": false, 
   "situation": "Holiday",
   "sysId": "2c6f4ece771b44ec858e3c2df917e9ba",
   "variablePrefix": null 
    } 
]


Composite Trigger: Universal Monitor Component

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

Variables

 XML
<variables>
   <variable>
         <description />
         <name>testVar</name>
         <value>value</value>
   </variable>
</variables>

Notes

 XML
<notes>
   <note>
         <sysId>76ad570c64b84f84aeaf281403856b10</sysId>
         <text>testNoteText</text>
         <title>testNoteTitle</title>
   </note>
</notes>

Variables

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

Notes

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

Properties

Trigger Properties - All Triggers


Property

UI Field Name

Description

Specifications

Required

action

Action

For all trigger types except Manual and Temporary; Action to take on a non-business day or holiday (see situation).

Valid values:

  • As String = Do Not Trigger, As Value = 1
  • As String = Next Day, As Value = 2
  • As String = Next Business Day, As Value = 3
  • As String = Previous Day, As Value = 4
  • As String = Previous Business Day, As Value = 5

Default is Do Not Trigger (1).
 

Note

The following values are valid only for Cron and Time triggers:

  • Next Day (2)
  • Next Business Day (3)
  • Previous Day (4)
  • Previous Business Day (5)

Y
(if restriction
is true.)

calendar

Calendar

Calendar that defines the business days, holidays, and other special days that determine the run dates for the task(s) specified in the trigger.
 
The Calendar will be used to verify any Custom Day references in restrictionNoun and dateNoun.

Default is System Default.

Y

customField1

n/a

User-Defined field.
 
Example: <customField1 label="Domain">web.com</customField1>

The label is included only if a value has been defined for the User Defined Trigger Field 1 Label Universal Controller system property.

N

customField2

n/a

User-Defined field.
 
Example: <customField2 label="Domain">web.com</customField2>

The label is included only if a value has been defined for the User Defined Trigger Field 2 Label Universal Controller system property.

N

description

Description

Description of this trigger.