Skip to content

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
Source code in tth\api\trigger.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class TriggerAPI:
    """
   Class that allows for interacting with triggers via API.

   Attributes:
       client (object): client for sending requests to Typhoon Test Hub API
   """

    def __init__(self, client):
        self.client = client

    def start(self, trigger_id, parameters=None):
        """
        Start an event trigger with the provided trigger identifier.

        Args:
            trigger_id (int): Identifier of event trigger
            parameters (dict, optional): 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

        Returns:
            identifier (int): Identifier of the started Execution

        Raises:
            APIException: Response status code not 200
        """
        if parameters is None:
            parameters = []
        else:
            parameters = [{'name': key, 'value': value} for key, value in parameters.items()]

        parameters = {'parameters': parameters}
        response = requests.post(f"{self.client.url}/api/triggers/start/{str(trigger_id)}",
                                 headers=self.client.get_request_headers(), json=parameters)
        if response.status_code == 201:
            execution_id = response.json()
            return int(execution_id)
        else:
            raise APIException(response)

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
Source code in tth\api\trigger.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def start(self, trigger_id, parameters=None):
    """
    Start an event trigger with the provided trigger identifier.

    Args:
        trigger_id (int): Identifier of event trigger
        parameters (dict, optional): 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

    Returns:
        identifier (int): Identifier of the started Execution

    Raises:
        APIException: Response status code not 200
    """
    if parameters is None:
        parameters = []
    else:
        parameters = [{'name': key, 'value': value} for key, value in parameters.items()]

    parameters = {'parameters': parameters}
    response = requests.post(f"{self.client.url}/api/triggers/start/{str(trigger_id)}",
                             headers=self.client.get_request_headers(), json=parameters)
    if response.status_code == 201:
        execution_id = response.json()
        return int(execution_id)
    else:
        raise APIException(response)