Page Comparison

...

The following web services are common to all Trigger types:

Trigger Web Services#Assign Assign an Execution User to a TriggerTrigger Web Services#Delete
Delete a Trigger
Trigger Web Services#EnableEnable/Disable a TriggerTrigger Web Services#List
List Triggers
Trigger Web Services#List List Triggers - Advanced
Trigger Task(s) (Trigger Now)
Trigger Web Services#Unassign Unassign an Execution User from a Trigger

Detailed information for each of these web services is provided on this page.

...

	Description
URI	http://host_name/uc/resources/trigger/assignexecutionuser
HTTP Method	POST
Description	Assigns an Execution User to the specified trigger.
URI Parameters	See Assign an Execution User to a Trigger: URI Parameters.
Authentication	HTTP Basic
Example URI	http://localhost:8080/uc/resources/trigger/assignexecutionuser?triggername=testTrigger http://localhost:8080/uc/resources/trigger/assignexecutionuser?triggerid=410d6c0bc0a801c901838d8ac43b3279
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Assign an Execution User to a Trigger: XML and JSON Request Examples.
Request Properties	See Assign an Execution User to a Trigger: Request Properties.
Example Response	Status 200 /OK Successfully assigned execution user "test" to trigger "testTrigger". Status 404 /Not Found Assign Execution User failed. You must provide an execution user.

...

Examples

XML

JSON

Request Example

Expand

title	XML

Panelcode

language

text

<executionUser>
      <username>test</username>
      <password>pass1</password>
</executionUser>

Expand

title	JSON

Panelcode

language	text

{
 "username": "test",
 "password": "pass1" 
}

Anchor
Assign an Execution User to a Trigger Request Properties
Assign an Execution User to a Trigger Request Properties
Assign an Execution User to a Trigger: Request Properties

...

	Description
URI	http://host_name/uc/resources/trigger
HTTP Method	DELETE
Description	Assigns an execution user to the specified trigger.
URI Parameters	See Delete a Trigger: URI Parameters.
Authentication	HTTP Basic
Example URI	http://localhost:8080/uc/resources/trigger?triggername=testTrigger http://localhost:8080/uc/resources/trigger?triggerid=d26265a2c4f345359d9b356f18a462c1
Example Response	Status 200 /OK Trigger deleted successfully. Status 404 /Not Found A trigger with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

...

Anchor
Enable/Disable a Trigger XML and JSON Examples
Enable/Disable a Trigger XML and JSON Examples
Enable/Disable a Trigger: XML and JSON Examples

Examples

XML

JSON

Request Example

Expand

title	XML

panel

Code Block

trigger /trigger

language

/trigger

trigger

text

<enable-disable-trigger>
    <trigger enable="true" name="uc - 1st and 15th"></trigger>
    <trigger enable="false" name="uc - 1st Sunday of Month"></trigger>
</enable-disable-trigger>

Expand

title	JSON

panel

Code Block

Response Example

language

Expand

title	XML

Panel Expand

title	JSON

Panel

text

  [{
     "enable": true,
     "name": "uc - 1st and 15th"
  },
  {
     "enable": false,
     "name": "uc - 1st Sunday of Month"
  }]

Response Example

Expand

title	XML

Code Block

language	text

<command-response>
    <type>Enable Disable Triggers</type>
    <success>true</success>
    <info>Successfully enabled trigger uc - 1st and 15th, Successfully disabled trigger uc - 1st Sunday of Month</info>
    <errors />
</command-response>

Expand

title	JSON

Code Block

language	text

{
    "type": Enable/Disable Triggers",
    "success": true,
    "info": "Successfully enabled trigger "uc - 1st and 15th"., Successfully disabled trigger "uc - 1st Sunday of Month".",
    "errors": ""
}

Anchor
Enable/Disable a Trigger Request Trigger Properties
Enable/Disable a Trigger Request Trigger Properties
Enable/Disable a Trigger: Request Trigger Properties

Property

UI Field Name

Description

Specifications

Required

Anchor

	trigger - EDT
	trigger - EDT

trigger

n/a

There are two attributes for this property:

enable: Indication of whether to enable or disable the trigger. Only enabled triggers are processed by the Controller. Boolean; Valid values: true/false.
name: Name used within the Controller to identify this trigger. Maximum of 255 alphanumerics.

For example: <trigger enable="false" name="uc - 1st Sunday of Month"></trigger>

