Message: RuleResult

File: WebAPI/rules_1.proto

Description

Server rule (alert) messages.

Note: All optional fields may be missing (e.g., in the case of RESULT_CODE_DISCONNECTED status). Use the request_id field to identify corresponding request.

Request: RuleRequest

Used in

ServerMsg

Fields

request_id

Type: string

Description: ID of a corresponding request or subscription.

result_code

Type: uint32

Description: Operation status. This field is associated with ResultCode enum.

details

Type: shared_1.Text

Description: Operation details.

set_rule_result

Type: SetRuleResult

Description: Result of set rule operation.

modify_rule_result

Type: ModifyRuleResult

Description: Result of rule modification operation.

delete_rule_result

Type: DeleteRuleResult

Description: Result of delete rule operation.

rule_list_result

Type: RuleListResult

Description: Result of rule list request.

rule_event_history_result

Type: RuleEventHistoryResult

Description: Result of rule event history request.

rule_event_subscription_status

Type: RuleEventSubscriptionStatus

Description: Result/updates for rule events subscription.

create_or_modify_destination_group_result

Type: CreateOrModifyDestinationGroupResult

Description: Result of create or modify destination group operation.

destination_group_list_result

Type: DestinationGroupListResult

Description: Result of list destination groups request.

update_destination_expiration_time_result

Type: UpdateDestinationExpirationTimeResult

Description: Result of update destination expiration time operation.

Enum ResultCode

Values

      RESULT_CODE_SUCCESS = 0

      RESULT_CODE_SUBSCRIBED = 1

     Request is processed and subscription is established.

      RESULT_CODE_DROPPED = 2

     The subscription is dropped by the client.

      RESULT_CODE_UPDATE = 3

     Unsolicited information update because of subscription.

      RESULT_CODE_DISCONNECTED = 4

     Some problem with a subscription has happened and updates will not be sent. Clients should not resubscribe in this case: they will receive new RuleResult message with RESULT_CODE_SUBSCRIBED code as soon as the problem is fixed.

      RESULT_CODE_FAILURE = 101

     General failure.