Versions Compared

Old Version 4

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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

...

Examples

XML

JSON

Request Example


Expand
titleXML


username

/username

password

/password
Panelcode
language
text
<executionUser>
      <username>test</username>
      <password>pass1</password>
</executionUser>



panel
Expand
titleJSON


Code Block
languagetext
{
 "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

...

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
titleXML
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
titleJSON
panel


Code Block
Response Example
language
Expand
titleXML
Panel Expand
titleJSON
panel
text
  [{
     "enable": true,
     "name": "uc - 1st and 15th"
  },
  {
     "enable": false,
     "name": "uc - 1st Sunday of Month"
  }]



Response Example


Expand
titleXML


Code Block
languagetext
<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
titleJSON


Code Block
languagetext
{
    "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

...

Examples

XML

JSON

Request Example


Expand
titleXML
<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
titleJSON
{
  "name": "*time*",
  "enabled": true,
  "type": "Time",  
  "tasks": "Sleep 0, Sleep 60",
  "description": "manual1"
}


Response Example


Expand
titleXML
<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
titleJSON
[ {
  "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
} ]


...

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

Request Example


Expand
titleXML
<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
titleJSON
{
  "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
titleXML


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
titleJSON


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



...

name

/name

value

/value

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

DateDate of the override execution.YYY-MM-DDN
(Y if overrrideTriggerDateTime
is true.)

Anchor
overrideTime - TaT
overrideTime - TaT
overrideTime

TimeTime of the override execution.HH:MMN
(Y if overrrideTriggerDateTime
is true.)

Anchor
overrideTimeZone - TaT
overrideTimeZone - TaT
overrideTimeZone

Time ZoneTime zone of the override execution.
N
(Y if overrrideTriggerDateTime
is true.)

Anchor
overrideTriggerDateTime - TaT
overrideTriggerDateTime - TaT
overrideTriggerDateTime

Override Trigger Date/TimeSpecification 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
languagetext
<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


name

/name

limit

/limit
Code Blockpanel
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

...