Composite Trigger Web Services
Overview
Universal Controller supports the following RESTful-based web services for Composite 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 Composite Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger |
HTTP Method | POST |
Description | Retrieves information for the specified 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 Component Properties |
|
Trigger-Related Record Properties | |
Example Response |
|
Modify a Composite Trigger
Read a Composite 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 Component Properties |
|
Trigger-Related Record Properties | |
Example Response |
|
Read a Composite 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 |
|
Composite 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 | ||
Example for Trigger-Related Records | ||
Example for Composite Trigger Components | ||
Examples for Trigger-Related Records | Variables Notes | Variables Notes |
Properties
Trigger Properties - All Triggers
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. |