Automation Services Application Program Interface › $REDBAPI SERVICE=GET

$REDBAPI SERVICE=GET

This API procedure function call retrieves information about an EventView rule set or message rule definition in the knowledge base.

If you make this call from an NCL procedure, ensure that you share the &ZRE-prefixed variables, for example, by adding the following statement before the call:

&CONTROL SHRVARS=(ZRE)

Syntax

This API procedure function call has the following format:

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

Operands

This API procedure function call has the following operands:

SERVICE=GET

Specifies that information about a definition is to be retrieved from the knowledge base.

NAME=rule-object-name

Specifies the object name of the message rule definition for which information is to be retrieved.

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

This operand is not required if you are retrieving information about a rule set definition.

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 for which information is to be retrieved or the name of the rule set that owns the message rule for which information is to be retrieved.

Return Variables

This API procedure function call returns the following variables:

&SYSMSG

Contains the returned message.

&ZREfield-name

Contain the returned knowledge base information about the specified rule set or rule.

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: Retrieve Information About a Message Rule

This example retrieves information about a message rule (class 94) previously created in the SUPP rule set:

&CALL PROC=$REDBAPI PARMS=(SERVICE=CREATE,…)
…
&JAA992I=&ZRENAME
…
&CALL PROC=$REDBAPI +
      SHARE=(ZRE>) +
      PARMS=(SERVICE=GET,+
             NAME=&JAA992I,+
             CLASS=94,+
             RULESET=SUPP)

More information:

EventView Definition Field Names