Trigger API
This page describes the TriggerAPI class.
TriggerAPI
Class that allows for interacting with triggers via API.
Attributes:
| Name | Type | Description |
|---|---|---|
client |
object
|
client for sending requests to Typhoon Test Hub API |
start(trigger_id, parameters=None)
Start an event trigger with the provided trigger identifier.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
trigger_id |
int
|
Identifier of event trigger |
required |
parameters |
dict
|
Dictionary with trigger parameters; should be left undefined if trigger has no parameters; if the trigger has parameters, it should contain pairs parameter_name: parameter_value |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
identifier |
int
|
Identifier of the started Execution |
Raises:
| Type | Description |
|---|---|
APIException
|
Response status code not 200 |