Y

...

	Description
URI	http://host_name/uc/resources/trigger/list
HTTP Method	POST
Description	Lists triggers matching specific search criteria.
Example URI	http://localhost:8080/uc/resources/trigger/list
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See List Triggers: XML and JSON Examples.
Request Properties	See List Triggers: Request Properties.
Example Response	See List Triggers: XML and JSON Examples.

...

Examples

XML

JSON

Request Example

Expand

title	XML

<generic-query-filter>
    <name>*time*</name>
    <enabled>true</enabled>
    <type>Time</type>
    <tasks>Sleep 0, Sleep 60</tasks>
    <description>manual1</description>
</generic-query-filter>

Expand

title	JSON

{
  "name": "*time*",
  "enabled": true,
  "type": "Time",  
  "tasks": "Sleep 0, Sleep 60",
  "description": "manual1"
}

Response Example

Expand

title	XML

<triggers>
    <trigger>
        <enabled>true</enabled>
        <name>Example time trigger 1</name>
        <sysID>07e69e9ac0a830016f4e065eb8e4ffe0</sysID>
        <type>Time</type>
        <version>1</version>
    </trigger>
    <trigger>
        <enabled>true</enabled>
        <name>Example time trigger 2</name>
        <sysID>07e69051c0a8300135a540b2d5b07ade</sysID>
        <type>Time</type>
        <version>1</version>
    </trigger>
</triggers>

Expand

title	JSON

[ {
  "enabled": true,
  "name": "Example time trigger 1",
  "sysId": "68aca9ea398f4d17a7ca23eeaa1d4fa1",
  "type": "Time",
  "version": 5
}, {
  "enabled": true,
  "name": "Example time trigger 2",
  "sysId": "54c562ceb5e44aeca99f836b65fd86fb",
  "type": "Time",
  "version": 11
} ]

...

	Description
URI	http://host_name/uc/resources/trigger/listadv
HTTP Method	GET
Description	Retrieves trigger details using specific query parameters.
Example URI	http://localhost:8080/uc/resources/trigger/listadv http://localhost:8080/uc/resources/trigger/listadv?triggername=*&businessServices=A&type=&enabled=&tasks=task1,task2&description= http://localhost:8080/uc/resources/trigger/listadv?type=time
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
URI Properties	See List Triggers - Advanced: URI Properties.
Example Response	See List Triggers - Advanced: XML and JSON Examples.

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	businessServices- LT
	businessServices- LT

businessServices

Member of Business Services

Business Services that this trigger belongs to.

Anchor

	description - LT
	description - LT

description

Description

Filter the trigger list using the description.

/wiki/spaces/UC71x/pages/5215217 are supported.

N

Anchor

	enabled - LT
	enabled - LT

enabled

Status

Indication of whether to list enabled (true) or disabled (false) triggers.

Boolean; Valid values: true/false.

N

Anchor

	name - LT
	name - LT

name

Name

Name or partial name of one or more triggers.

/wiki/spaces/UC71x/pages/5215217 are supported.

N

Anchor

	tasks - LT
	tasks - LT

tasks

Task(s)

List Triggers that reference any one of the specified links.

Comma-separated Task names.

N

Anchor

	type - LT
	type - LT

type

n/a

Type of triggers to list.

Valid values:

As String = Cron, As Value = 1
As String = Time, As Value = 2
As String = File Trigger, As Value = 3
As String = Temporary, As Value = 4
As String = Task Monitor, As Value = 5
As String = Manual, As Value = 6
As String = Application Monitor, As Value = 8
As String = Composite, As Value = 9
As String = Variable Monitor, As Value = 10
As String = Email Monitor, As Value = 11

...

Examples

XML

JSON

