/
Application Monitor Trigger Web Services

Application Monitor Trigger Web Services

Jan 30, 2024

Overview

Universal Controller supports the following RESTful-based web services for Application Monitor 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 an Application Monitor Trigger



Description



Description

URI

http://host_name/uc/resources/trigger

HTTP Method

POST

Description

Creates a new Application Monitor trigger.

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Application Monitor Trigger: XML and JSON Examples.

Trigger Properties

Trigger-Related Record Properties

Example Response

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

Modify an Application Monitor 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 Application Monitor 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 Application Monitor 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 an Application Monitor Trigger



Description



Description

URI

http://host_name/uc/resources/trigger

HTTP Method

GET

Description

Retrieves information for the specified trigger

URI Parameters

See Read an Application Monitor 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 an Application Monitor 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

Application 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

Examples

XML

JSON

Example for Trigger

<triggerApplMonitor exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_appl_monitor" retainSysIds="true" version="1">
<variables />
<action />
<notes />
<calendar>System Default</calendar>
<description />
<disabledBy></disabledBy>
<disabledTime></disabledTime>
<enabled>true</enabled>
<enabledBy>ops.admin</enabledBy>
<enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
<name>application monitor trigger</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime>
<opswiseGroups>
<opswiseGroup>bus service 1</opswiseGroup>
</opswiseGroups>
<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>
<simulationOption /> <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 />
<applNameCondition>All</applNameCondition>
<applNameValue />
<applType>Windows Service,Linux/Unix Daemon,z/OS Started Task</applType>
<application>app1</application>
<monitorType>Specific</monitorType>
<status>Start Failure</status>
</triggerApplMonitor>

{
"type": "triggerApplMonitor",
"action": "Do Not Trigger",
"applNameCondition": "All",
"applNameValue": null,
"applType": "Windows Service,\nLinux/Unix Daemon,\nz/OS Started Task",
"application": "app1",
"calendar": "System Default",
"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_appl_monitor",
"monitorType": "Specific",
"name": "application monitor trigger",
"nextScheduledTime": "2021-03-04 00:00:00 -0500",
"notes": [],
"opswiseGroups": [ "bus service 1" ],
"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",
"skipCondition": "None",
"skipCount": 0,
"status": "Start Failure",
"sysId": "8140b211960d45328bbf96325a6c46bd",
"tasks": [ "Sleep 30" ],
"timeZone": null,
"variables": [ ],
"version": 2
}

Examples for Trigger-Related Records

Variables

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

Notes

<notes> <note> <sysId>76ad570c64b84f84aeaf281403856b10</sysId> <text>testNoteText</text> <title>testNoteTitle</title> </note> </notes>

Variables

"variables": [ { "description": "description", "name": "var1", "value": "value1" } ]

Notes

"notes": [ { "sysId": "76ad570c64b84f84aeaf281403856b10", "text": "testNoteText", "title": "testNoteTitle" } ]

Properties

Trigger Properties: All Triggers



Property

Property