Using the DFSMSrmm application programming interface

This topic tells you how to use the application programming interface (API) provided by DFSMSrmm (which is a z/OS® feature) to read, extract, and update data in the DFSMSrmm control data set:

From a high level language such as C++ or Java™ and receive the output through structured field introducers (SFIs) or XML
Through Web services and receive the output through SFIs or XML
From assembler language (using EDGXCI) and receive the output by line format or SFI format

You can use the output data to create reports or implement automation.

For details on using C++ or Web services, see these topics:

Use macro EDGXCI as described in EDGXCI: Calling the DFSMSrmm interface to define a parameter list to call the DFSMSrmm application programming interface. Use macro EDGXCI to pass any supported RMM TSO subcommand to DFSMSrmm. See Supported RMM TSO subcommands for a list of supported RMM TSO subcommands. EDGXCI example provides an example you can modify to communicate with the DFSMSrmm application programming interface.

Use macro EDGXSF as described in EDGXSF: Structured field definitions to help you process the data that the DFSMSrmm application programming interface returns. The DFSMSrmm application programming interface returns data as structured fields in an output buffer that you define. Structured fields consist of these parts.

A structured field introducer (SFI) that introduces the type of data, length, and characteristics of the data that the API returns,
Data.

You can request that the API returns data in line format or field format as described in Requesting structured field introducer data format. You can also request standard output or expanded output as described in Requesting types of output.

To use the DFSMSrmm application programming interface, you must have High Level Assembler installed on your system. z/OS Planning for Installation provides information about the level of High Level Assembler required for DFSMS.