...
The following web services are common to all Trigger types:
- Assign an Execution User to a Trigger
- Delete a Trigger
- Enable/Disable a Trigger
- List Triggers
- List Triggers - Advanced438089585
- 438089585
- 438089585
- 438089585
- 438089585
- Trigger Task(s) (Trigger Now)
- Unassign an Execution User from a Trigger438089585
Detailed information for each of these web services is provided on this page.
...
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 |
|
...
Examples | XML | JSON | |||||||
---|---|---|---|---|---|---|---|---|---|
Request Example |
|
...
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 |
|
...
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 | ||||
---|---|---|---|---|
|
...
Examples | XML | JSON | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request Example |
| |||||||||||||||
Response Example |
|
|
...
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 | ||||
---|---|---|---|---|
|
...
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 | ||||
---|---|---|---|---|
|
...
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 | ||||
---|---|---|---|---|
|
...
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 | ||||||||
| Simulate | Specifies if the workflow should execute under simulation mode. | Boolean; Valid values: true/false. Default is false. | N | ||||||||
timeZone | Time Zone | Time zone in which task is triggered. | N | |||||||||
variables | n/a |
| 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 | ||||||||
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 |
...
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 |
|
...