Structure of applications that access the IMS catalog API

Your applications that use the IMS catalog API must use a certain general structure.

An application that uses the IMS catalog API has the following general structure:

  1. Include the API DSECTs. (DFS3CATQ FUNC=DSECT)

  2. Optionally, acquire the high-level qualifier (HLQ) of the boot strap data set (BSDS), only if the application is not aware of it.
    Note: The HLQ is to be provided before the DFS3CATQ FUNC=OPEN request is used. If the application is already aware of the HLQ of the BSDS, then it is to be provided on the DFS3CATQ FUNC=OPEN request.
  3. Allocate and open the BSDS data set and directory data sets. (DFS3CATQ FUNC=OPEN)
  4. Request information from the IMS catalog by using one or more of either of the following actions:
    • Request a list of object names that match a specified name and type. (DFS3CATQ FUNC=LIST)
    • Request information about the definition of a specified catalog object by specifying the object name and type. (DFS3CATQ FUNC=GET)
  5. Release data sets that were allocated by the open request. (DFS3CATQ FUNC=CLOSE)