Product Notice: Bulk API – More detailed 500 response and new sync log (May 2020)

Version 2

    Update (April 16, 2020): If attempting to execute a sync with an app service instance id that doesn't exist, there will not be a new sync log message, instead this existing sync log message will be returned: “ELQ-00122: Validation errors found on sync {syncId} for user {userId}. Sync will NOT proceed.”. The product notice has been updated to reflect this.

    Overview

    With the arrival of Eloqua release 20B (May 2020), the Bulk API will return a more detailed 500 response and there will be one new sync log message.

     

    What’s changing?

     

    500 Response

     

    Currently, when the Bulk API returns a 500 error there is no detail provided, with the status of “500 The service has encountered an error.” being the only response.

     

    With 20B, we’ll return a “Retry-After” response header and a response body that includes “error” and “errorSeverity” for some 500 responses. The following are the values for “errorSeverity” and the corresponding “Retry-After” in seconds:

    • 0 : Retry-After: 3600
    • 1 : Retry-After: 1800
    • 2 : Retry-After: 900
    • 3 : Retry-After: 120

     

    List of possible values for “error”:

    • Unable to process request due to a temporary error.
    • Unable to send/retrieve data due to a temporary error.

     

    Example – More Detailed 500 Response

     

    500 The service has encountered an error.

    Retry-After: 120

    {

        "error": "Unable to process request due to a temporary error.",

        "errorSeverity": 3

    }

     

    New Sync Log Message

     

    There will now be sync log messages when a Bulk API sync fails and will be retried.

     

    Example:

     

    {

        "syncUri": "/syncs/2651",

        "count": 0,

        "severity": "information",

        "statusCode": "ELQ-00145",

        "message": "Sync attempt failed. The sync will be retried in X seconds.",

        "createdAt": "2020-03-01T22:45:55.1570000Z"

    }

     

    Timeline

    With the arrival of Eloqua release 20B (May 2020), the Bulk API will return a more detailed 500 response and there will be one new sync log message. Check the Eloqua Release Center for specific dates and times.

     

    Next Steps

    If using the Bulk API, prepare for the new more detailed 500 response and the new Bulk API sync log message.

     

    The more detailed 500 response could be used within retry logic.

     

    The new sync log message will provide a more detailed view of Bulk API sync processing.

     

    Additional Resources

    View changes for Eloqua's APIs including, new features, significant recent changes, and platform notices, on the Eloqua Developer Changelog.

     

    If you have questions, post a discussion on Code It!

     

    FAQ

     

    Q: Will the more detailed 500 response be returned for every 500 response for a Bulk API request?

    A: No, there still are scenarios where the 500 response for a Bulk API request could still only be “500 The service has encountered an error”.

     

    Q: Will the more detailed 500 response be returned for 503 responses?

    A: No, this will only be for 500 responses, not 503s or any other 500 level response.