Response Example

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<triggers>
    <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>*</dayOfWeek>
        <description>cron test</description>
        <disabledBy></disabledBy>
        <disabledTime></disabledTime>
        <enabled>false</enabled>
        <enabledBy>ops.admin</enabledBy>
        <enabledTime>2021-06-01 11:29:48 -0400</enabledTime>
        <forecast>false</forecast>
        <hours>1</hours>
        <minutes>0</minutes>
        <month>*</month>
        <name>cron-1</name>
        <nextScheduledTime></nextScheduledTime>
        <opswiseGroups>
            <opswiseGroup>A</opswiseGroup>
            <opswiseGroup>B</opswiseGroup>
        </opswiseGroups>
        <rdExcludeBackup>false</rdExcludeBackup>
        <restriction>false</restriction>
        <restrictionAdjective>Every</restrictionAdjective>
        <restrictionComplex>false</restrictionComplex>
        <restrictionMode>Or</restrictionMode>
        <restrictionNoun>Day</restrictionNoun>
        <restrictionNthAmount>5</restrictionNthAmount>
        <restrictionQualifier>Year</restrictionQualifier>
        <restrictionSimple>false</restrictionSimple>
        <retentionDuration>1</retentionDuration>
        <retentionDurationPurge>false</retentionDurationPurge>
        <retentionDurationUnit>Days</retentionDurationUnit>
        <simulationOption>-- System Default --</simulationOption>
        <situation>Holiday</situation>
        <skipActive>false</skipActive>
        <skipAfterDate />
        <skipAfterTime />
        <skipBeforeDate />
        <skipBeforeTime />
        <skipCondition>None</skipCondition>
        <skipCount>0</skipCount>
        <skipDateList/>
        <skipRestriction>None</skipRestriction>
        <sysId>e9b45bc055b24f1abacfcea057af711d</sysId>
        <tasks>
            <task>bun-task-1</task>
        </tasks>
        <timeZone />
    </triggerCron>
    <triggerManual    <triggerManual exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_manual" retainSysIds="true" version="1">
        <variables/>
        <notes/>
        <calendar>System Default</calendar>
        <description>Manual test</description>
        <disabledTime></disabledTime>
        <enabled>false</enabled>
        <enabledTime></enabledTime>
        <name>man-trig-1</name>
        <nextScheduledTime></nextScheduledTime>
        <opswiseGroups/>
        <rdExcludeBackup>false</rdExcludeBackup>
        <restrictionNthAmount>5</restrictionNthAmount>
        <retentionDuration>1</retentionDuration>
        <retentionDurationPurge>false</retentionDurationPurge>
        <retentionDurationUnit>Days</retentionDurationUnit>
        <sysId>728fc94ce80c4b97ae63ab741e902cc5</sysId>
        <tasks>
            <task>bun-task-1</task>
        </tasks>
        <timeZone />
    </triggerManual>
    <triggerTm exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_tm"  retainSysIds="true" version="1">
        <variables/>
        <action>Do Not Trigger</action>
        <notes/>
        <calendar>System Default</calendar>
        <description>Task Monitor Trigger 1</description>
        <disabledTime></disabledTime>
        <enabled>false</enabled>
        <enabledTime></enabledTime>
        <name>Taskmon-trig-1</name>
        <nextScheduledTime></nextScheduledTime>
        <opswiseGroups>
            <opswiseGroup>A</opswiseGroup>
        </opswiseGroups>
        <rdExcludeBackup>false</rdExcludeBackup>
        <restriction>false</restriction>
        <restrictionAdjective>Every</restrictionAdjective>
        <restrictionComplex>false</restrictionComplex>
        <restrictionMode>Or</restrictionMode>
        <restrictionNoun>Day</restrictionNoun>
        <restrictionNthAmount>5</restrictionNthAmount>
        <restrictionQualifier>Year</restrictionQualifier>
        <restrictionSimple>false</restrictionSimple>
        <retentionDuration>1</retentionDuration>
        <retentionDurationPurge>false</retentionDurationPurge>
        <retentionDurationUnit>Days</retentionDurationUnit>
        <situation>Holiday</situation>
        <skipActive>false</skipActive>
        <skipAfterDate />
        <skipAfterTime />
        <skipBeforeDate />
        <skipBeforeTime />
        <skipCondition>None</skipCondition>
        <skipCount>0</skipCount>
        <skipDateList/>
        <skipRestriction>None</skipRestriction>
        <sysId>808272bdf2aa49a9bb8edcb700c40cfd</sysId>
        <tasks>
            <task>bun-task-1</task>
        </tasks>
        <timeZone />
        <enabledEnd>00:00</enabledEnd>
        <enabledStart>00:00</enabledStart>
        <restrictedTimes>false</restrictedTimes>
        <taskMonitor>Task-mon-1</taskMonitor>
    </triggerTm>
    <triggerTime exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_time" retainSysIds="true" version="1">
        <variables/>
        <action>Do Not Trigger</action>
        <notes/>
        <adjustInterval>false</adjustInterval>
        <adjustmentAmount>1</adjustmentAmount>
        <adjustmentType>Day</adjustmentType>
        <calendar>System Default</calendar>
        <dateAdjective>Every</dateAdjective>
        <dateAdjustment>None</dateAdjustment>
        <dateNoun>Day</dateNoun>
        <dateQualifier>Year</dateQualifier>
        <dayInterval>2</dayInterval>
        <dayStyle>Simple</dayStyle>
        <description>Time trigger test</description>
        <disabledTime></disabledTime>
        <enabled>false</enabled>
        <enabledEnd>00:00</enabledEnd>
        <enabledStart>00:00</enabledStart>
        <enabledTime></enabledTime>
        <forecast>false</forecast>
        <fri>false</fri>
        <intervalStartingDate>2021-06-01</intervalStartingDate>
        <mon>false</mon>
        <name>time-trig-1</name>
        <nextScheduledTime></nextScheduledTime>
        <nthAmount>5</nthAmount>
        <opswiseGroups>
            <opswiseGroup>A</opswiseGroup>
        </opswiseGroups>
        <rdExcludeBackup>false</rdExcludeBackup>
        <restrictedTimes>false</restrictedTimes>
        <restriction>false</restriction>
        <restrictionAdjective>Every</restrictionAdjective>
        <restrictionComplex>false</restrictionComplex>
        <restrictionMode>Or</restrictionMode>
        <restrictionNoun>Day</restrictionNoun>
        <restrictionNthAmount>5</restrictionNthAmount>
        <restrictionQualifier>Year</restrictionQualifier>
        <restrictionSimple>false</restrictionSimple>
        <retentionDuration>1</retentionDuration>
        <retentionDurationPurge>false</retentionDurationPurge>
        <retentionDurationUnit>Days</retentionDurationUnit>
        <sat>false</sat>
        <simpleDateType>Daily</simpleDateType>
        <simulationOption>-- System Default --</simulationOption>
        <situation>Holiday</situation>
        <skipActive>false</skipActive>
        <skipAfterDate />
        <skipAfterTime />
        <skipBeforeDate />
        <skipBeforeTime />
        <skipCondition>None</skipCondition>
        <skipCount>0</skipCount>
        <skipDateList/>
        <skipRestriction>None</skipRestriction>
        <startTimeEnable>false</startTimeEnable>
        <startingAt>*:00</startingAt>
        <sun>false</sun>
        <sysId>16bde4cef2df4cc3b26dd04a6bcfce91</sysId>
        <tasks>
            <task>Sleep 30</task>
        </tasks>
        <thu>false</thu>
        <time>00:00</time>
        <timeInterval />
        <timeIntervalUnits>Hours</timeIntervalUnits>
        <timeStyle>Absolute</timeStyle>
        <timeZone />
        <tue>false</tue>
        <wed>false</wed>
    </triggerTime>
