Page Comparison

...

The following web services are common to all Trigger types:

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

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

Expand

title	JSON

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

...

	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.

...

	Description
URI	http://host_name/uc/resources/trigger/ops-enable-disable-trigger
HTTP Method	POST
Description	Enables/Disables a list of triggers.
Example URI	http://localhost:8080/uc/resources/trigger/ops-enable-disable-trigger
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Enable/Disable a Trigger: XML and JSON Examples.
Request Properties	See Enable/Disable a Trigger: Request Trigger Properties.
Example Response	See Enable/Disable a Trigger: XML and JSON Examples.

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
<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
[{ "enable": true, "name": "uc - 1st and 15th" }, { "enable": false, "name": "uc - 1st Sunday of Month" }]

Response Example

Expand

title	XML

Panel

<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

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

...

	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.

Anchor
List Triggers XML and JSON Examples
List Triggers XML and JSON Examples
List Triggers: XML and JSON Examples

...

	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.

Anchor
List Triggers - Advanced URI Properties
List Triggers - Advanced URI Properties
List Triggers - Advanced: URI Properties

...

	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.

Anchor
Triggers Tasks Trigger Now XML and JSON Examples
Triggers Tasks Trigger Now XML and JSON Examples
Trigger Task(s) (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

launchReason Launch Reason Reason for the task launch Y

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

...

	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 5

New Version 6

Key

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
List Triggers XML and JSON Examples
List Triggers XML and JSON Examples
List Triggers: XML and JSON Examples

Anchor
List Triggers - Advanced URI Properties
List Triggers - Advanced URI Properties
List Triggers - Advanced: URI Properties

Anchor
Triggers Tasks Trigger Now XML and JSON Examples
Triggers Tasks Trigger Now XML and JSON Examples
Trigger Task(s) (Trigger Now): XML and JSON Examples

Page Comparison

Versions Compared

Old Version 5

New Version 6

Key

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

AnchorList Triggers XML and JSON ExamplesList Triggers XML and JSON ExamplesList Triggers: XML and JSON Examples

AnchorList Triggers - Advanced URI PropertiesList Triggers - Advanced URI PropertiesList Triggers - Advanced: URI Properties

AnchorTriggers Tasks Trigger Now XML and JSON ExamplesTriggers Tasks Trigger Now XML and JSON ExamplesTrigger Task(s) (Trigger Now): XML and JSON Examples

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
List Triggers XML and JSON Examples
List Triggers XML and JSON Examples
List Triggers: XML and JSON Examples

Anchor
List Triggers - Advanced URI Properties
List Triggers - Advanced URI Properties
List Triggers - Advanced: URI Properties

Anchor
Triggers Tasks Trigger Now XML and JSON Examples
Triggers Tasks Trigger Now XML and JSON Examples
Trigger Task(s) (Trigger Now): XML and JSON Examples