Map the API Request to the z/OS Asset

How to map the API request to the z/OS Asset.

Before you begin

The following tasks must be completed:
  1. Prepare the sample CICS application.
  2. Starting the z/OS Connect Designer with Docker Desktop and importing an OpenAPI definition.
  3. Configure IPIC connections to CICS with Docker Desktop and Basic Authentication.
  4. Create the catalogProgram z/OS Asset.

About this task

This topic is applicable to: z/OS Connect Designer
capability Content applicable to
application developers

In the previous procedure, you created the catalogProgram z/OS Asset. In this task, you map parameters in the API request to fields in the z/OS Asset Request.


  1. Open the GET /items Operation flow diagram.
    Expand the /items path in the navigation tree and click GET. The GET /items operation is displayed .
  2. Click the API Request node in the Operation flow diagram.
    The API request structure displays the parameters and the body of the request that are expanded by default.

    Within Parameters, there is a single parameter that is called startItemId as defined in the OpenAPI definition. Click Down arrow to expand and see more details about this parameter.

    Figure 1. Viewing the API request parameters.
    Viewing the API request parameters.
  3. Click the catalogProgram z/OS Asset node in the Operation flow diagram. The z/OS Asset configuration window opens.
    Figure 2. Open the z/OS Asset node
    Open the z/OS Asset node
    1. Input 01INQC into the CA-REQUEST-ID field

      This is the value that is required by the CICS Catalog Manager application to perform an inquiry on multiple catalog items.

      Figure 3. Input into the CA-REQUEST-ID field.
      Input into the CA-REQUEST-ID field.
    2. Map the API Request parameter startItemID into the CA-LIST-START-REF z/OS Asset Request field.

      Type startItemID in the CA-LIST-START-REF field. When you start typing, the Available Mappings menu opens with the available parameters. Select startItemID from the list.

      Figure 4. Mapping the startItemID API Request parameter.
      Mapping the startItemID API Request parameter.

      You do not have to type the parameter names. To the right of each text box are two icons:
      • Click Insert a mapping icon to select a Path parameter from the list. When the list opens, be sure that you look in the correct group.
      • Click Insert a function icon to insert a function. Functions are not used in this tutorial. For more information, see Mapping your API and z/OS Assets.
  4. Optional: Review other information about this request within the catalogProgram window.
    1. Click View structure to see the request schema.
    2. Click Response to view the response schema.
    3. Click z/OS Asset details to view the z/OS Asset configuration details.


The API request parameters are successfully mapped to the fields in the z/OS Asset.

What to do next

Define the GET /items responses.