About REST Responses
When you select
Responses for an operation,
Designer displays the HTTP response code and the extensions. Each status code of the REST response contains the response body, response headers, and response links.
A REST response is a possible response that a client can expect when invoking an operation in the REST API Descriptor (RAD). A REST response contains its HTTP status code and the data to be returned in the response body and/or headers. When you create a consumer RAD using an OpenAPI document, Designer creates the responses for each operation. Each operation in the Designer contains at least one response to a successful operation.
REST response body details
Response Body
The response body specifies the status code along with the description and the response content details. Designer specifies the response contents as:
Name: Supported media type for the operation.
Type: Specifies the data type.
Constraints: Indicates the composed keywords used to validate the schema for the response body.
Headers
The response headers contain the
Name,
Type,
Source, and
Required headers as defined in the REST response. For descriptions, see
Parameters.
You can also click
to view the additional header details, for example,
Media type,
Style,
Extensions, and
Constraints.
Links
The response links specify the list of the parameters used in the operation which can be used as input parameters for another operation. The response links contain the following details:
Name: Parameter name with a link.
Operation: Operation name that uses the parameter.
Description: Details of the parameter.
Designer specifies the additional supported functionalities under Extensions.