</triggers>

Expand

title	JSON

[
    {
        "type": "triggerCron",
        "action": "Do Not Trigger",
        "calendar": "System Default",
        "dayLogic": "And",
        "dayOfMonth": "*",
        "dayOfWeek": "*",
        "description": "cron test",
        "disabledBy": "",
        "disabledTime": "",
        "enabled": false,
        "enabledBy": "ops.admin",

        "enabledTime": "2021-06-01 11:29:48 -0400",
        "exportReleaseLevel": "7.2.0.0"
        "enabledTimeexportTable": "2021-06-01 11:29:48 -0400ops_trigger_cron",
        "forecast": false,
        "hours": "1",
        "minutes": "0",
        "month": "*",
        "name": "cron-1",
        "nextScheduledTime": "",
        "notes": [],
        "opswiseGroups": [
            "B"
        ],
        "rdExcludeBackup": false,
        "restriction": false,
        "restrictionAdjective": "Every",
        "restrictionComplex": false,
        "restrictionMode": "Or",
        "restrictionNoun": {
            "value": "Day"
        },
        "restrictionNthAmount": 5,
        "restrictionQualifier": {
            "value": "Year"
        },
        "restrictionSimple": false,
        "retainSysIds": true,
        "retentionDuration": 1,
        "retentionDurationPurge": false,
        "retentionDurationUnit": "Days",
        "simulationOption": "-- System Default --",
        "situation": "Holiday",
        "skipActive": false,
        "skipAfterDate": null,
        "skipAfterTime": null,
        "skipBeforeDate": null,
        "skipBeforeTime": null,
        "skipCondition": "None",
        "skipCount": 0,
        "skipDateList": [],
        "skipRestriction": "None",
        "sysId": "e9b45bc055b24f1abacfcea057af711d",
        "tasks": [
            "bun-task-1"
        ],
        "timeZone": null,
        "variables": [],
        "version": 1
    },
    {
        "type": "triggerManual",
        "calendar": "System Default",
        "description": "Manual test",
        "disabledTime": "",
        "enabled": false,
        "enabledTime": "",
        "exportReleaseLevel": "7.2.0.0"
        "exportTable": "ops_trigger_manual",
        "name": "man-trig-1",
        "nextScheduledTime": "",
        "notes": [],
        "opswiseGroups": [],
        "rdExcludeBackup": false,
        "restrictionNthAmount": 5,
        "retainSysIds": true,
        "retentionDuration": 1,
        "retentionDurationPurge": false,
        "retentionDurationUnit": "Days",
        "sysId": "728fc94ce80c4b97ae63ab741e902cc5",
        "tasks": [
            "bun-task-1"
        ],
        "timeZone": null,
        "variables": [],
        "version": 1
    },
    {
        "type": "triggerTm",
        "action": "Do Not Trigger",
        "calendar": "System Default",
        "description": "Task Monitor Trigger 1",
        "disabledTime": "",
        "enabled": false,
        "enabledEnd": "00:00",
        "enabledStart": "00:00",
        "enabledTime": "",
        "exportReleaseLevel": "7.2.0.0"
        "enabledTimeexportTable": "ops_trigger_tm",
        "name": "Taskmon-trig-1",
        "nextScheduledTime": "",
        "notes": [],
        "opswiseGroups": [
            "A"
        ],
        "rdExcludeBackup": false,
        "restrictedTimes": false,
        "restriction": false,
        "restrictionAdjective": "Every",
        "restrictionComplex": false,
        "restrictionMode": "Or",
        "restrictionNoun": {
            "value": "Day"
        },
        "restrictionNthAmount": 5,
        "restrictionQualifier": {
            "value": "Year"
        },
        "restrictionSimple": false,
        "retainSysIds": true,
        "retentionDuration": 1,
        "retentionDurationPurge": false,
        "retentionDurationUnit": "Days",
        "situation": "Holiday",
        "skipActive": false,
        "skipAfterDate": null,
        "skipAfterTime": null,
        "skipBeforeDate": null,
        "skipBeforeTime": null,
        "skipCondition": "None",
        "skipCount": 0,
        "skipDateList": [],
        "skipRestriction": "None",
        "sysId": "808272bdf2aa49a9bb8edcb700c40cfd",
        "taskMonitor": "Task-mon-1",
        "tasks": [
            "bun-task-1"
        ],
        "timeZone": null,
        "variables": [],
        "version": 1
    },
    {
        "type": "triggerTime",
        "action": "Do Not Trigger",
        "adjustInterval": false,
        "adjustmentAmount": 1,
        "adjustmentType": "Day",
        "calendar": "System Default",
        "dateAdjective": "Every",
        "dateAdjustment": "None",
        "dateNoun": {
            "value": "Day"
        },
        "dateQualifier": {
            "value": "Year"
        },
        "dayInterval": 2,
        "dayStyle": "Simple",
        "description": "Time trigger test",
        "disabledTime": "",
        "enabled": false,
        "enabledEnd": "00:00",
        "enabledStart": "00:00",
        "enabledTime": "",
        "exportReleaseLevel": "7.2.0.0"
        "exportTable": "ops_trigger_time",
        "forecast": false,
        "fri": false,
        "intervalStartingDate": "2021-06-01",
        "mon": false,
        "name": "time-trig-1",
        "nextScheduledTime": "",
        "notes": [],
        "nthAmount": 5,
        "opswiseGroups": [
            "A"
        ],
        "rdExcludeBackup": false,
        "restrictedTimes": false,
        "restriction": false,
        "restrictionAdjective": "Every",
        "restrictionComplex": false,
        "restrictionMode": "Or",
        "restrictionNoun": {
            "value": "Day"
        },
        "restrictionNthAmount": 5,
        "restrictionQualifier": {
            "value": "Year"
        },
        "restrictionSimple": false,
        "retainSysIds": true,
        "retentionDuration": 1,
        "retentionDurationPurge": false,
        "retentionDurationUnit": "Days",
        "sat": false,
        "simpleDateType": "Daily",
        "simulationOption": "-- System Default --",
        "situation": "Holiday",
        "skipActive": false,
        "skipAfterDate": null,
        "skipAfterTime": null,
        "skipBeforeDate": null,
        "skipBeforeTime": null,
        "skipCondition": "None",
        "skipCount": 0,
        "skipDateList": [],
        "skipRestriction": "None",
        "startTimeEnable": false,
        "startingAt": "*:00",
        "sun": false,
        "sysId": "16bde4cef2df4cc3b26dd04a6bcfce91",
        "tasks": [
            "Sleep 30"
        ],
        "thu": false,
        "time": "00:00",
        "timeInterval": null,
        "timeIntervalUnits": "Hours",
        "timeStyle": "Absolute",
        "timeZone": null,
        "tue": false,
        "variables": [],
        "version": 1,
        "wed": false
    }
]

