ApiResponse
Specification of expected response parameters and schemas associated with an HTTP status code or status code range.
{
"content_type_mappings": [
{
"content_type": "string",
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}
],
"description": "string",
"response_header_parameters": [
{
"allow_empty_value": false,
"deprecated": false,
"name": "string",
"required": false,
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}
],
"status_code": {
"match_criteria": "string",
"ranges": [
{
"begin": 0,
"end": 0
}
],
"status_codes": [
0
]
},
"unknown_content_type_action": "string"
}Mapping of response content types to their corresponding schemas. Field introduced in 32.1.4. Maximum of 128 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Description of the response from the OpenAPI specification. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Response header parameter definitions for this status code. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Action to take when the response body's content type is not defined for this status code. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.