Test the CICS catalog manager service

You can test that your newly created inquireSingle service is working by invoking the supplied catalog API directly from z/OS® Connect API toolkit by using the Try it out! function in the Swagger UI that is embedded in the editor.

Procedure

  1. Start CICS® and ensure that the TCPIPService is open.
  2. Start your IBM® z/OS Connect server. For more information, see Starting and stopping IBM z/OS Connect.
    1. Check the messages.log file for the following messages that confirm that the services are installed.
          BAQR7043I: z/OS Connect service archive placeOrder installed successfully.    
          BAQR7043I: z/OS Connect service archive inquireSingle installed successfully. 
          BAQR7043I: z/OS Connect service archive inquireCatalog installed successfully.
      
    2. Check the messages.log file for the following messages that confirm that the API is installed.
          BAQR7000I: z/OS Connect API archive file catalog installed successfully.
      
  3. In the z/OS Connect Servers view under the APIs folder, double-click on the catalog API.
    The API is opened in the Swagger UI.
  4. Click List Operations to see available operations in the API.
    Figure 1. Operations in the API
    List of operations in the API.
  5. Test inquiring on an item by clicking GET /items/{itemID} .
    1. Specify a value of 10 for the itemID.
      Figure 2. Testing the GET request
      List of operations in the API.
    2. Click Try it out!.
      Information about the request URL, request headers, response body, response code, and response headers are provided. The response body contains the output message:
      • "CA_SNGL_DESCRIPTION": "Ball Pens Black 24pk"

Results

You have verified that your newly created inquireSingle service works to CICS.

What to do next

Follow the steps in Create an API to invoke the CICS catalog manager services to see how to create an API for yourself.