Error Message Data Model
When a request fails, the REST API returns an HTTP status code along with a response body containing a JSON-encoded error description, which in turn contain various fields. This table lists the fields in the error description:
Field | Type | Occurrence | Description |
---|---|---|---|
type |
string |
1 |
A type URI typically with the "http" scheme. Type is "about:blank" when the HTTP status code is enough. |
title |
string |
1 |
A title that describes the error, for example, Not Found. |
detail |
string |
1 |
A detailed description of the error. |