1. REST API Developer’s Guide
  2. Error Response Format

Error Response Format

Oracle CRM On Demand REST API responses indicating an error or warning are represented by a proper response HTTP status code, such as 404. For more information about HTTP status codes, see Standard HTTP Status Codes.

Additionally, a response body is provided containing additional information about the error. The following is an example of the Oracle CRM On Demand Rest API error format:

"Error": [
{
 "problemType": "https://support.oracle.com/epmos/faces/DocumentDisplay?id=1802485.1",
 "title": "The value entered in field %2 of buscomp %3 does not match any value in the bounded pick list%1.",
 "httpStatus": 400,
 "detail": "The value entered in field AccountType of buscomp Account does not match any value in the bounded pick list PickList Account Type.(SBL-DAT-00225)",
 "problemInstance":"urn:ocrmod:/OnDemand/user/Rest/latest/Accounts",
 "errorCode": "SBL-DAT-00225",
 "OCRMODErrorDetail": {
 "Parameters":["PickList Account Type", "AccountType", "Account"]
 }
}]

where:

  • problemType indicates the location for help about troubleshooting.

  • title indicates the error message before substituting variables.

  • httpStatus indicates the HTTP status code.

  • detail indicates the error message after substituting variables.

  • problemInstance indicates the URL that generated the error.

  • errorCode indicates the error code.

  • OCRMODErrorDetail indicates application-specific details about the error.

  • Parameters indicates the variables that are used in the error message substitution.