Syntax
$REDBAPI |
SERVICE=GET [NAME=rule-object-name] CLASS=cc RULESET=ruleset-name |
Use
Use this call to retrieve 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)
Operands
|
Operand |
Description |
|---|---|
|
SERVICE=GET |
Indicates 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 as follows: 93 for rule sets and 94 for message rules. |
|
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. |
Returned Variables
|
Variable |
Description |
|---|---|
|
&ZREfield-name |
Knowledge base information about the specified rule set or rule is returned in &ZREfield-name variables. |
|
&SYSMSG |
Contains the message returned by $REDBAPI. |
Return Codes
The following return codes indicate the success or failure of the retrieval processing:
|
&RETCODE |
Meaning |
|---|---|
|
0 |
Processing was successful. |
|
8 |
Processing failed. |
|
16 |
Error occurred in call syntax. |
Example
The following 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)