Skip to main content

Create Event Preset

Description​

Creates event preset via the web service.

Function Signature:​

def create_event_preset(ws_config: WebServiceConfig, device_id: int, event_type: str, event_preset_name: str, agent_type: str, event_parameters: EventArgs, priority: int = 1, max_attempts: int = 5, expiration_epoch: int = 0, device_group_id: int = 0) -> EventPresetResult:

Parameters​

  • ws_config (WebServiceConfig): Configuration for the web service connection.
  • device_id (int): Device identifier.
  • event_type (str): Event type name.
  • event_preset_name (str): Event preset name.
  • agent_type (str): Agent type name.
  • event_parameters (EventArgs): Event parameters payload.
  • priority (int): Priority value.
  • max_attempts (int): Maximum attempt count.
  • expiration_epoch (int): Expiration timestamp (Unix epoch seconds).
  • device_group_id (int): Device group identifier.

Returns​

  • EventPresetResult: A result object containing:
    • code: HTTP status code (200 for success, -1 for exceptions).
    • description: Response body or error message.
    • event_preset: Parsed response data when available.

Example Usage​

# Example usage
ws_config = WebServiceConfig(access_key="key", secret_key="secret", base_url="https://api.example.com/")
device_id = 1
event_type = "example"
event_preset_name = "example"
agent_type = "example"
event_parameters = None
priority = 1
max_attempts = 1
expiration_epoch = 1
device_group_id = 1
result = create_event_preset(ws_config, device_id, event_type, event_preset_name, agent_type, event_parameters, priority, max_attempts, expiration_epoch, device_group_id)
print(result)

Behavior​

  • Sends a signed request to the web service.
  • On success (code 200), response data is parsed into the result object.
  • On success, returns the computed value or result object.

Error Handling​

  • Exceptions set the result code to -1 and include an error message when implemented.