|
|
|
This API procedure function call lists EventView rule set or message rule definitions in the knowledge base.
If you make this call from an NCL procedure, ensure that you add the following statement before the call:
&CONTROL SHRVARS=(ZRELST)
Syntax
This API procedure function call has the following format:
$REDBAPI SERVICE=LIST
CLASS=cc
[RULESET=ruleset-name]
[RULEID=message-rule-id]
Operands
This API procedure function call has the following operands:
Specifies that selected definitions in the knowledge base are to be listed in &ZRELSTnnnn variables.
Specifies the two-digit identifier of the EventView class to which the definition belongs.
Specifies the rule set class.
Specifies the message rule class.
Specifies the rule sets to be listed, or specifies the name of the rule set that owns the message rules to be listed.
If you are listing rule sets, the value is generic. For example, if RULESET=SUP, then rule sets with names that start with SUP are matched.
Specifies the IDs of the message rules to list.
The ID is the first word of the message text.
The value is generic. For example, if RULEID=JBB1, then message rules with a first word that starts with JBB1 are matched.
Return Variables
This API procedure function call returns the following variables:
Contains the returned message.
Contain the returned knowledge base definition entries.
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:
Indicates that processing was successful.
Indicates that processing failed.
Indicates that error occurred in the call syntax.
Example: List Rule Sets
This example retrieves the list of all rule sets:
&CALL PROC=$REDBAPI + SHARE=(ZRELST>) + PARMS=(SERVICE=LIST,+ CLASS=93)
| Copyright © 2011 CA. All rights reserved. | Tell Technical Publications how we can improve this information |