Page Comparison

...

Examples

XML

JSON

Request Example

Expand

title	XML

Code Block

language	text

<trigger-now>

<name>uc - Every 15 Minutes MWF 9-5</name>

<name>man-trig1</name>
    <hold>yes</hold>

<holdReason>Waiting for input</holdReason>

<holdReason>Waiting

for

input<

<launchReason>testing</

holdReason>

launchReason>

<timeZone>America

<timeZone>America/Chicago</

timeZone>

timeZone>

<virtualResourcePriority>10</virtualResourcePriority>

<virtual

<virtual-

resources>

resources> 
        <virtual-resource>

<name>VR-1</name>

<limit>2</limit>
        </virtual-resource>
    </virtual-

resources>

resources>

<variables>
        <variable>

<name>testVariable</name>

<name>testVariable</name>

<value>Hello</value>

<value>Hello</value>
        </variable>
    </

variables>

variables>

<overrideTriggerDateTime>true</overrideTriggerDateTime>

<overrideDate>2020

<overrideDate>2022-

07

09-

14</overrideDate>

20</overrideDate>

<overrideTime>10

<overrideTime>11:15</

overrideTime>

overrideTime>

<overrideTimeZone>America

<overrideTimeZone>America/Chicago</

overrideTimeZone>

overrideTimeZone>
</trigger-now>

Expand

title	JSON

Code Block

language	text

{
  "name": "

uc - Every 15 Minutes MWF 9-5

man-trig1",
  "hold": "yes",
  "holdReason": "Waitng for input",
  "launchReason": "test1",
  "timeZone": "America/Chicago",
  "virtualResourcePriority": 10,
  "virtualResources": [
    {
      "name": "

uc

VR-

Solo

1",
      "limit": 2
    }
  ],
  "variables": [
    {
      "name": "testVariable",
      "value": "Hello"
    }
  ],


  "overrideTriggerDateTime": "true",


  "overrideDate": "

2020

2022-

07

09-

14

20",


  "overrideTime": "

10

11: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

launchReason

Launch Reason

Reason for the task launch

N

(Y if Task Launch Reason Required system property is True.)

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
<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

Panel
<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

...

Versions Compared

Old Version 6

New Version Current

Key