Mapping the GET Request for Multiple Responses

Use the single copybook, CATLG, to map the request. One request will be made, so it will be based on the Product Description field. The Product Description will return multiple records. The table EXMPCATA uses an alternate index using the Product Description as the key.

  1. In the API Editor select the Mapping button. Select Open Both Mappings. The Request and Response tabs will display.

    A menu displays when the user selects the Mapping button. An arrow hovers over the Open Both Mappings selection.

    Figure 326. CATLGM Open both mappings
  2. Select the Request tab.

    Two tabs display, Request and Response Mapping

    Figure 327. Request and Response Mapping
  3. Expand DK1APIC1-Con to display the whole copybook.
  4. Select the IN_API_KEY field in the copybook.
    1. Right-click to select Add Assign transform.

      A menu displays. An arrow hovers ovr the Add Assign Transform selection

      Figure 328. Add Assign Transform
    2. In the Properties Panel enter the value API002. A box displays next to the field marking it as Assigned.

      Assign IN_API_KEY displays the IN_API_KEY marked as assigned. The properties panel shows the Value API002.

      Figure 329. Assign IN_API_KEY
  5. Select the IN_TABLE_NAME field in the copybook.
    1. Right-click to select Add Assign transform.
    2. In the Properties Panel enter the table name with an alternate index . A box displays next to the field marking it as Assigned.

      CATLGM Assign IN_TABLE_NAME

      Figure 330. Assign IN_TABLE_NAME
  6. Select the IN_VTS_NAME field in the copybook.
    1. Right-click to select Add Assign transform.
    2. In the Properties Window enter the name of the VTS-TSR, VTS2. A box displays next to the field marking it as Assigned.

      Assign-VTS-Name

      Figure 331. Assign VTS Name
  7. Select the following fields in the WS_ROW_HEADER section:
    • OUT_TOTAL_RECS
    • OUT_RECS_THIS_CALL
    • OUT_REC_SIZE
    • OUT_ERROR_CODE
    • OUT_ERROR_SUB_CODE
    • OUT_RESPONSE_MESSAGE
    • OUT_FILLER
  8. Right-click to select Add Remove Transform. A box displays next to the field marking it as Removed.

    Request Add Remove Transform displays fields listed marked as removed

    Figure 332. Request Add Remove Transform
  9. Select the following fields associated with the request in the WS_ROW_DATA section:
    • CA_ITEM_REF
    • CA_DEPARTMENT
    • CA_COST
    • CA_STOCK
    • IN_STOCK
    • ON_ORDER
  10. Select Add Remove Transform. A box displays next to each field marking it as Removed.
  11. In the HTTP Request section, select item-desc listed as a Path Parameter. Drag it to the field in the WS_ROW_DATA section associated with the request, CA_DESCRIPTION. A box displays Move between the Path Parameter and the Request field.

    Path Parameter item-desc is shown as moved to CA_DESCRIPTION

    Figure 333. Path Parameter item-desc
  12. Define the Query Parameters:
    1. Right-click to select the Query Parameters field in the HTTP Request section.
    2. Select Add Query Parameter. The Add Query Parameter Window will display.
    3. Enter LIMIT in the Parameter Name field.
    4. Select Integer for the Parameter type.

      LIMIT Query Parameter

      Figure 334. LIMIT Query Parameter
    5. Select the OK button. The Add Query Parameter window will close.
    6. Repeat steps 12a through 12e for the OFFSET query Parameter name.

      OFFSET Query Parameter

      Figure 335. OFFSET Query Parameter
  13. Select the LIMIT Query Parameter and drag it to the IN_LIMIT field on the CATLGMOperation.
  14. Select the OFFSET Query Parameter and drag it to the IN_OFFSET field on the CATLGMOperation.

    The limit and offset Query Parameters assigned.

    Figure 336. Query Parameters assigned
Note:
The IN_TABLE_NAME and IN_VTS_NAME fields can also be supplied as query parameters.