Error Signaling

The services makes use of the HTTP status codes to report the outcome of each API call. The status codes are complemented by a consistent response data model for reporting client and system level failures.

Format
{
  "@context": "https://bluebrain.github.io/nexus/contexts/error.json",
  "@type": "<a machine readable unique identifier>",
  "reason": "<a human readable description of the error>"
}
Full source at GitHub
Example
{
  "@context": "https://bluebrain.github.io/nexus/contexts/error.json",
  "@type": "IllegalFilterFormat",
  "reason": "Unable to parse 'path' as an uri",
  "field": "DownField(filter)/DownField(path)"
}
Full source at GitHub

In addition to mandatory @type and reason fields, arbitrary fields may be present for extra information in certain scenarios.