Editing a response

Responses define the HTTP status code and data returned in a response body and headers. You can edit responses that have been previously created for Path operations in your API definition.

Before you begin

Open the details form for a response. For details of the areas in your API definition from where you can edit a response, see the following topics:

About this task

  • This task relates to configuring an OpenAPI 3.0 API definition. For details on how to configure an OpenAPI 2.0 API definition, see Editing an OpenAPI 2.0 API definition.
  • OpenAPI 3.0 APIs are supported only with the DataPower® API Gateway, not with the DataPower Gateway (v5 compatible).
  • For details of current OpenAPI 3.0 support limitations, see OpenAPI 3.0 support in IBM® API Connect.

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. Provide the following information:
    • Response name: A name for the response.

      If you are editing an operation response, this name is the HTTP status code.

      If you are editing a response component, this name defines a key that enables this response to be referenced from elsewhere in the API definition; the reference has the following format:

      To change the name, click Update, then click Save when done.

    • Description: A description of the response. You can use CommonMark syntax for rich text representation.
    • Headers: Headers define information that can be returned in the response.

      To define a new header for the response, click Add, then refer to Creating a header.

      To edit an existing header, click the header name, then refer to Editing a header.

    • Content: A content definition describes the content of the response.

      To define a new content definition for the response, click Add, then refer to Creating a content definition.

      To edit an existing content definition, click the content definition name, then refer to Editing a content definition.

    • Links: Links describe how various values returned by one operation can be used as input for other operations.

      To define a new link for the response, click Add, then refer to Creating a link.

      To edit an existing link, click the link name, then refer to Editing a link.

  2. Click Save when done.

What to do next

If required, use the breadcrumb trail to navigate to another location in the hierarchy of the object you are working on.