/
Manual Trigger Web Services

Manual Trigger Web Services

Jan 30, 2024

Overview

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

 

Description

 

Description

URI

http://host_name/uc/resources/trigger

HTTP Method

POST

Description

Creates a new Manual Trigger.

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Manual Trigger: XML and JSON Examples.

Trigger Properties

Trigger-Related Record Properties

Example Response

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

Modify a Manual 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 Manual 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 Manual 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 Manual 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 Manual 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 Manual 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

Manual 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

<triggerManual exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_manual" retainSysIds="true" version="1"> <variables />
<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>test manual trigger</name>
<nextScheduleTime>2021-03-04 00:00:00 -0500</nextScheduleTime>
<opswiseGroups> <opswiseGroup>bus service 1</opswiseGroup> </opswiseGroups>
<rdExcludeBackup>true</rdExcludeBackup>
<retentionDuration>1</retentionDuration>
<retentionDurationPurge>true</retentionDurationPurge>
<retentionDurationUnit>Days</retentionDurationUnit>
<sysId>0fc6b7d9c0a801c9017b6c27c259937e</sysId>
<tasks>
<task>Sleep 30</task>
</tasks>
</triggerManual>

{ "type": "triggerManual", "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_fm",
"name": "test manual trigger",
"nextScheduledTime": "2021-03-04 00:00:00 -0500",
"notes": [],
"opswiseGroups": [ "bus service 1" ],
"rdExcludeBackup": true,
"retainSysIds": true,
"retentionDuration": 1,
"retentionDurationPurge": true,
"retentionDurationUnit": "Days",
"sysId": "0fc6b7d9c0a801c9017b6c27c259937e",
"tasks": [ "Sleep 30" ],
"variables": [ ],
"versionversion": 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

UI Field Name

Description

Specifications

Required

Property

UI Field Name

Description

Specifications

Required

action

Action

For all trigger types except Manual and Temporary; Action to take on a non-business day or holiday (see situation).

Valid values:

  • As String = Do Not Trigger, As Value = 1

  • As String = Next Day, As Value = 2

  • As String = Next Business Day, As Value = 3

  • As String = Previous Day, As Value = 4

  • As String = Previous Business Day, As Value = 5

Default is Do Not Trigger (1).
 

Note

The following values are valid only for Cron and Time triggers:

  • Next Day (2)

  • Next Business Day (3)

  • Previous Day (4)

  • Previous Business Day (5)

Y
(if restriction
is true.)

calendar

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.
 
The Calendar will be used to verify any Custom Day references in restrictionNoun.

Default is System Default.

Y

customField1

n/a

User-Defined field.
 
Example: <customField1 label="Domain">web.com</customField1>

The label is included only if a value has been defined for the User Defined Trigger Field 1 Label Universal Controller system property.

N

customField2

n/a

User-Defined field.
 
Example: <customField2 label="Domain">web.com</customField2>

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

Description of this trigger.

 

N

disabledBy

Disabled By

System-supplied. If Status = Enabled, ID of the user who most recently disabled this trigger.

Read-only.

N

disabledTime

Disabled Time

System-supplied. If Status = Enabled, Date and time that the trigger was disabled.

Read-only.

N

enabled

Status

System-defined; Specification for whether or nor the trigger is enabled. Only enabled triggers are processed by the Controller.

Read-only.

N

enabledBy

Enabled By

System-supplied. If Status = Enabled, ID of the user who most recently enabled this trigger.

Read-only.

N

enabledTime

Enabled Time

System-supplied. If Status = Enabled, Date and time that the trigger was enabled.

Read-only.