Overview

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

Create a Variable Monitor Trigger
Modify a Variable Monitor Trigger
Read a Variable Monitor Trigger

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 Variable Monitor Trigger

	Description
URI	http://host_name/uc/resources/trigger
HTTP Method	POST
Description	Creates a new Variable Monitor Trigger.
Example URI	http://localhost:8080/uc/resources/trigger
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Variable Monitor Trigger: XML and JSON Examples.
Trigger Properties	See Trigger Properties: All Triggers. See Trigger Properties: Variable Monitor Trigger.
Trigger-Related Record Properties	See Trigger-Related Records Properties: Variables. See Trigger-Related Records Properties: Notes.
Example Response	Status 200 /OK Successfully created the <trigger type> trigger.

Modify a Variable Monitor Trigger

	Description
URI	http://host_name/uc/resources/trigger
HTTP Method	PUT
Description	Modifies the trigger specified by the sysId in the request. To modify Variable Monitor 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 Variable Monitor Trigger: XML and JSON Examples.
Trigger Properties	See Trigger Properties: All Triggers. See Trigger Properties: Variable Monitor Trigger.
Trigger-Related Record Properties	See Trigger-Related Records Properties: Variables. See Trigger-Related Records Properties: Notes.
Example Response	Status 200 /OK Successfully updated the <trigger type> trigger to version <version>.

Read a Variable Monitor Trigger

	Description
URI	http://host_name/uc/resources/trigger
HTTP Method	GET
Description	Retrieves information for the specified trigger
URI Parameters	See Read a Variable Monitor Trigger: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/trigger?triggername=testTrigger http://localhost:8080/uc/resources/trigger?triggerid=d26265a2c4f345359d9b356f18a462c1
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Trigger Properties	See Trigger Properties: All Triggers. See Trigger Properties: Variable Monitor Trigger.
Trigger-Related Record Properties	See Trigger-Related Records Properties: Variables. See Trigger-Related Records Properties: Notes.
Example Response	Status 200 /OK (See Variable Monitor Trigger: XML and JSON Examples.) Status 404 /Not Found A trigger with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

