Trigger Web Services
Overview
Universal Controller supports the following RESTful-based web services for Trigger operations.
Formatting specifications for each web service, including details about parameter requirements, are provided.
Common Web Services
The following web services are common to multiple Trigger types:
- Assign an Execution User to a Trigger
- Delete a Trigger
- Enable/Disable a Trigger
- List Triggers
- List Triggers - Advanced
- Set Skip Count
- Trigger Task(s) (Trigger Now)
- Unassign an Execution User from a Trigger
Detailed information for each of these web services is provided on this page.
Trigger-Specific Web Services
The following web services are specific to each Trigger type:
- Create a Trigger
- List Trigger Qualifying Times (Cron and Time Triggers only)
- Modify a Trigger
- Modify Time of Time Trigger (Time Trigger only)
- Read a Trigger
For detail information about these Trigger-specific web services, see:
- 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
- z/OS Monitor Trigger Web Services
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 |
|
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 |
|
Assign an Execution to a Trigger: XML and JSON Request Examples
Examples | XML | JSON |
---|---|---|
Request Example |
Assign an Execution User to a Trigger: Request Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | If the user executing this web service does not have the ops_admin role; Password of the Execution User. | Y | |
| n/a | Name of the Execution User. | Wildcards are supported. | Y |
Delete a Trigger
Description | |
---|---|
URI | http://host_name/uc/resources/trigger |
HTTP Method | DELETE |
Description | Deletes the specified Trigger. |
URI Parameters | |
Authentication | HTTP Basic |
Example URI | |
Example Response |
|
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 |
|
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 |
Enable/Disable a Trigger: XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Request Example | ||
Response Example |
Enable/Disable a Trigger: Request Trigger Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | There are two attributes for this property:
For example: <trigger enable="false" name="uc - 1st Sunday of Month"></trigger> | Y |
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 |
List Triggers: XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Request Example | ||
Response Example |
List Triggers: Request Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Description | Filter the trigger list using the description. | Wildcards 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. | Wildcards 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:
| N |
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 |
List Triggers - Advanced: URI Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Member of Business Services | Business Services that this trigger belongs to. | ||
| Description | Filter the trigger list using the description. | Wildcards 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. | Wildcards 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:
|
List Triggers - Advanced: XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Response Example |
Set Skip Count
Description | |
---|---|
URI | http://host_name:port/uc/resources/trigger/setskipcount http://host_name:port/uc/resources/trigger/setSkipCount |
HTTP Method | POST |
Description | Sets the skip count for a specific trigger. Temporary Triggers and Manual Triggers do not support Skip Count. Therefore, the Set Skip Count API is not applicable for Temporary Triggers and Manual Triggers. |
Example URI | http://localhost:8080/uc/resources/trigger/setskipcount?triggername=time-1&skipCount=10 |
Authentication | HTTP Basic |
Produces Content-Type | Application/XML, Application/JSON |
Consumes Content-Type | Application/XML, Application/JSON |
Example Responses |
|
Set Skip Count: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Name used within the Controller to identify this trigger. | Maximum 40 alphanumerics. | Y |
|
| Unique ID for this trigger. | Y |
| |
| Skip count to set. | Default is 0. | N |
Set Skip Count: XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Response Example |
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 |
Trigger Task(s) (Trigger Now): XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Request Example | ||
Response Example |
Trigger Task(s) (Trigger Now): Request Properties
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 |
| 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 of the trigger to trigger the task. | Y | |
| Date | Date of the override execution. | YYY-MM-DD | N (Y if overrrideTriggerDateTime is true.) |
| Time | Time of the override execution. | HH:MM | N (Y if overrrideTriggerDateTime is true.) |
| Time Zone | Time zone of the override execution. | N (Y if overrrideTriggerDateTime is true.) | |
| Override Trigger Date/Time | Specification for whether to enable or disable override functionality. | Boolean; Valid values: true/false. Default is false. | N |
| Simulate | Specifies if the workflow should execute under simulation mode. You can only enable simulation mode with the Trigger Now command, you cannot disable it if it is already enabled on the Trigger Record. | Boolean; Valid values: true/false. Default is false. | N |
| Time Zone | Time zone in which task is triggered. | N | |
| n/a | <variables> <variable> <name>testVariable</name> <value>Hello</value> </variable> </variables> | N | |
| Vertex Selection | Specifies Root Vertices and/or Specific Vertices to be included in the triggered workflow. A vertex can be specified by If you specify a To indicate a vertex selection is a Root Vertex, set the vertex root attribute to true. If vertex root attribute is unspecified or false, it indicates a vertex selection is a Specific Vertex. Duplicate vertex specifications are ignored and do not prevent the operation from completing. | XML
JSON
| N |
| 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 |
| n/a | <virtual-resources> <virtual-resource> <name>uc - Solo</name> <limit>2</limit> </virtual-resource> </virtual-resources> | The virtual resource dependencies specified in
| N |
Trigger Task(s) (Trigger Now): Request Variable Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Name | Name used within the Controller to identify this variable. | Maximum 40 alphanumerics. | Y |
| Value | Value of the variable. | Y |
Trigger Task(s) (Trigger Now): Request Virtual Resource Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Resource Limit | Maximum number of units available for this resource. | Integer; Valid values: 1-20. | N |
| Resource Name | Name used within the Controller to identify this virtual resource. | Maximum 40 alphanumerics. | Y |
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 |
|
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 |
|