Define the GET operation for the /phonebook/contacts/{lastName} path

How to define the z/OS® Assets for your API in z/OS Connect Designer.

zosConnect-3.0 Applies to zosConnect-3.0.

Containers Applies to z/OS Connect container deployments.

Paths are endpoints or resources that are exposed by your API, such as /phonebook/contacts/{lastName}. Each resource has one or more operations that are HTTP methods that are used to manipulate these resources. For example, GET, PUT, POST, or DELETE.

The paths are defined by the OpenAPI definition that you imported in the task Starting the z/OS Connect Designer with Docker and importing an OpenAPI definition. In the z/OS Connect Designer, the available operations appear in Paths in the navigation panel.

Figure 1. The API projects Paths page z/OS Connect Designer
Screen capture to show the API projects Paths page in z/OS Connect Designer for the imported OpenAPI document.

You create z/OS Assets to configure the relationship between your API request and the endpoint. For example, you create a z/OS Asset that is called phonebook that uses the GET /phonebook/contacts/{lastName} operation to retrieve information about a specific item from the IMS phonebook sample application.