PH65523: Incorrect HTTP status code 500 and response returned when a request times out.

APAR status

• Closed as unreproducible in next release.

Error description

• When an OpenAPI 2 API provider request to CICS times out, the
  HTTP status code returned should be 503 (Service Unavailable),
  but was sometimes set to 500 (Internal Server Error).
  The response payload was also inconsistent, with different
  combinations of the following messages being returned in JSON
  format:
  BAQR0433W: The asynchronous request has timed out after <n>
             milliseconds.
  BAQR7033E: Internal server error.
  
  and/or the following in text format:
  SRVE8025E: An error or timeout occured while doing async servlet
             processing.
  
  Additional search words: msgBAQR0433W msgBAQR0433 BAQR0433W
  BAQR0433 msgBAQR7033E msgBAQR7033 BAQR7033E BAQR7033 SRVE8025E
  msgSRVE8025E SRVE8025 msgSRVE8025
  

Local fix

Problem summary

• ****************************************************************
  * USERS AFFECTED: All users of z/OS Connect V3.0 API providers *
  *                 with features zosConnect-2.0 (OpenAPI 2) or  *
  *                 zosConnect-3.0 (OpenAPI 3).                  *
  ****************************************************************
  * PROBLEM DESCRIPTION: Incorrect HTTP status code 500 and      *
  *                      response returned when a request times  *
  *                      out.                                    *
  ****************************************************************
  For OpenAPI 2 API providers:
  When a request times out, the response code should be HTTP
  status code 503 (Service Unavailable) with the following message
  in JSON format being returned:
  "errorMessage":
  "BAQR0433W: The asynchronous request has timed out after <value>
              milliseconds."
  
  When the timeout is triggered at the same time as the request
  completes, the returned response code could be set to HTTP
  status code to 500 (Internal Server Error) and the response body
  could contain one or two messages related to a timeout or an
  internal server error.
  
  For OpenAPI 2.0 and OpenAPI 3.0 API providers:
  When a timeout expired for an API provider using an IPIC
  connection to CICS, the IPIC connection was sometimes closed
  when it should not have been.
  

Problem conclusion

Temporary fix

Comments

• z/OS Connect has been changed to handle a timeout response
  correctly when it occurs at the same time as the API provider
  request completes. An IPIC connection will not be closed due to
  a timeout expiring.
  
  The fix for this APAR is expected to be delivered by the PTF for
  z/OS Connect V3.0.100.0 (PH69148).
  

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  Z/OS CONNECT EE

• Fixed component ID

  5655CE300

Applicable component levels