Common error responses for the Polling API
Unless otherwise noted, each of the following has an HTTPS status code of 200 OK, because the polling request itself was considered successful, even if it contains an error response from the system.
Response purged (RESPONSE_PURGED)
The system returns this response when the async job status response is removed from the queue. Responses are retained in the system for 24 hours. Client applications must poll for responses within 24 hours after the initial API request was submitted.
{
"response": {
"type": "",
"title": "Response purged",
"errorCode": "RESPONSE_PURGED",
"detail": "Response Message Purged",
"errorDetails": "[]"
},
"requestId": "WGlJSWhsOjoxNTIxMzU5OTI1",
"apiName": "",
"timeZone": null,
"requestTime": "2018-03-18 13:28:45.0",
"requestProcessedTime": "",
"status": "UNKNOWN"
}
Request expired while processing (ASYNC_REQUEST_EXPIRED)
The system returns this response when the async request has expired during processing. This happens if the time in the queue exceeds the Message-Expiration, which is 3600 seconds by default.
{
"responseMessage": {
"errorCode": "ASYNC_REQUEST_EXPIRED",
"detail": "Async request expired while processing.",
"type": "",
"title": "Async API request expired",
"errorDetails": "[]"
},
"requestId": "WGlJSWhsOjoxNTIxMzU5OTI1",
"apiName": "asyncMergeTriggerEmail",
"requestTime": "2018-03-18 13:28:45.809",
"requestProcessedTime": "2018-03-18 13:30:20",
"status": "ERROR"
}
Request ID is not valid (INVALID_REQUEST_ID)
The system returns this response when the requestId provided is not valid. Verify the requestId is correct.
{
"response": {
"type": "",
"title": "Invalid Request Id",
"errorCode": "INVALID_REQUEST_ID",
"detail": "Request Id is not valid ",
"errorDetails": "[]"
},
"requestId": "VNTIwOTQ5MDcz",
"apiName": null
"requestTime": null,
"requestProcessedTime": null,
"status": "ERROR"
}