...
- Application Monitor Trigger Web Services
- Composite Trigger Web Services
- Cron Trigger Web Services
- Email Monitor Trigger Web Services
- Agent File Monitor Trigger Web Services
- Manual Trigger Web Services
- Task Monitor Trigger Web Services
- Temporary Trigger Web Services
- Time Trigger Web Services
- Universal Monitor Trigger Web Services
- Variable Monitor Trigger Web Services
Anchor | ||||
---|---|---|---|---|
|
Assign an Execution User to a Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger/assignexecutionuser |
HTTP Method | POST |
Description | Assigns an Execution User to the specified trigger. |
URI Parameters | |
Authentication | HTTP Basic |
Example URI | |
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 |
|
Anchor | ||||
---|---|---|---|---|
|
Assign an Execution User to a Trigger: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this trigger. | Y |
| |
| Name used within the Controller to identify this trigger. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Assign an Execution to a Trigger: XML and JSON Request Examples
Examples | XML | JSON | |||||||
---|---|---|---|---|---|---|---|---|---|
Request Example |
|
Anchor | ||||
---|---|---|---|---|
|
Assign an Execution User to a Trigger: Request Properties
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
password | n/a | If the user executing this web service does not have the ops_admin role; Password of the Execution User. | Y | |||||||
username | n/a | Name of the Execution User. | Wildcards are supported. | Y |
Anchor | ||||
---|---|---|---|---|
|
Delete a Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger |
HTTP Method | DELETE |
Description | Assigns an execution user to the specified trigger. |
URI Parameters | |
Authentication | HTTP Basic |
Example URI | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Delete a Trigger: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this trigger. | Y |
| |
| Name used within the Controller to identify this trigger. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Enable/Disable a Trigger
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Enable/Disable a Trigger: XML and JSON Examples
Examples | XML | JSON | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request Example |
| |||||||||||||||
Response Example |
|
|
Anchor | ||||
---|---|---|---|---|
|
Enable/Disable a Trigger: Request Trigger Properties
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
trigger | n/a | There are two attributes for this property:
For example: <trigger enable="false" name="uc - 1st Sunday of Month"></trigger> | Y |
Anchor | ||||
---|---|---|---|---|
|
List Triggers
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
List Triggers: XML and JSON Examples
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Request Example |
| |||||||||||
Response Example |
|
|
Anchor | ||||
---|---|---|---|---|
|
List Triggers: Request Properties
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
description | Description | Filter the trigger list using the description. | Wildcards are supported. | N | ||||||
enabled | Status | Indication of whether to list enabled (true) or disabled (false) triggers. | Boolean; Valid values: true/false. | N | ||||||
name | Name | Name or partial name of one or more triggers. | Wildcards are supported. | N | ||||||
tasks | Task(s) | List Triggers that reference any one of the specified links. | Comma-separated Task names. | N | ||||||
type | n/a | Type of triggers to list. | Valid values:
| N |
Anchor | ||||
---|---|---|---|---|
|
List Triggers - Advanced
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves trigger details using specific query parameters. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
URI Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
List Triggers - Advanced: URI Properties
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| Member of Business Services | Business Services that this trigger belongs to. | ||||||||
description | Description | Filter the trigger list using the description. | /wiki/spaces/UC71x/pages/5215217 are supported. | N | ||||||
enabled | Status | Indication of whether to list enabled (true) or disabled (false) triggers. | Boolean; Valid values: true/false. | N | ||||||
name | Name | Name or partial name of one or more triggers. | /wiki/spaces/UC71x/pages/5215217 are supported. | N | ||||||
tasks | Task(s) | List Triggers that reference any one of the specified links. | Comma-separated Task names. | N | ||||||
type | n/a | Type of triggers to list. | Valid values:
|
Anchor | ||||
---|---|---|---|---|
|
List Triggers - Advanced: XML and JSON Examples
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Response Example |
|
|
Anchor | ||||
---|---|---|---|---|
|
Trigger Task(s) (Trigger Now)
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 | |
Example Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Trigger Task(s) (Trigger Now): XML and JSON Examples
Examples | XML | JSON | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request Example |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Example |
|
|
Anchor | ||||
---|---|---|---|---|
|
Trigger Task(s) (Trigger Now): Request Properties
Property | UI Field Name | Description | Specifications | Required | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||||
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 | N (Y if | |||||||||
name | Name | Name of the trigger to trigger the task. | Y | |||||||||
overrideDate | Date | Date of the override execution. | YYY-MM-DD | N (Y if overrrideTriggerDateTime is true.) | ||||||||
overrideTime | Time | Time of the override execution. | HH:MM | N (Y if overrrideTriggerDateTime is true.) | ||||||||
overrideTimeZone | Time Zone | Time zone of the override execution. | N (Y if overrrideTriggerDateTime is true.) | |||||||||
overrideTriggerDateTime | Override Trigger Date/Time | Specification for whether to enable or disable override functionality. | Boolean; Valid values: true/false. Default is false. | N | ||||||||
timeZone | Time Zone | Time zone in which task is triggered. | N | |||||||||
variables | n/a |
| N | |||||||||
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 | ||||||||
virtual-resources | n/a |
| The virtual resource dependencies specified in
| N |
Anchor | ||||
---|---|---|---|---|
|
Trigger Task(s) (Trigger Now): Request Variable Properties
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
name | Name | Name used within the Controller to identify this variable. | Maximum 40 alphanumerics. | Y | ||||||
value | Value | Value of the variable. | Y |
Anchor | ||||
---|---|---|---|---|
|
Trigger Task(s) (Trigger Now): Request Virtual Resource Properties
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
limit | Resource Limit | Maximum number of units available for this resource. | Integer; Valid values: 1-20. | N | ||||||
name | Resource Name | Name used within the Controller to identify this virtual resource. | Maximum 40 alphanumerics. | Y |
Anchor | ||||
---|---|---|---|---|
|
Unassign an Execution User from a Trigger
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 | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Unassign an Execution User from a Trigger: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this trigger. | Y |
| |
| Name used within the Controller to identify this trigger. | Maximum 40 alphanumerics. | Y |
|
...