Panel | |
---|---|
|
Overview
Universal Controller supports the following RESTful-based web services for File Monitor Trigger operations, which are listed alphabetically on this page.
- Create an Agent File Monitor Trigger
- Modify an Agent File Monitor Trigger
- Read an Agent File 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: |
Anchor | ||||
---|---|---|---|---|
|
Create an Agent File Monitor Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger |
HTTP Method | POST |
Description | Creates a new Agent File Monitor 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 |
|
Anchor | ||||
---|---|---|---|---|
|
Modify an Agent File Monitor 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 |
|
Anchor | ||||
---|---|---|---|---|
|
Read an Agent File Monitor Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger |
HTTP Method | GET |
Description | Retrieves information for the specified trigger |
URI Parameters | See Read an Agent File Monitor Trigger: URI Parameters, below. |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Trigger Properties | |
Trigger-Related Record Properties | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Read an Agent File Monitor 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 |
|
Anchor | ||||
---|---|---|---|---|
|
Agent File 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 |
| |||||||||||||||||||||
Examples for Trigger-Related Records | Variables
Notes
| Variables
Notes
|
Anchor | ||||
---|---|---|---|---|
|
Properties
Anchor | ||||
---|---|---|---|---|
|
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 | Valid values:
Default is Do Not Trigger (1).
| 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 | ||||||||||||||||||||||||||||||||||||||||||||||
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.
| 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 | ||||||||||||||||||||||||||||||||||||||||||||||
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.
| 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 | ||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionNouns | Restriction Noun(s) | Day 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:
| Y (if restrictionComplex is true) | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionNthAmount | Restriction Nth Amount | Set only if | Integer | Y | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionQualifier | Restriction Qualifier | Deprecated. Period to restrict the trigger to.
| Valid values:
| Y | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionQualifiers | 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:
| |||||||||||||||||||||||||||||||||||||||||||||||
retainSysIds | n/a | Specification for whether or not the web service will persist the sysId property.
| Valid values: true/false (default is true). | N | ||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||
---|---|---|---|---|
|
Trigger Properties: Agent File 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 | ||||||
enabledStart | Enabled Start | Start time of the period during which the trigger should be active. | Use 24-hour time; format is hh:mm | Y | ||||||
restrictedTimes | Restrict Times | Indication that the trigger is active only during the period specified by | Boolean; Valid values: true/false. Default is false. | N | ||||||
taskMonitor | File Monitor | Agent File Monitor task being executed. | Y |
Anchor | ||||
---|---|---|---|---|
|
Trigger-Related Records Properties: Variables
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 | ||||
---|---|---|---|---|
|
Trigger-Related Records Properties: Notes
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 |