Time Trigger Web Services
Overview
Universal Controller supports the following RESTful-based web services for Time 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 Time Trigger
| Description |
|---|---|
URI | |
HTTP Method | POST |
Description | Creates a new Time trigger. |
Example URI | |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | |
Trigger Properties | |
Trigger-Related Record Properties | |
Example Response |
|
Modify a Time Trigger
| Description |
|---|---|
URI | |
HTTP Method | PUT |
Description | Modifies the trigger specified by the sysId in the request. |
Example URI | |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | |
Trigger Properties | |
Trigger-Related Record Properties | |
Example Response |
|
Read a Time Trigger
| Description |
|---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information for the specified trigger |
URI Parameters | See Read a Time 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 |
|
Read a Time 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 |
|
Time 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.