Read a Variable Monitor 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`

Variable Monitor 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

<triggerVm exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_vm" 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> 
    <restrictionNouns>
       <restrictionNoun>Day</restrictionNoun>
    </restrictionNouns>
    <restrictionNthAmount />
    <restrictionQualifiers>
       <restrictionQualifier>Year</retsrictionQualifier>
    </restrictionQualifiers>
    <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>
    <taskMonitor>test vm</taskMonitor>
    <tasks> 
       <task>Sleep 30</task> 
    </tasks> 
    <timeZone />
    <enabledEnd>00:00</enabledEnd>
    <enabledStart>00:00</enabledStart>
    <restrictedTimes>false</restrictedTimes>
</triggerVm>

JSON

{
  "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",
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_trigger_vm",
  "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", 
  "restrictionNouns": [
     {
        "value": "Day"
     }
  ], 
  "restrictionNthAmount": null, 
  "restrictionQualifiers": [
     {
        "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",
  "taskMonitor": "test vm",
  "tasks": [ "Sleep 30" ], 
  "timeZone": null,
  "variables": [ ], 
  "version": 1 
}

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`.	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.		N
`disabledBy`	Disabled By	System-supplied. If Status = Enabled, ID of the user who most recently disabled this trigger.	Read-only.	N
`disabledTime`	Disabled Time	System-supplied. If Status = Enabled, Date and time that the trigger was disabled.	Read-only.	N
`enabled`	Status	System-defined; Specification for whether or nor the trigger is enabled. Only enabled triggers are processed by the Controller.	Read-only.	N
`enabledBy`	Enabled By	System-supplied. If Status = Enabled, ID of the user who most recently enabled this trigger.	Read-only.	N
`enabledTime`	Enabled Time	System-supplied. If Status = Enabled, Date and time that the trigger was enabled.	Read-only.	N
`enforceVariables`	Enforce Variables	Specifies whether or not to enforce Override Trigger Variables when using Trigger Now... from the User Interface. Not applicable for Web Service APIs.	Valid values: true/false. Default is false.	N
`excludeRelated`	n/a	For Modify Trigger web services; specification for whether or not to exclude related records from the update, even if they are provided in the request. Note In XML web services, `excludeRelated` is specified as an attribute in the <trigger> element.	Valid values: true/false. Default is false.	N
`exportReleaseLevel`	n/a	Universal Controller release that the record was exported from. Note In XML web services, `exportReleaseLevel` is specified as an attribute in the <trigger> element.	Read-only.	N
`exportTable`	n/a	Record table information. Note In XML web services, `exportTable` is specified as an attribute in the <trigger> element.	Read-only.	N
`forecast`	Forecast	For Cron, Temporary, and Time triggers only; Date and time when this trigger will be satisfied for the next number days, as specified in the Forecast Period In Days Universal Controller system property. The Controller writes the forecasting entries to the Forecasts List.	Boolean; Valid values: true/false. Default is false.	N
`lockVariables`	Lock Variables	Specifies whether or not to prevent editing variables when using Trigger Now... from the User Interface. Not applicable for Web Service APIs.	Boolean; Valid values: true/false. Default is false.	N
`name`	Name	Name used within the Controller to identify this trigger.	Maximum 255 alphanumerics.	Y
`nextScheduledTime`	Next Scheduled Time	System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information.	Read-only.	N
`opswiseGroups`	Member of Business Services	List of Business Service(s) that this trigger belongs to. XML JSON		N
`rdExcludeBackup`	Exclude Backup	Set only if `retentionDurationPurge` is selected; Specification for whether qualifying task instances can be excluded from the backup when being purged by retention duration.	Boolean; Valid values: true/false. Default is false.	N
`restriction`	Special Restriction	Indication of whether or not you want to specify additional parameters that tell the Controller how to handle exceptions, such as when the trigger is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a `simpleRestriction` that disables the trigger if it is satisfied on a holiday identified in the calendar and/or a `restrictionComplex` that disables the trigger on the last business day of every month.	Boolean; Valid values: true/false. Default is false.	N
`restrictionAdjective`	Restriction Adjective	Type of selection for `restrictionNoun`.	Valid values: As String = Every, As Value = 0 As String = 1st, As Value = 1 As String = 2nd, As Value = 2 As String = 3rd, As Value = 3 As String = 4th, As Value = 4 As String = Last, As Value = 5 As String = Nth, As Value = 6 Default is Every (0).	Y (if `restrictionComplex` is enabled)
`restrictionComplex`	Complex Restriction	Set only if `restriction` is true; Set of parameters that determine one or more situations when this trigger should not be satisfied. Used in conjunction with `restrictionMode`, `restrictionAdjective`, `restrictionNoun`, and `restrictionQualifier`. For example, you can specify that you do not want to satisfy this trigger on the last business day of the year or the first day of each month.	Boolean; Valid values: true/false. Default is false.	Y (if `restrictionSimple` is false)
`restrictionMode`	Restriction Mode	Set only if `restrictionSimple` is true; Specification for whether you want to use `restrictionSimple`- and/or `restrictionComplex`-related values.	Valid values: As String = And, As Value = 1 As String = Or, As Value = 2 Default is Or (2).	Y (if `restrictionSimple` and `restrictionComplex` are true)
`restrictionNoun`	Restriction Noun	Deprecated. Day to restrict the trigger to. To specify a Custom Day, use the name of the Custom Day. For example: XML <restrictionNoun>CustomDay1</restrictionNoun> JSON "restrictionNoun": { "value": "CustomDay1" } To specify a Local Custom Day, use the local attribute. For example: XML <restrictionNoun local="true">CustomDay2</restrictionNoun> JSON "restrictionNoun": { "local": "true", "value": "CustomDay2" } Note The Calendar for the trigger is used to verify Custom Day references.	Valid values: As String = Sunday, As Value = 1 As String = Monday, As Value = 2 As String = Tuesday, As Value = 3 As String = Wednesday, As Value = 4 As String = Thursday, As Value = 5 As String = Friday, As Value = 6 As String = Saturday, As Value = 7 As String = Day, As Value = 8 As String = Business Day, As Value = 9	Y (if `restrictionComplex` is true)
`restrictionNouns`	Restriction Noun(s)	Day to restrict the trigger to. Used with `restrictionAdjective`, `restrictionQualifiers`, and `restrictionNthAmount` (if `restrictionAdjective` is Nth) to specify the type of days you want to select. For example, to specify "the 1st business day of the month," select `restrictionAdjective` as 1st, `restrictionNouns` as Business Day, and `restrictionQualifiers` as Month. Example: <restrictionNouns> <restrictionNoun>Business Day</restrictionNoun> </restrictionNouns> To specify a Custom Day, use the name of the Custom Day. For example: XML <restrictionNouns> <restrictionNoun>Monday</restrictionNoun> <restrictionNoun>CustomDay1</restrictionNoun> </restrictionNouns> JSON "restrictionNouns": [ { "value": "Monday" }, { "value": "CustomDay1" } ] To specify a Local Custom Day, use the local attribute. For example: XML <restrictionNouns> <restrictionNoun local="true">CustomDay2</restrictionNoun> </restrictionNouns> JSON "restrictionNouns": [ { "local": true, "value": "CustomDay1" } ] Note The Calendar for the trigger is used to verify Custom Day references.	Valid values: As String = Sunday, As Value = 1 As String = Monday, As Value = 2 As String = Tuesday, As Value = 3 As String = Wednesday, As Value = 4 As String = Thursday, As Value = 5 As String = Friday, As Value = 6 As String = Saturday, As Value = 7 As String = Day, As Value = 8 As String = Business Day, As Value = 9 Custom Days specified in the calendar selected in a Workflow calendar.	Y (if `restrictionComplex` is true)
`restrictionNthAmount`	Restriction Nth Amount	Set only if `restrictionAdjective` is Nth (6); value of N.	Integer	Y (if `restrictionAdjective` is Nth)
`restrictionQualifier`	Restriction Qualifier	Deprecated. Period to restrict the trigger to. To specify a Custom Day Period, use the name of the Custom Day Period. For example: XML <restrictionQualifier>CustomDayPeriod1</restrictionQualifier> JSON "restrictionQualifier": { "value": "CustomDayPeriod1" } To specify a Local Custom Day Period, use the local attribute. For example: XML <restrictionQualifier local="true">CustomDayPeriod2</restrictionQualifier> JSON "restrictionQualifier": { "local": "true", "value": "CustomDayPeriod2" } Note The Calendar for the trigger is used to verify Custom Day references.	Valid values: As String = Jan, As Value = 0 As String = Feb, As Value = 1 As String = Mar, As Value = 2 As String = Apr, As Value = 3 As String = May, As Value = 4 As String = Jun, As Value = 5 As String = Jul, As Value = 6 As String = Aug, As Value = 7 As String = Sep, As Value = 8 As String = Oct, As Value = 9 As String = Nov, As Value = 10 As String = Dec, As Value = 11 As String = Month, As Value = 12 As String = Year, As Value = 13	Y (if `restrictionComplex` is true)
`restrictionQualifiers`	Restriction Qualifier(s)	Period to restrict the trigger to. Used with `restrictionAdjective`, `restrictionQualifiers`, and `restrictionNthAmount` (if `restrictionAdjective` is Nth) to specify the type of days you want to select. For example, to specify "the 1st business day of the month," select `restrictionAdjective` as 1st, `restrictionNouns` as Business Day, and `restrictionQualifiers` as Month. Example: <restrictionQualifiers> <restrictionQualifier>Month</restrictionQualifier> </restrictionQualifiers> To specify a Custom Day, use the name of the Custom Day. For example: XML <restrictionQualifiers> <restrictionQualifier>Jan</restrictionQualifier> <restrictionQualifier>CustomDay1</restrictionQualifier> </restrictionQualifiers> JSON "restrictionQualifiers": [ { "value": "Jan" }, { "value": "CustomDay1" } ] To specify a Local Custom Day, use the local attribute. For example: XML <restrictionQualifiers> <restrictionQualifier local="true">CustomDay2</restrictionQualifier> </restrictionQualifiers> JSON "restrictionQualifiers": [ { "local": true, "value": "CustomDay1" } ] Note The Calendar for the trigger is used to verify Custom Day references.	Valid values: As String = Jan, As Value = 0 As String = Feb, As Value = 1 As String = Mar, As Value = 2 As String = Apr, As Value = 3 As String = May, As Value = 4 As String = Jun, As Value = 5 As String = Jul, As Value = 6 As String = Aug, As Value = 7 As String = Sep, As Value = 8 As String = Oct, As Value = 9 As String = Nov, As Value = 10 As String = Dec, As Value = 11 As String = Month, As Value = 12 As String = Year, As Value = 13 As String = Week, As Value = 14 As String = Quarter, As Value = 15	Y (if `restrictionComplex` is true)
`restrictionSimple`	Simple Restriction	Set only if `restriction` is true; Specification to set a simple restriction based on a specific `situation`.	Boolean; Valid values: true/false. Default is false.	Y (if `restrictionComplex` is false)
`retainSysIds`	n/a	Specification for whether or not the web service will persist the sysId property. If retainSysIds="true" and `sysId` is included in the request/response, `sysId` will be persisted to the database. If retainSysIds="false" and `sysId` is included in the request/response, `sysId` will be ignored; it will be autogenerated by the Controller. Note In XML web services, `retainSysIds` is specified as an attribute in the <trigger> element.	Valid values: true/false (default is true).	N
`retentionDuration`	Retention Duration	Set only if `retentionDurationPurge` is selected; Minimum retention duration for the selected `retentionDurationUnit` before triggered task instances can qualify for purge.	Integer	N
`retentionDurationPurge`	Purge By Retention Duration	Specification for whether triggered task instances can be purged by retention duration.	Boolean; Valid values: true/false. Default is false.	N
`retentionDurationUnit`	Retention Duration Unit	Set only if `retentionDurationPurge` is selected; Retention duration unit.	Valid values: As String = Hours, As Value = 3 As String = Days, As Value = 4 Default is Days (4).	N
`simulateTasks`	Simulate	Specifies if the instances generated by this trigger should execute under simulation mode.	Boolean; Valid values: true/false. Default is false.	N
`simulationOption`	Simulate Forecast	For Cron, Temporary, and Time triggers only; Enables the override of the Enable Trigger Simulation Universal Controller system property specification for whether or not to simulate the launching of tasks when triggers are eligible to fire. (If `simulationOption` is enabled, only the scheduled launch of the task by the trigger is inhibited.)	Valid values: --System Default --, As Value = 0 As String = True, As Value = 1 As String = False, As Value = 2 Default is --System Default – (0).	N
`situation`	Situation	Type of day that causes the Controller to initiate the specified `action`.	Valid values: As String = Holiday, As Value = 1 As String = Non Business Day, As Value = 2 Default is Holiday (1).	Y (if `restrictionSimple` is true)
`skipActive`	Skip Trigger if Active	*Deprecated*. Indication for whether or not the Controller should skip the next run of the specified task(s) if the previous run has not gone to a Complete status (that is, it is still active).	Boolean; Valid values: true/false. Default is false.	N
`skipAfterDate`	Skip After Date	Date after which the trigger will be skipped.		N
`skipAfterTime`	Skip After Time	Time after which the trigger will be skipped.		N
`skipBeforeDate`	Skip Before Date	Date before which the trigger will be skipped.		N
`skipBeforeTime`	Skip Before Time	Time before which the trigger will be skipped.		N
`skipCondition`	Task Launch Skip Condition	Controls when launching a task for the trigger will be skipped. Note When reading a Trigger, both `skipActive` and `skipCondition` are returned. When creating/updating a Trigger, `skipCondition` is used if present. If `skipCondition` is not present, `skipActive` is used. If both `skipActive` and `skipCondition` are present, `skipActive` can be set to true only if `skipCondition` is Active (1).	Valid values: As String = None, As Value = 0 As String = Active, As Value = 1 As String = Active By Trigger, As Value = 2 Default is None (0).	N
`skipCount`	Skip Count	Specification that the Controller should skip the next N times that this task is triggered.	Integer; Default is 0.	N
`skipDateList`	Skip Date List	Date(s) on which the trigger will be skipped.
`skipRestriction`	Skip Restriction	Specification for when the trigger should skip and not launch the task(s).	Valid values: As String = None, As Value = 0 As String = Before, As Value = 1 As String = After, As Value = 2 As String = Span, As Value = 3 As String = On, As Value = 4 Default is None (0).
`sysId`	n/a	System ID field in the database for this trigger.	Persisted only if retainSysIds is set to true.	N
`taskMonitor`	Variable Monitor	Variable Monitor task being executed.		Y
`tasks`	Tasks	Name of the task(s) being triggered when this trigger is satisfied. XML JSON		Y
`timeZone`	Time Zone	Name of the time zone that will be applied to the time(s) specified in the trigger.		Y
`version`	n/a	For Read and List web services; specification of the version being read or listed. Note In XML web services, `version` is specified as an attribute in the <trigger> element.		Y

Trigger Properties: Variable Monitor Trigger

Property	UI Field Name	Description	Specifications	Required
`enabledEnd`	Enabled End	End time of the period during which the trigger should be active.	Use 24-hour time; format is hh:mm	Y (if `restrictedTimes` is true)
`enabledStart`	Enabled Start	Start time of the period during which the trigger should be active.	Use 24-hour time; format is hh:mm	Y (if `restrictedTimes` is true)
`restrictedTimes`	Restrict Times	Indication that the trigger is active only during the period specified by `enabledStart` and `enabledEnd`.	Boolean; Valid values: true/false. Default is false.	N

Trigger-Related Records Properties: Variables

Property	UI Field Name	Description	Required
`description`	Description	Description of the variable.	N
`name`	Name	Name of the variable.	Y
`value`	Value	Value of the variable.	Y

Trigger-Related Records Properties: Notes

Property	UI Field Name	Description	Required
`sysId`	n/a	System ID field in the database for the Note.	N
`text`	Text	Text of the Note.	N
`title`	Title	Title of the Note.	N

Browser not supported