...
Examples | XML | JSON | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Example for Trigger |
| |||||||||||||||||||||
Examples for Trigger-Related Records | Variables
Notes
| Variables
Notes
|
...
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 | Valid values:
Default is Do Not Trigger (1). Anchor |
| Y |
| Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | Default is System Default. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customField1 | n/a | User-Defined field. | 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. | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
| Valid values: true/false (default is false). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from.
| read only | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exportTable | n/a | Record table information.
| 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Anchor |
| N |
| N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rdExcludeBackup | Exclude Backup | Set only if | 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 | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictionAdjective | Restriction Adjective | Type of selection for | Valid values: Default is Every (0). | Y | Anchor | restrictionComplex - All | restrictionComplex
Default is Every (0). | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictionComplex | Complex Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictionMode | Restriction Mode | Set only if | Valid values:
Default is Or (2). | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictionNoun | Restriction Noun | Deprecated. Day to restrict the trigger to.
| Valid values:
| Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictionNthAmount restrictionNouns | Restriction Nth Amount | Set only if | Integer | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | restrictionQualifier - All | restrictionQualifier - All | Restriction Qualifier | Period Noun(s) | Y (if Day to restrict the trigger to.
| Valid values:
| Used with Example:
To specify a Custom Day, use the name of the Custom Day. For example: XML
JSON
To specify a Local Custom Day, use the local attribute. For example: XML
JSON
| Valid values:
| Y (if restrictionComplex is true) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictionSimple restrictionNthAmount | Simple Restriction Nth Amount | Set only if | Integer | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | situation - All | situation - All | Situation | Type of day that causes the Controller to initiate the specified | Valid values: Default is Holiday (1). | Y (if restrictionSimple
retainSysIds | n/a | Specification for whether or not the web service will persist the sysId property.
| Valid values: true/false (default is true). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | retentionDuration - All | retentionDuration - All | Retention Duration | Set only if | Integer | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | retentionDurationPurge - All | retentionDurationPurge - All | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | retentionDurationUnit - All | retentionDurationUnit - All | Retention Duration Unit | Set only if | Valid values: Default is Days (4). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | simulationOption - All | simulationOption - All | 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 | Valid values: Default is --System Default – (0). | N |
| Restriction Qualifier | Deprecated. Period to restrict the trigger to.
| Valid values:
| Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | skipAfterDate - All | skipAfterDate - All | Skip After Date | Date after which the trigger will be skipped. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | skipAfterTime - All | skipAfterTime - All | Skip After Time | Time after which the trigger will be skipped. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | skipBeforeDate - All | skipBeforeDate - All | Skip Before Date | Date before which the trigger will be skipped. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | skipBeforeTime - All | skipBeforeTime - All | Skip Before Time | Time before which the trigger will be skipped. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | skipCondition - All | skipCondition - All | Task Launch Skip Condition | Controls when launching a task for the trigger will be skipped. Note |
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).
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 |
| Restriction Qualifier(s) | Period to restrict the trigger to. Used with Example:
To specify a Custom Day, use the name of the Custom Day. For example: XML
JSON
To specify a Local Custom Day, use the local attribute. For example: XML
JSON
| Valid values:
Default is None (0). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | skipCount - All | skipCount - All | Skip Count | Specification that the Controller should skip the next N times that this task is triggered. | Integer; Default is 0. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | skipDateList - All | skipDateList - All | Skip Date List | Date(s) on which the trigger will be skipped. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | skipRestriction - All | skipRestriction - All | Skip Restriction | Specification for when the trigger should skip and not launch the task(s). | Valid values:
Default is None (0). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | sysId - All | sysId - All | n/a | System ID field in the database for this trigger. | Persisted only if retainSysIds is set to true. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | tasks - All | tasks - All | Tasks | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | timeZone - All | timeZone - All | Time Zone | Name of the time zone that will be applied to the time(s) specified in the trigger. | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | version - All | version - All | n/a | For Read and List web services; specification of the version being read or listed.
| Y (if restrictionComplex is true) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictionSimple | Simple Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retainSysIds | n/a | Specification for whether or not the web service will persist the sysId property.
| YValid values: true/false (default is true). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
...
|
...
|
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Day Logic
...
Specification for whether to And the dayOfMonth with the dayOfWeek criteria or to Or the dayOfMonth with the dayOfWeek criteria.
...
Valid values: And, Or.
...
Y
...
Day of Month
...
Day of the month, using standard Cron syntax.
...
Valid values: 1-31. Default is *.
...
Y
...
Day of Week
...
Day of the week, using standard Cron syntax.
...
Valid values: 0-7. Default is *.
...
Y
...
Hours
...
Time in hours, using standard Cron syntax. (See also Daylight Saving Time.)
...
Valid values: 0-23. Default is *.
...
Y
...
Minutes
...
Time in minutes, using standard Cron syntax.
...
Valid values: 0-59. Default is 0.
...
Y
...
Month
...
Month, using standard Cron syntax.
...
Valid values: 1-12. Default is *.
...
Y
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Description
...
Description of the variable.
...
N
...
Name
...
Name of the variable.
...
Y
...
Value
...
Value of the variable.
...
Y
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
n/a
...
System ID field in the database for the Note.
...
N
...
Text
...
Text of the Note.
...
N
...
Title
...
Title of the Note.
...
N
...
Description
...
URI
...
HTTP Method
...
GET
...
Description
...
Lists Cron trigger qualifying times from a specific starting date.
...
URI Parameters
...
See List Trigger Qualifying Times: URI Parameters, below.
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/xml, application/json
...
Example URI
...
- http://localhost:8080/uc/resources/trigger/qualifyingtimes?triggername=testTrigger
- http://localhost:8080/uc/resources/trigger/qualifyingtimes?triggername=testTrigger&count=20&startdate=2017-08-01
...
Authentication
...
HTTP Basic
...
See List Trigger Qualifying Times: XML and JSON Examples.
...
Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
triggerid
...
Unique ID for a trigger.
...
Y
(unless triggername
is specified)
...
triggername
...
triggername
...
Name used within the Controller to identify a trigger.
...
Maximum 40 alphanumerics.
...
Y
(unless triggerid
is specified)
...
triggerid
...
count
...
Number of qualifying days to list.
...
Maximum is 1000; default is 30.
...
N
...
startdate
...
Starting date of qualifying days to list.
...
Format: YYYY-MM-DD. Default is current date.
...
N
...
XML | JSON | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Expand |
Panel | Expand |
retentionDuration | Retention Duration | Set only if | 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 | Valid values:
Default is Days (4). | N | ||||||||||||||
simulationOption | 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 | Valid values:
Default is --System Default – (0). | N | ||||||||||||||
situation | Situation | Type of day that causes the Controller to initiate the specified | Valid values:
Default is Holiday (1). | Y | ||||||||||||||
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.
| Valid values:
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:
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 | ||||||||||||||
tasks | Tasks | Name of the task(s) being triggered when this trigger is satisfied.
| 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.
| Y |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
dayLogic | Day Logic | Specification for whether to And the dayOfMonth with the dayOfWeek criteria or to Or the dayOfMonth with the dayOfWeek criteria. | Valid values: And, Or. | Y | ||||||
dayOfMonth | Day of Month | Day of the month, using standard Cron syntax. | Valid values: 1-31. Default is *. | Y | ||||||
dayOfWeek | Day of Week | Day of the week, using standard Cron syntax. | Valid values: 0-7. Default is *. | Y | ||||||
hours | Hours | Time in hours, using standard Cron syntax. (See also Daylight Saving Time.) | Valid values: 0-23. Default is *. | Y | ||||||
minutes | Minutes | Time in minutes, using standard Cron syntax. | Valid values: 0-59. Default is 0. | Y | ||||||
month | Month | Month, using standard Cron syntax. | Valid values: 1-12. Default is *. | Y |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
description | Description | Description of the variable. | N | |||||||
name | Name | Name of the variable. | Y | |||||||
value | Value | Value of the variable. | Y |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | 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 |
Anchor | ||||
---|---|---|---|---|
|
Description | |||||||
---|---|---|---|---|---|---|---|
URI | http://host_name/uc/resources/trigger/qualifyingtimes | ||||||
HTTP Method | GET | ||||||
Description | Lists Cron trigger qualifying times from a specific starting date. | ||||||
URI Parameters | See List Trigger Qualifying Times: URI Parameters, below. | ||||||
Consumes Content-Type | n/a | ||||||
Produces Content-Type | application/xml, application/json | ||||||
Example URI | |||||||
Authentication | HTTP Basic | ||||||
|
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for a trigger. | Y |
| |
| Name used within the Controller to identify a trigger. | Maximum 40 alphanumerics. | Y |
|
| Number of qualifying days to list. | Maximum is 1000; default is 30. | N | |
| Starting date of qualifying days to list. | Format: YYYY-MM-DD. Default is current date. | N |
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|