...

	Description
URI	http://host_name/uc/resources/trigger/ops-trigger-now
HTTP Method	POST
Description	Launches trigger-associated tasks.
Example URI	http://localhost:8080/uc/resources/trigger/ops-trigger-now
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Trigger Now: XML and JSON Examples.
Example Request Properties	See Trigger Now: Request Properties.
Example Response	See Trigger Now: XML and JSON Examples.

...

Examples

XML

JSON

Request Example

Expand

title	XML

<trigger-now>
    <name>uc - Every 15 Minutes MWF 9-5</name>
    <hold>yes</hold>
    <holdReason>Waiting for input</holdReason>
    <timeZone>America/Chicago</timeZone>
    <virtualResourcePriority>10</virtualResourcePriority>
    <virtual-resources> 
        <virtual-resource>
            <name>uc - Solo</name>
            <limit>2</limit>
        </virtual-resource>
    </virtual-resources>
    <variables>
        <variable>
            <name>testVariable</name>
            <value>Hello</value>
        </variable>
    </variables>
    <overrideTriggerDateTime>true</overrideTriggerDateTime>
    <overrideDate>2020-07-14</overrideDate>
    <overrideTime>10:15</overrideTime>
    <overrideTimeZone>America/Chicago</overrideTimeZone>
</trigger-now>

