URI

HTTP Method

POST

Description

Creates a new Email Monitor Trigger.

Example URI

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Email Monitor Trigger: XML and JSON Examples.

Trigger Properties

• See Trigger Properties: All Triggers.
• See Trigger Properties: Email 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.

URI

HTTP Method

PUT

Description

Modifies the trigger specified by the sysId in the request.
 
To modify Email Monitor Trigger properties without modifying related records, use the excludeRelated property.

Example URI

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Email Monitor Trigger: XML and JSON Examples.

Trigger Properties

• See Trigger Properties: All Triggers.
• See Trigger Properties: Email 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>.

URI

HTTP Method

GET

Description

Retrieves information for the specified trigger

URI Parameters

See Read an Email 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: Email Monitor Trigger.

Trigger-Related Record Properties

• See Trigger-Related Records Properties: Variables.
• See Trigger-Related Records Properties: Notes.

Example Response

• Status 200 /OK
  (See Email Monitor Trigger: XML and JSON Examples.)
• Status 404 /Not Found
  A trigger with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

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

Example for Trigger

Action

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

Y
(if restriction
is true)

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

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

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 of this trigger.

N

System-defined; Specification for whether or nor the trigger is enabled. Only enabled triggers are processed by the Controller.

n/a

Valid values: true/false Default is false.

N

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

Specifies whether or not to prevent editing variables when using Trigger Now... from the User Interface. Not applicable for Web Service APIs.

Name

Name used within the Controller to identify this trigger.

Maximum 255 alphanumerics.

Y

System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information.

Member of Business Services

N

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

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

Restriction Adjective

Type of selection for restrictionNoun.

Y
(if restrictionComplex
is enabled)

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)

Restriction Mode

Set only if restrictionSimple is true; Specification for whether you want to use restrictionSimple- and/or restrictionComplex-related values.

Y
(if restrictionSimple
and restrictionComplex
are true)

Restriction Noun

<restrictionQualifiers>
  <restrictionQualifier>Month</restrictionQualifier>
</restrictionQualifiers>

<restrictionQualifiers>
  <restrictionQualifier>Jan</restrictionQualifier>
  <restrictionQualifier>CustomDay1</restrictionQualifier>
</restrictionQualifiers>

"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"
  }
]

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>
  <restrictionNoun>Business Day</restrictionNoun>
</restrictionNouns>

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"
  }
]

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.

Restriction Nth Amount

Set only if restrictionAdjective is Nth (6); value of N.

Integer

Y
(if restrictionAdjective
is Nth)

Restriction Qualifier

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>
  <restrictionQualifier>Month</restrictionQualifier>
</restrictionQualifiers>

<restrictionQualifiers>
  <restrictionQualifier>Jan</restrictionQualifier>
  <restrictionQualifier>CustomDay1</restrictionQualifier>
</restrictionQualifiers>

"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"
  }
]

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

n/a

Valid values: true/false (default is true).

N

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

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

Retention Duration Unit

Set only if retentionDurationPurge is selected; Retention duration unit.

N

Simulate

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.)

N

Situation

Type of day that causes the Controller to initiate the specified action.

Y
(if restrictionSimple
is true)

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

Task Launch Skip Condition

N

Skip Count

Specification that the Controller should skip the next N times that this task is triggered.

Integer; Default is 0.

N

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).

n/a

System ID field in the database for this trigger.

Persisted only if retainSysIds is set to true.

N

Tasks

Y

Time Zone

Name of the time zone that will be applied to the time(s) specified in the trigger.

Y

n/a

Y

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)

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)

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

Description

Description of the variable.

N

Name

Name of the variable.

Y

Value

Value of the variable.

Y

n/a

System ID field in the database for the Note.

N

Text

Text of the Note.

N

Title

Title of the Note.

N