Cron Trigger Web Services
Overview
Universal Controller supports the following RESTful-based web services for Cron 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 Cron Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger |
HTTP Method | POST |
Description | Creates a new Cron trigger. |
Example URI | http://localhost:8080/uc/resources/trigger |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | |
Trigger Properties | |
Trigger-Related Record Properties | |
Example Response |
|
Modify a Cron Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger |
HTTP Method | PUT |
Description | Modifies the trigger specified by the sysId in the request. |
Example URI | http://localhost:8080/uc/resources/trigger |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | |
Trigger Properties | |
Trigger-Related Record Properties | |
Example Response |
|
Read a Cron Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger |
HTTP Method | GET |
Description | Retrieves information for the specified trigger |
URI Parameters | |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Trigger Properties | |
Trigger-Related Record Properties | |
Example Response |
|
Read a Cron Trigger: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this trigger. | Y |
| |
| Name used within the Controller to identify this trigger. | Maximum 40 alphanumerics. | Y |
|
Cron 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 | ||
Examples for Trigger-Related Records | Variables Notes | Variables Notes |
Properties
Trigger Properties: All Triggers
Note
In the XML web services, the exportReleaseLevel and exportTable properties are specified as attributes in the <trigger> element.
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| 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). Note The following values are valid only for Cron and Time triggers:
| Y |
| 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 |
| 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 |
| 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 of this trigger. | N | |
| Disabled By | System-supplied. If Status = Enabled, ID of the user who most recently disabled this trigger. | Read-only. | N |
| Disabled Time | System-supplied. If Status = Enabled, Date and time that the trigger was disabled. | Read-only. | N |
| Status | System-defined; Specification for whether or nor the trigger is enabled. Only enabled triggers are processed by the Controller. | Read-only. | N |
| Enabled By | System-supplied. If Status = Enabled, ID of the user who most recently enabled this trigger. | Read-only. | N |
| Enabled Time | System-supplied. If Status = Enabled, Date and time that the trigger was enabled. | Read-only. | N |
| 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, | Valid values: true/false (default is false). | N |
| n/a | Universal Controller release that the record was exported from. Note In XML web services, | read only | N |
| n/a | Record table information. Note In XML web services, | read only | 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 |
| Name | Name used within the Controller to identify this trigger. | Maximum 255 alphanumerics. | Y |
| 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 |
| Member of Business Services | N | ||
| Exclude Backup | Set only if | 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 | Boolean; Valid values: true/false. Default is false. | N |
| Restriction Adjective | Type of selection for | Valid values:
Default is Every (0). | Y |
| Complex Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y |
| Restriction Mode | Set only if | Valid values:
Default is Or (2). | Y |
| Restriction Noun | Deprecated. Day to restrict the trigger to. Note The Calendar for the trigger is used to verify Custom Day references. | Valid values:
| Y |
| Restriction Noun(s) | Day to restrict the trigger to. Used with 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:
| Y (if restrictionComplex is true) |
| Restriction Nth Amount | Set only if | Integer | Y |
| Restriction Qualifier | Deprecated. Period to restrict the trigger to. Note The Calendar for the trigger is used to verify Custom Day references. | Valid values:
| Y |
| Restriction Qualifier(s) | Period to restrict the trigger to. Used with 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:
| Y (if restrictionComplex is true) |
| Simple Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y |
| n/a | Specification for whether or not the web service will persist the sysId property.
Note In XML web services, | Valid values: true/false (default is true). | N |
| Retention Duration | Set only if | 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 | Valid values:
Default is Days (4). | 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 | Valid values:
Default is --System Default – (0). | N |
| Situation | Type of day that causes the Controller to initiate the specified | Valid values:
Default is Holiday (1). | Y |
| 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 |
| Skip After Date | Date after which the trigger will be skipped. | N | |
| Skip After Time | Time after which the trigger will be skipped. | N | |
| Skip Before Date | Date before which the trigger will be skipped. | N | |
| Skip Before Time | Time before which the trigger will be skipped. | N | |
| Task Launch Skip Condition | Controls when launching a task for the trigger will be skipped. Note When reading a Trigger, both | Valid values:
Default is None (0). | N |
| Skip Count | Specification that the Controller should skip the next N times that this task is triggered. | Integer; Default is 0. | N |
| Skip Date List | Date(s) on which the trigger will be skipped. | ||
| Skip Restriction | Specification for when the trigger should skip and not launch the task(s). | Valid values:
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 | Name of the task(s) being triggered when this trigger is satisfied.
| Y | |
| Time Zone | Name of the time zone that will be applied to the time(s) specified in the trigger. | Y | |
| n/a | For Read and List web services; specification of the version being read or listed. Note In XML web services, | Y |
Trigger Properties: Cron Trigger
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 |
Trigger-Related Records Properties: Variables
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 |
Trigger-Related Records Properties: Notes
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 |
List Trigger Qualifying Times
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 |
Example Response |
List Trigger Qualifying Times: URI Parameters
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 |
List Trigger Qualifying Times: XML and JSON Examples
XML | JSON |
---|---|