Automation Services Application Program Interface › Application Programming Interface Procedures › $RMCALL API

$RMCALL API

The $RMCALL API procedure calls Automation Services from external sources.

This API procedure has the following general format:

$RMCALL OPT=SERVICE
        SERVICE=ACTION
        ACTION=[COMMAND | DBGET | PURGE | STGET]
       [ACBNAME=acb-name]
       [NAME=resource-name]
       [CLASS=cc]
       [SYSNAME=system-name]
       [VERSION=version]
       [COMMAND=command-name]
       [SYNC={YES | NO | NOTIFY}]
       [NCLID=ncl-id]
       [PARMS={‘parm1=value1 parm2=value2 parm3=value3 ...’}]

You must specify the OPT=SERVICE and SERVICE=ACTION operands as shown. The ACTION operand is used to specify the function that the procedure performs. The remaining operands may be optional depending on the function being performed. Operands for each function are discussed in the section that describes the function.

If you code multiple values for an operand (for example, the PARMS operand), separate the parameters with spaces and enclose them in quotation marks.

More information:

$RMCALL ACTION=COMMAND

$RMCALL ACTION=DBGET

$RMCALL ACTION=PURGE

$RMCALL ACTION=STGET