/
Cron Trigger Web Services

Cron Trigger Web Services

Jan 30, 2024

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

 

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

See Cron Trigger: XML and JSON Examples.

Trigger Properties

Trigger-Related Record Properties

Example Response

  • Status 200 /OK
    Successfully created the <trigger type> trigger.

Modify a Cron Trigger

 

Description

 

Description

URI

http://host_name/uc/resources/trigger

HTTP Method

PUT

Description

Modifies the trigger specified by the sysId in the request.
 
To modify Cron Trigger properties without modifying related records, use the excludeRelated property.

Example URI

http://localhost:8080/uc/resources/trigger

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Cron Trigger: XML and JSON Examples.

Trigger Properties

Trigger-Related Record Properties

Example Response

  • Status 200 /OK
    Successfully updated the <trigger type> trigger to version <version>.

Read a Cron Trigger

 

Description

 

Description

URI

http://host_name/uc/resources/trigger

HTTP Method

GET

Description

Retrieves information for the specified trigger

URI Parameters

See Read a Cron 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

Name

Description

Specifications

Required

Mutually Exclusive With

triggerid

Unique ID for this trigger.

 

Y
(unless triggername
is specified)

triggername

triggername

Name used within the Controller to identify this trigger.

Maximum 40 alphanumerics.

Y
(unless triggerid
is specified)

triggerid

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

Examples

XML

JSON

Example for Trigger

<triggerCron exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_cron" retainSysIds="true" version="1">
<variables />
<action>Do Not Trigger</action>
<notes />
<calendar>System Default</calendar>
<dayLogic>And</dayLogic>
<dayOfMonth>*</dayOfMonth>
<dayOfWeek>Mon-Fri</dayOfWeek>
<description />
<disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<forecast>false</forecast>
<hours>9-17</hours>
<minutes>0</minutes>
<month>*</month>
<name>Test- Every hour from Mon-Fri between 9am and 5pm</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime>
<opswiseGroups />
<rdExcludeBackup>true</rdExcludeBackup>
<restrictedTimes>false</restrictedTimes>
<restriction>false</restriction>
<restrictionAdjective>Every</restrictionAdjective>
<restrictionComplex>false</restrictionComplex>
<restrictionMode>Or</restrictionMode>
<restrictionNouns>
<restrictionNoun>Day</restrictionNoun>
</restrictionNouns>
<restrictionNthAmount />
<restrictionQualifiers>
<restrictionQualifier>Year</retsrictionQualifier>
</restrictionQualifiers>
<restrictionSimple>false</restrictionSimple>
<retentionDuration>1</retentionDuration>
<retentionDurationPurge>true</retentionDurationPurge>
<retentionDurationUnit>Days</retentionDurationUnit>
<simulationOption>-- System Default --</simulationOption>
<situation>Holiday</situation>
<skipAfterDate>2020-05-28</skipAfterDate>
<skipAfterTime>02:15</skipAfterTime>
<skipBeforeDate>2020-05-30</skipBeforeDate>
<skipBeforeTime>17:30</skipBeforeTime>
<skipCondition>None</skipCondition>
<skipCount>0</skipCount>
<skipDateList />
<skipRestriction>Span</skipRestriction>
<sysId>0fc6b7d9c0a801c9017b6c27c259937e</sysId>
<tasks> <task>Sleep 30</task> </tasks>
<timeZone />
</triggerCron>

{
"type": "triggerCron",
"action": "Do Not Trigger",
"calendar": "System Default",
"dayLogic": "And",
"dayOfMonth": "*",
"dayOfWeek": "Mon-Fri",
"description": null,
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledTime": "2021-03-03 12:46:11 -0500",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_trigger_cron",
"forecast: false,
"hours": "9-17",
"minutes": "0",
"month": "*",
"name": "Test- Every hour from Mon-Fri between 9am and 5pm",
"nextScheduledTime": "2021-03-04 00:00:00 -0500",
"notes": [],
"opswiseGroups": [ ],
"rdExcludeBackup": true,
"restrictedTimes": false,
"restriction": false,
"restrictionAdjective": "Every",
"restrictionComplex": false,
"restrictionMode": "Or",
"restrictionNouns": [
{
"value": "Day"
}
],
"restrictionNthAmount": null,
"restrictionQualifiers": [
{
"value": "Year"
}
],
"restrictionSimple": false,
"retainSysIds": true,
"retentionDuration": 1,
"retentionDurationPurge": true,
"retentionDurationUnit": "Days",
"simulationOption": "-- System Default --",
"situation": "Holiday",
"skipAfterDate": "2020-05-28",
"skipAfterTime": "02:15",
"skipBeforeDate": "2020-05-30",
"skipBeforeTime": "17:30",
"skipCondition": "None",
"skipCount": 0,
"skipDateList": [ ],
"skipRestriction": "Span",
"sysId": "9c659c9c2c72460c9a2057663257b0be",
"tasks": [ "Sleep 30" ],
"timeZone": null,
"variables": [ ],
"version": 1
}

Examples for Trigger-Related Records

Variables

<variables> <variable> <description /> <name>testVar</name> <value>value</value> </variable> </variables>