Expand

title	JSON

{
  "name": "uc - Every 15 Minutes MWF 9-5",
  "hold": "yes",
  "holdReason": "Waitng for input",
  "timeZone": "America/Chicago",
  "virtualResourcePriority": 10,
  "virtualResources": [
    {
      "name": "uc - Solo",
      "limit": 2
    }
  ],
  "variables": [
    {
      "name": "testVariable",
      "value": "Hello"
    }
  ],
  "overrideTriggerDateTime": "true",
  "overrideDate": "2020-07-14",
  "overrideTime": "10:15",
  "overrideTimeZone": "America/Chicago"
}

Response Example

Expand

title	XML

Panel

<command-response>
    <type>trigger_now</type>
    <success>true</success>
    <info>Successfully triggered - Every 15 Minutes MWF 9-5</info>
    <sys_id>4c7d6b9cc0a801c900e7dac8b24ef142<\sys_id>
    <errors />
</command-response>

Expand

title	JSON

Panel
{ "type": "trigger_now", "success": true, "info": "Successfully triggered \"Successfully triggered - Every 15 Minutes MWF 9-5", "errors": "", "sysId": "4c7d6b9cc0a801c900e7dac8b24ef142" }

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	hold - TaT
	hold - TaT

hold

Hold on Start

Indication of whether or not to launch the task in Held status. The task runs when the user releases it.

Boolean; Valid values: Yes, Y, true.

N

Anchor

	holdReason - TaT
	holdReason - TaT

holdReason

Hold Reason

Information about why the task instances will be put on hold when the tasks start.

N

Anchor

	name - TaT
	name - TaT

name

Name

Name of the trigger to trigger the task.

Y

Anchor

	overrideDate - TaT
	overrideDate - TaT

overrideDate

Date

Date of the override execution.

YYY-MM-DD

N
(Y if overrrideTriggerDateTime
is true.)

Anchor

	overrideTime - TaT
	overrideTime - TaT

overrideTime

