...
Examples | XML | JSON |
---|
Request Example | Expand |
---|
| Panel |
---|
Html bobswift |
---|
<pre>
<executionUser>
< |
username Html bobswift |
---|
>test< |
/username password Html bobswift |
---|
>pass1< |
/password Html bobswift |
---|
>
</executionUser>
</pre> |
|
|
| |
...
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
...
Examples | XML | JSON |
---|
Request Example |
Property | UI Field Name | Description | Specifications | Required |
---|
Anchor |
---|
trigger - EDT | trigger - EDT | trigger
n/a | There are two attributes for this property: For example: <trigger | Response Example | Expand |
---|
|
Panel |
---|
Expand |
---|
|
Panel |
---|
...
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> |
| trigger Html bobswift |
---|
enable="false" name="uc - 1st Sunday of Month" |
|
| ></trigger> | Y |
...
Description
...
URI
...
HTTP Method
...
POST
...
Description
...
Lists triggers matching specific search criteria.
...
Example URI
...
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.
Expand |
---|
| [ {
"enabled": true,
"name": "Example time trigger 1",
"sysId": "68aca9ea398f4d17a7ca23eeaa1d4fa1",
"type": "/trigger Html bobswift |
---|
>
</enable-disable-trigger>
</pre> |
|
|
| Expand |
---|
| Panel |
---|
Html bobswift |
---|
<pre>
[{
"enable": true,
"name": "uc - 1st and 15th"
},
{
"enable": false,
"name": "uc - 1st Sunday of Month"
}]
</pre> |
|
|
|
Response Example | Expand |
---|
| Panel |
---|
Html bobswift |
---|
<pre>
<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> </pre> |
|
|
| Expand |
---|
| Panel |
---|
Html bobswift |
---|
<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 PropertiesProperty | 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> 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> |
| Y |
Anchor |
---|
| List Triggers |
---|
| List Triggers |
---|
|
List Triggers Anchor |
---|
| List Triggers XML and JSON Examples |
---|
| List Triggers XML and JSON Examples |
---|
|
List Triggers: XML and JSON ExamplesExamples | 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
} ] |
|
...
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
...
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 | | 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 |
---|
name
/name
limit
/limitExamples | XML | JSON |
---|
Request Example | | Expand |
---|
| {
</virtual-resource>
</virtual-resources>
<variables>
<variable>
"name": "uc - Every 15 Minutes MWF 9-5",
"hold": "yes",
"holdReason": "Waitng for input",
"timeZone": "America/Chicago",
"virtualResourcePriority": 10,
"virtualResources": [
{
<name>testVariable</name> "name": "uc - Solo",
<value>Hello</value> "limit": 2
}
</variable> ],
</variables> "variables": [
<overrideTriggerDateTime>true</overrideTriggerDateTime> {
<overrideDate>2020-07-14</overrideDate> <overrideTime>10:15</overrideTime> <overrideTimeZone>America/Chicago</overrideTimeZone>
</trigger-now> | Expand |
---|
| {"name": "testVariable",
"namevalue": "ucHello"
- Every 15}
Minutes MWF 9-5"], "holdoverrideTriggerDateTime": "yestrue", "holdReasonoverrideDate": "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"
} |
|
|
...
|
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"
} |
|
|
Anchor |
---|
| Trigger Tasks Trigger Now Request Properties |
---|
| Trigger Tasks Trigger Now Request Properties |
---|
|
Trigger Task(s) (Trigger Now): Request PropertiesProperty | 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>
<variables>
<variable>
< |
name Html bobswift |
---|
>testVariable< |
/name value Html bobswift |
---|
>Hello< |
/value Html bobswift |
---|
>
</variable>
</variables>
</pre> |
|
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>
<virtual-resource>
< |
name Html bobswift |
---|
>uc - Solo< |
/name limit /limit Html bobswift |
---|
>
</virtual-resource>
</virtual-resources>
</pre> |
|
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 |
...