...
Examples | XML | JSON |
---|
Request Example |
Expand |
---|
|
Panel |
---|
Html bobswift | <pre>
<executionUser> Code Block |
---|
| <executionUser>
<username Html bobswift |
---|
>test< |
/username Html bobswift | ><username>test</username>
<password Html bobswift |
---|
>pass1< |
/password Html bobswift | >
</executionUser>
</pre><password>pass1</password>
</executionUser> |
|
|
Expand |
---|
|
Code Blockpanel |
---|
| html-bobswift | <pre>
{
"username": "test",
"password": "pass1"
}
</pre> |
|
|
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 | |
panel<pre>
<enable Html bobswift |
trigger><trigger
Html bobswift |
---|
<trigger enable="true" name="uc - 1st and 15th" |
|
|
></trigger
Html bobswift |
><trigger
Html bobswift |
---|
<trigger enable="false" name="uc - 1st Sunday of Month" |
|
|
></trigger
Html bobswift |
>
<></trigger>
</enable-disable- |
|
|
trigger>
</pre>panelhtml-bobswift<pre> [{
"enable": true,
"name": "uc - 1st and 15th"
},
{
"enable": false,
"name": "uc - 1st Sunday of Month"
}] |
|
|
</pre>panelhtmlbobswift<pre>
<command-response> <type>EnableTriggers</type><success>true</success><info>Successfully<info>Successfully enabled trigger uc - 1st and 15th, Successfully disabled trigger uc - 1st Sunday of |
|
|
Month</info><errors>
<response> </pre> Html bobswift |
<pre>
Panel |
---|
Code Block |
---|
| {
"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
Property | UI Field Name | Description | Specifications | Required |
---|
Anchor |
---|
| trigger - EDT |
---|
| trigger - EDT |
---|
|
trigger | n/a | There are two attributes for this property: Html bobswift | <ul>
<li>
<li>
</ul>For example: <trigger enable="false" name="uc - 1st Sunday of Month"></trigger> |
| Y |
...
Examples | XML | JSON |
---|
Request Example | | |
Response Example |
Expand |
---|
| <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 |
---|
| [ {
"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 |
| Status | Indication of whether to list enabled (true) or disabled (false) triggers. | Boolean; Valid values: true/false. | N |
| Name | Name or partial name of one or more triggers. | /wiki/spaces/UC71x/pages/5215217 are supported. | N |
| Task(s) | List Triggers that reference any one of the specified links. | Comma-separated Task names. | N |
| 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 |
---|
| {
"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 |
---|
|
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 |
---|
|
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 |
---|
| 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 |
| 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 |
---|
Html bobswift | <pre>
Code Block |
---|
| <variables>
<variable>
<variables> <variable><name>testVariable</name>
<name Html bobswift |
---|
>testVariable< |
/name Html bobswift | ><value>Hello</value>
</variable>
<value Html bobswift |
---|
>Hello< |
/value 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 |
Panel |
---|
Html bobswift | <pre>
<virtual-resources> Code Block |
---|
| <virtual-resources>
<virtual-resource><virtual-resource>
<name Html bobswift | >uc<name>uc - Solo</name Html bobswift | >Solo</name>
<limit /limit 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 |
...