Automation Services Application Program Interface › $REDBAPI SERVICE=DELETE

$REDBAPI SERVICE=DELETE

This API procedure function call deletes an EventView rule set or message rule definition from the knowledge base.

Syntax

This API procedure function call has the following format:

$REDBAPI SERVICE=DELETE
        [NAME=rule-object-name]
         CLASS=cc
         RULESET=ruleset-name

Operands

This API procedure function call has the following operands:

SERVICE=DELETE

Specifies that a definition is to be deleted from the knowledge base.

NAME=rule-object-name

Specifies the object name of the message rule definition to be deleted.

The name is contained in the &ZRENAME variable returned by a previous $REDBAPI SERVICE=CREATE call.

This operand is not required if you are deleting a rule set.

CLASS=cc

Specifies the two-digit identifier of the EventView class to which the definition belongs.

93

Specifies the rule set class.

94

Specifies the message rule class.

RULESET=ruleset-name

Specifies the name of the rule set to be deleted or the name of the rule set that owns the message rule is to be deleted.

When you delete a rule set, you also delete the rules it owns.

Return Variable

This API procedure function call returns the following variable:

&SYSMSG

Contains the returned message.

Return Codes

Return codes indicate the success or failure of processing. This API procedure function call returns the following return codes in the &RETCODE variable:

0

Indicates that processing was successful.

8

Indicates that processing failed.

16

Indicates that error occurred in the call syntax.

Example: Delete a Rule Set

This example deletes the SUPP rule set (class 93):

&CALL PROC=$REDBAPI +
      PARMS=(SERVICE=DELETE,+
             CLASS=93,+
             RULESET=SUPP)