SAP Knowledge Base Article - Public

3308167 - How to handle timeouts in API calls?

Symptom

Timeout is a common error during API calls when a client waits for too long for a response from the server. Timeouts can happen due to various reasons. The common timeout scenarios and how to handle timeouts are listed.

Environment

SAP SuccessFactors HXM Suite

* OData API

Resolution

TypeTimeoutTimeout Error Response
(HTTP Code)
Solution
Session timeout10 minutes (API server)
30 minutes (CF server)
502Retry is possible.
Avoid complex API calls with
large data requests.
    
Gateway timeout7 minutes504Retry gap is 5 minutes.
Avoid complex API calls with
large data requests.
    
Client timeoutClient-specificClient-specificTimeouts that occurs on the
client side are handled by the
client. 

See Also

OData API Best Practices

Keywords

timeout, timeouts, session, client, gateway, 502, 504, API, server, complex, best, practices, OData , KBA , LOD-SF-INT-ODATA , OData API Framework , How To

Product

SAP SuccessFactors HXM Suite 2211