Skip to main content

system.kanoa.quality.config.addAlertGroup

Requires kanoaQDS license

Description

Adds a new alert group.

Syntax

addAlertGroup(grpInfo, userId)

Parameters:
  • grpInfo (dict): Dictionary containing alert group info
  • userId (int): User ID

    • Returns:
  • alertGroupId (int): ID of the newly added alert group

    • Dictionary

    ParameterTypeRequiredNotes
    alertGroupNamestringe.g. 'Quality'
    emailListlist[string]e.g. ['quality@kanoa.com', 'operations@kanoa.com']
    enabledboole.g. True

    Code Examples​

    # Usage example
    group_info = {'alertGroupName': 'Quality', 'emailList': ['quality@kanoa.com', 'operations@kanoa.com'], 'enabled': True}
    new_alert_group_id = system.kanoa.quality.config.addAlertGroup(grpInfo=group_info, userId=123)

    if new_alert_group_id is not None:
        print(f"Successfully added alert group with ID: {new_alert_group_id}")