Defining responses for an operation

Responses define the HTTP status code and data returned in a response body and headers. A response defined for an operation is one that can returned by executing the operation.

About this task

Note: This task relates to configuring an OpenAPI 2.0 API definition. For details on how to configure an OpenAPI 3.0 API definition, see Editing an OpenAPI 3.0 API definition.

You can complete this task either by using the API Designer UI application, or by using the browser-based API Manager UI.

At any time, you can switch directly to the underlying OpenAPI YAML source by clicking the Source icon OpenAPI Source icon. To return to the design form, click the Form icon Form icon.


  1. Open the API for editing, as described in Editing an OpenAPI 2.0 API definition.
  2. Expand Paths, then expand the required Path.
  3. Expand Operations, expand the required operation, then, if there are any existing responses, expand Responses.
  4. You can either create a new response, or edit any existing response.
    • To create a response, click the add icon OpenAPI 2.0 API add icon alongside Responses, then refer to Creating a response.
    • To edit an existing response, click the response name in the navigation pane, then refer to Editing a response.