URI

HTTP Method

POST

Description

Retrieves information for the specified trigger.

Example URI

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

See Composite Trigger: XML and JSON Examples.

Trigger Properties

• See Trigger Properties: All Triggers.
• See Trigger Properties: Composite Trigger.

Trigger Component Properties

• See Trigger Properties: All Composite Trigger Components.
• See Trigger Properties: Composite Trigger Time Component.
• See Trigger Properties: Composite Trigger File Monitor Component.
• See Trigger Properties: Composite Trigger Task Monitor Component.
• See Trigger Properties: Composite Trigger Variable Monitor Component.
• See Trigger Properties: Composite Trigger Email Monitor Component.
• See Trigger Properties: Composite Trigger Universal Monitor Component.

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 Example Request.
 
To modify Composite Trigger properties without modifying related records, use the excludeRelated property.

Example URI

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

See Composite Trigger: XML and JSON Examples.

Trigger Properties

• See Trigger Properties: All Triggers.
• See Trigger Properties: Composite Trigger.

Trigger Component Properties

• See Trigger Properties: All Composite Trigger Components.
• See Trigger Properties: Composite Trigger Time Component.
• See Trigger Properties: Composite Trigger File Monitor Component.
• See Trigger Properties: Composite Trigger Task Monitor Component.
• See Trigger Properties: Composite Trigger Variable Monitor Component.
• See Trigger Properties: Composite Trigger Email Monitor Component.
• See Trigger Properties: Composite Trigger Universal Monitor Component.

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 a Composite Trigger: URI Parameters.

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: Composite Trigger.

Trigger Component Properties

• See Trigger Properties: All Composite Trigger Components.
• See Trigger Properties: Composite Trigger Time Component.
• See Trigger Properties: Composite Trigger File Monitor Component.
• See Trigger Properties: Composite Trigger Task Monitor Component.
• See Trigger Properties: Composite Trigger Variable Monitor Component.
• See Trigger Properties: Composite Trigger Email Monitor Component.
• See Trigger Properties: Composite Trigger Universal Monitor Component.

Trigger-Related Record Properties

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

Example Response

• Status 200 /OK
  (See Composite 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

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)

Queue Depth

Number of events that are maintained in the queue for each component at any time. To maintain queueDepth, the Controller discards the oldest events.

Integer; Valid values: 1-100. Default is 100.

N

Restrict Times

Indication that the trigger is active only during the period specified by enabledStart and enabledEnd.

Boolean; Valid values: true/false.

N

Time Limit

Amount of time (in timeLimitUnits) that component events will remain in their queue before being removed.

Integer

N

Time Limit Unit

Unit of time specified in the timeLimit.

N

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)

Description

Description of this component.

N

Enabled End

End time of the period during which the component 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 component should be active.

Use 24-hour time; format is hh:mm

Y
(if restrictedTimes
is true)

Name

Name used within the Controller to identify this component.

Maximum 255 alphanumerics.

Y

Restrict Times

Indication that the trigger is active only during the period specified by enabledStart and enabledEnd.

Boolean; Valid values: true/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

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)

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
• As String = Week, As Value = 14

Y
(if restrictionComplex
is true)

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)

Situation

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

Y
(if restrictionSimple
is true)

Built-in Variable Prefix

Prefix that enables built-in variables to be propagated up to the Composite trigger.

N

Adjust Interval To Enable Start

Set only if restrictedTimes is true; Specification for whether to always begin at the enabledStart (true) or based upon the actual interval (false).

Boolean; Valid values: true/false. Default is true.

N

Adjustment Amount

Set only if dayStyle is Complex; Number of Days or Business Days to adjust your date setting.

Integer.

Y
(if dateAdjustment
is less (1)
or plus (2) )

Adjustment Type

Set only if dayStyle is Complex; Type of day by which to adjust your date setting.

Y
(if dateAdjustment
is less (1)
or plus (2) )

Date Adjective

If dayStyle is Complex; Which in a series of days to select. Used in conjunction with dateNouns and dateQualifiers.

For example, to specify the 2nd to last day of the month (last day of the month less one day), select dateAdjective = Last, dateNouns = Day, dateQualifiers = Month, dateAdjustment = Less, adjustmentAmount = 1, and adjustmentType = Day.

Y
(if dayStyle
is Complex)

Date Adjustment

If dayStyle is Complex; Specification for adjusting your date setting by a less or plus number of Days or Business Days.

For example, to specify the 2nd to last day of the month (last day of the month less one day), select dateAdjective = Last, dateNouns = Day, dateQualifiers = Month, dateAdjustment = Less, adjustmentAmount = 1, and adjustmentType = Day.

N

Date Noun

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 dayStyle
is Complex)

Date 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
• As String = Week, As Value = 14

Y
(if dayStyle
is Complex)

Day Interval

Interval (number of days) at which this trigger will run.

Integer.

Y
(if dayStyle \
is Every)

Day Style

Indication of when this trigger will be run.

Y

Event Match Type

Controls whether events from the Time component will be used for a single match or multiple matches at the Composite trigger level.

N

Friday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Friday.

Boolean; Valid values: true/false. Default is false.

N

Interval Start

First day of the interval on which this trigger will run.

Format: yyyy-mm-dd

Y
(if dayStyle
is Every)

Monday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Monday.

Boolean; Valid values: true/false. Default is false.

N

Nth Amount

Value of N.

Integer

Y
(if dateAdjective
is Nth)

Saturday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Saturday.

Boolean; Valid values: true/false. Default is false.

N

n/a

Indication of when this trigger will be run.

Y
(if dayStyle
is Simple)

Initial Time Offset

Set only if timeStyle is Interval; Starting time, in minutes offset from the hour.

Format is hh:mm

Y
(if startTimeEnable
is true)

Enable Offset

Set only if timeStyle is Interval; Indication of whether you want to specify (in startingAt) a starting time, in minutes offset from the hour, for the trigger to run.

Boolean; Valid values: true/false. Default is false.

N

Sunday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Sunday.

Boolean; Valid values: true/false. Default is false.

N

Thursday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Thursday.

Boolean; Valid values: true/false. Default is false.

N

Time

Time when the trigger will be run.

Format is hh:mm, using 24-hour time.

Y
(if timeStyle
is Absolute)

Time Interval

Number of timeIntervalUnits.

Integer

Y
(if timeStyle
is Interval)

Time Interval Units

Type of time interval.

Y
(if timeStyle
is Interval)

Time Style

Indicates whether this trigger is for a specific time or a series of times.

N

Tuesday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Tuesday.

Boolean; Valid values: true/false. Default is false.

N

Wednesday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Wednesday.

Boolean; Valid values: true/false. Default is false.

N

File Monitor

Name of the File Monitor task to be triggered.

Y

Name

Name of the Task Monitor task to be triggered.

Y

Name

Name of the Variable Monitor task to be triggered.

Y

Name

Name of the Email Monitor task to be triggered.

Y

Name

Name of the Universal Monitor task to be triggered.

Y

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