Time

Time of the override execution.

HH:MM

N
(Y if overrrideTriggerDateTime
is true.)

Anchor

	overrideTimeZone - TaT
	overrideTimeZone - TaT

overrideTimeZone

Time Zone

Time zone of the override execution.

N
(Y if overrrideTriggerDateTime
is true.)

Anchor

	overrideTriggerDateTime - TaT
	overrideTriggerDateTime - TaT

overrideTriggerDateTime

Override Trigger Date/Time

Specification for whether to enable or disable override functionality.

Boolean; Valid values: true/false.

Default is false.

N

Anchor

	timeZone - TaT
	timeZone - TaT

timeZone

Time Zone

Time zone in which task is triggered.

N

Anchor

	variables - TaT
	variables - TaT

variables

n/a

Panel

Code Block

language	text

<variables>
        <variable>
            <name>testVariable</name>
            <value>Hello</value>
        </variable>
    </variables>

See Trigger Task(s) (Trigger Now): Request Variable Properties.

N

Anchor

	virtualResourcePriority - TaT
	virtualResourcePriority - TaT

virtualResourcePriority

Virtual Resource Priority

Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task.

Integer; Valid values: 1-20 (1 is high priority, 20 is low priority). Default is 10.

N

Anchor

	virtual-resources - TaT
	virtual-resources - TaT

virtual-resources

n/a

Panelcode

language

text

 <virtual-resources> 
        <virtual-resource>
            <name>uc - Solo</name>
            <limit>2</limit>
        </virtual-resource>
    </virtual-resources>

See Triger Task(s) (Trigger Now): Request Virtual Resource Properties.

The virtual resource dependencies specified in virtual-resources are merged with the default virtual resource dependencies.

If a default virtual resource dependency already exists for a specified virtual resource amount, the virtual resource dependency is updated.
Any virtual resource specified with an amount of 0 is dropped from the default virtual resource dependencies; if the virtual resource did not exist as a default dependency, the command will fail.
If a default virtual resource dependency does not already exist for a specified virtual resource amount, the virtual resource dependency is added.

N

...

	Description
URI	http://host_name/uc/resources/trigger/unassignexecutionuser
HTTP Method	POST
Description	Unassigns an Execution User from the specified trigger.
URI Parameters	See Unassign an Execution User to a Trigger: URI Parameters.
Authentication	HTTP Basic
Example URI	http://localhost:8080/uc/resources/trigger/unassignexecutionuser?triggername=testTrigger http://localhost:8080/uc/resources/trigger/unassignexecutionuser?triggerid=410d6c0bc0a801c901838d8ac43b3279
Example Response	Status 200 /OK Successfully unassigned execution user "test" from trigger "testTrigger".

...

Versions Compared

Old Version 1

New Version Current

Key

Anchor
Assign an Execution User to a Trigger Request Properties
Assign an Execution User to a Trigger Request Properties
Assign an Execution User to a Trigger: Request Properties

Anchor
Enable/Disable a Trigger XML and JSON Examples
Enable/Disable a Trigger XML and JSON Examples
Enable/Disable a Trigger: XML and JSON Examples

Anchor
Enable/Disable a Trigger Request Trigger Properties
Enable/Disable a Trigger Request Trigger Properties
Enable/Disable a Trigger: Request Trigger Properties

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

AnchorAssign an Execution User to a Trigger Request PropertiesAssign an Execution User to a Trigger Request PropertiesAssign an Execution User to a Trigger: Request Properties

AnchorEnable/Disable a Trigger XML and JSON ExamplesEnable/Disable a Trigger XML and JSON ExamplesEnable/Disable a Trigger: XML and JSON Examples

AnchorEnable/Disable a Trigger Request Trigger PropertiesEnable/Disable a Trigger Request Trigger Properties Enable/Disable a Trigger: Request Trigger Properties

Anchor
Assign an Execution User to a Trigger Request Properties
Assign an Execution User to a Trigger Request Properties
Assign an Execution User to a Trigger: Request Properties

Anchor
Enable/Disable a Trigger XML and JSON Examples
Enable/Disable a Trigger XML and JSON Examples
Enable/Disable a Trigger: XML and JSON Examples

Anchor
Enable/Disable a Trigger Request Trigger Properties
Enable/Disable a Trigger Request Trigger Properties
Enable/Disable a Trigger: Request Trigger Properties