Error Messages

All error messages are currently always returned in a JSON format.

A typical error in the JSON format looks like the following example:
{     
       "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
       "title":"NotFoundException",
       "status":404,
       "detail":"Entity with ID qqqwww not found",
       "instance":"http://.../iot/api/v1/endpoints/qqqwww",
       "o:errorCode":"urn:oracle:cloud:client:error:not-found",
       "o:errorPath":"/qqqwww"
}

The following table describes the properties used in the error example above.

Property Name Description
type URI that provides the link to the HTTP error code page.
title Summary of the error message
status HTTP status code
detail Detailed error message
instance URI to the link that provides more detail about the error
o:errorCode Application specific code
o:errorPath XPath or JSON patch to indicate where the error occurs