GlobalEventRules.Rulesets.Rules

Overview

Available Operations

• list - List Ruleset Rules

• create - Create Rule

• get_by_id - Get Rule by ID

• update_by_id - Update Rule by ID

• reorder - Reorder Ruleset By Index

list

Get all rules of a GER Ruleset.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.global_event_rules.rulesets.rules.list(ger_id=894010, alert_source_version="<value>", alert_source_shortname="<value>")

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
ger_id	int	✔️	N/A
alert_source_version	str	✔️	N/A
alert_source_shortname	str	✔️	N/A
page_size	Optional[int]	➖	N/A
page_number	Optional[int]	➖	N/A
filters_search	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.GlobalEventRulesListRulesetRulesResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

create

Create a GER Ruleset Rule.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.global_event_rules.rulesets.rules.create(ger_id=934313, alert_source_version="<value>", alert_source_shortname="<value>", description="ha newsprint within beside scientific", expression="<value>", action={
        "route_to": "<value>",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
ger_id	int	✔️	N/A
alert_source_version	str	✔️	N/A
alert_source_shortname	str	✔️	N/A
description	str	✔️	N/A
expression	str	✔️	N/A
action	models.V3GlobalEventRulesRuleAction	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.GlobalEventRulesCreateRuleResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

get_by_id

Get a GER Ruleset Rule by its ID.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.global_event_rules.rulesets.rules.get_by_id(ger_id=518804, alert_source_version="<value>", alert_source_shortname="<value>", rule_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
ger_id	int	✔️	N/A
alert_source_version	str	✔️	N/A
alert_source_shortname	str	✔️	N/A
rule_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.GlobalEventRulesGetRuleByIDResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update_by_id

Update a GER Ruleset Rule by its ID.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.global_event_rules.rulesets.rules.update_by_id(ger_id=140241, alert_source_version="<value>", alert_source_shortname="<value>", rule_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
ger_id	int	✔️	N/A
alert_source_version	str	✔️	N/A
alert_source_shortname	str	✔️	N/A
rule_id	str	✔️	N/A
description	Optional[str]	➖	N/A
expression	Optional[str]	➖	N/A
action	Optional[models.V3GlobalEventRulesRuleActionUpdate]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.GlobalEventRulesUpdateRuleByIDResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

reorder

Reorder a GER Ruleset Rule by its index in the ruleset.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.global_event_rules.rulesets.rules.reorder(ger_id=281260, alert_source_version="<value>", alert_source_shortname="<value>", rule_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
ger_id	int	✔️	N/A
alert_source_version	str	✔️	N/A
alert_source_shortname	str	✔️	N/A
rule_id	str	✔️	N/A
shift_to	Optional[str]	➖	N/A
shift_index_by	Optional[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.GlobalEventRulesReorderRulesetByIndexResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*