Error Details

The error details. Required for client-side 4XX errors.

Structure

ErrorDetails

Fields

Name	Type	Tags	Description	Getter	Setter
Field	String	Optional	The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.	String getField()	setField(String field)
Value	String	Optional	The value of the field that caused the error.	String getValue()	setValue(String value)
Location	String	Optional	The location of the field that caused the error. Value is body, path, or query. Default: "body"	String getLocation()	setLocation(String location)
Issue	String	Required	The unique, fine-grained application-level error code.	String getIssue()	setIssue(String issue)
Links	List<LinkDescription>	Optional, Read-only	An array of request-related HATEOAS links that are either relevant to the issue by providing additional information or offering potential resolutions. Constraints: Minimum Items: 1, Maximum Items: 4	List getLinks()	setLinks(List links)
Description	String	Optional	The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.	String getDescription()	setDescription(String description)

Example (as JSON)

{
  "location": "body",
  "issue": "issue8",
  "field": "field0",
  "value": "value8",
  "links": [
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    },
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    }
  ],
  "description": "description4"
}