Page Comparison

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

...

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.

...

> </executionUser> </pre>

<password>pass1</password>
</executionUser>

Examples

XML

JSON

Request Example

>

<username>test</username>

<

Expand

title	XML

<pre> <executionUser>

<executionUser>

<

Panel

Html bobswift

Html bobswift
>test<

Html bobswift

Html bobswift
>pass1<

Html bobswift

Expand

title	JSON

<pre> {

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

</pre>

Panel

Html bobswift

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

...

Examples

XML

JSON

Request Example

Expand

title	XML

<pre> <enable

<enable-disable-

trigger>

trigger>

<

<trigger enable="true" name="uc - 1st and 15th"

><

>

></trigger>

<

<trigger enable="false" name="uc - 1st Sunday of Month"

><

> <

></trigger>
</enable-disable-

trigger> </pre>

trigger>

Panel

Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift

Expand

title	JSON

<pre>

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

</pre>

Panel

Html bobswift

Response Example

Expand

title	XML

Panel

html

<command-

bobswift<pre> <command-response>

response>

<type>Enable

<type>Enable Disable

Triggers</type>

Triggers</type>

<success>true</success>

<success>true</success>

<info>Successfully

<info>Successfully enabled trigger uc - 1st and 15th, Successfully disabled trigger uc - 1st Sunday of

Month</info>

Month</info>

<errors

<errors /

> <

>
</command-

response> </pre>

response>

Expand

title	JSON

html-bobswift

Panel

<pre>

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

</pre>

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

<ul> <li>

enable:

Indication

of

whether

to

enable

or

disable

the

trigger.

Only

enabled

triggers

are

processed

by

the

Controller.

Boolean;

Valid

values:

true/false.

<li>

name:

Name

used

within

the

Controller

to

identify

this

trigger.

Maximum

of

255

alphanumerics.

</ul>

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

Property

UI Field Name

Description

Specifications

Required

Anchor

	trigger - EDT
	trigger - EDT

trigger

n/a

There are two attributes for this property:

Html bobswift

Y

Anchor
List Triggers
List Triggers
List Triggers

...

>

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

<

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

<pre>

  <variables>
        <variable>

<variables>

<variable>

<name>testVariable</name>

<

Panel

Html bobswift

Html bobswift
>testVariable<

Html bobswift

Html bobswift
>Hello<

Html bobswift
> </variable> </variables> </pre>

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

html-bobswift>uc

<name>uc -

Solo<

>

Solo</name>

<

Panel

<pre> <virtual-resources> <virtual-resources> <virtual-resource> <virtual-resource> < name
Html bobswift
Html bobswift

Html bobswift
>2<

Html bobswift>

<limit>2</limit>

<

</virtual-

resource>

resource>

<

</virtual-

resources> </pre>

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

...