Composite Trigger Web Services

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

Modify a Composite Trigger



Description



Description

URI

http://host_name/uc/resources/trigger

HTTP Method

PUT

Description

Modifies the trigger specified by the sysId in the Example Request.
 
To modify Composite 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 Composite Trigger: XML and JSON Examples.

Trigger Properties

Trigger Component Properties

Trigger-Related Record Properties

Example Response

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

Read a Composite Trigger

Read a Composite 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

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

Examples

XML

JSON

Example for Trigger

<triggerComposite exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_composite" retainSysIds="true" version="1">
<variables />
<action>Do Not Trigger</action>
<notes />
<calendar>System Default</calendar>
<description />
<disabledBy />
<disabledTime />
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledEnd>00:00</enabledEnd>
<enabledStart>05:00</enabledStart>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>test composite trigger</name>
<nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
<opswiseGroups />
<queueDepth>100</queueDepth
<rdExcludeBackup>true</rdExcludeBackup
<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>
<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>
<timeLimit />
<timeLimitUnits>Minutes</timeLimitUnits>
<timeZone />
</triggerComposite>

{
"type": "triggerEm",
"action": "Do Not Trigger",
"calendar": "System Default",
"description": null,
"disabledBy": "",
"disabledTime": "",
"enabled": true,
"enabledBy": "ops.admin",
"enabledEnd": "00:00",
"enabledStart": "00:00",
"enabledTime": "2021-03-03 12:46:11 -0500",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_trigger_composite",
"name": "test composite trigger",
"nextScheduledTime": "2021-03-04 00:00:00 -0500",
"notes": [ ],
"opswiseGroups": [ ],
"queueDepth": 100,
"rdExcludeBackup": true,
"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",
"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" ], "timeLimit": null, "timeLimitUnits": "Minutes", "timeZone": null, "variables": [ ], "version": 1 }