/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}

GET

Gets an IntegrationResponses.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v2/apis//integrations//integrationresponses/'

Response Example

200 - Example 1

{
  "ContentHandlingStrategy": "CONVERT_TO_BINARY",
  "IntegrationResponseId": "string",
  "IntegrationResponseKey": "string",
  "ResponseParameters": {},
  "ResponseTemplates": {
    "property1": "string",
    "property2": "string"
  },
  "TemplateSelectionExpression": "string"
}

Request

Path Params

apiId

string

required

The API identifier.

integrationId

string

required

The integration ID.

integrationResponseId

string

required

The integration response ID.

Responses

🟢200Success

application/json

Body

ContentHandlingStrategy

enum<string>

optional

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Allowed values:

CONVERT_TO_BINARYCONVERT_TO_TEXT

IntegrationResponseId

string

optional

The integration response ID.

IntegrationResponseKey

string

optional

The integration response key.

ResponseParameters

object

optional

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

ResponseTemplates

object

optional

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

TemplateSelectionExpression

string

optional

The template selection expressions for the integration response.

🟠480NotFoundException

🟠481TooManyRequestsException

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

/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}