/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}

PATCH

Updates a RouteResponse.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v2/apis//routes//routeresponses/' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
  "ModelSelectionExpression": "string",
  "ResponseModels": {
    "property1": "string",
    "property2": "string"
  },
  "ResponseParameters": {
    "property1": {
      "Required": true
    }
  },
  "RouteResponseId": "string",
  "RouteResponseKey": "string"
}

Request

Path Params

apiId

string

required

The API identifier.

routeId

string

required

The route ID.

routeResponseId

string

required

The route response ID.

Body Params application/json

modelSelectionExpression

string

optional

An expression used to extract information at runtime. See Selection Expressions for more information.

responseModels

object

optional

The route models.

Additional properties

string

optional

A string with a length between [1-128].

responseParameters

object

optional

The route parameters.

Additional properties

object (ParameterConstraints)

optional

Validation constraints imposed on parameters of a request (path, query string, headers).

routeResponseKey

string

optional

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

Examples

Responses

🟢200Success

application/json

Body

ModelSelectionExpression

string

optional

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

ResponseModels

object

optional

Represents the response models of a route response.

ResponseParameters

object

optional

Represents the response parameters of a route response.

RouteResponseId

string

optional

Represents the identifier of a route response.

RouteResponseKey

string

optional

Represents the route response key of a route response.

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException

🟠483ConflictException

Modified at 2023-08-15 05:49:07

/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}

/v2/apis/{apiId}/stages/{stageName}/routesettings/{routeKey}