Skip to content
Exofind

    REST API

    ErrorResponse

    The body of every failed request. Error codes use colon-separated namespaces such as index:field:name_invalid, are stable across API versions, and are never renamed or reused, so clients match on code rather than on message. See Errors.

    Example

    {
      "code": "validation",
      "message": "Request contains 1 error",
      "errors": [
        {
          "code": "index:field:primary_key:multiple_unsupported",
          "message": "Field `id` is marked as a primary key and multiple, primary keys can not have multiple values",
          "path": "id"
        }
      ]
    }

    Properties

    codestring
    Identifies the failure type. For validation failures, this is validation and the individual problems are listed in errors. For all other failures, this matches the code of the single entry in errors.
    Example
    "validation"
    messagestring
    Human-readable message for log output. Match on code rather than on message. When a validation failure contains one problem, this is that problem's message. When it contains several, it reads Request contains N errors.
    Example
    "Request contains 2 errors"
    errorsErrorDetail[]
    All problems found in the request. A validation failure reports every field with a problem, so a caller can fix them in one pass rather than one request at a time.
    Example
    {
      "code": "index:field:primary_key:multiple_unsupported",
      "message": "Field `id` is marked as a primary key and multiple, primary keys can not have multiple values",
      "path": "id"
    }
    4 properties
    codestring
    The error code identifying this specific problem.
    Example
    "index:field:primary_key:multiple_unsupported"
    messagestring
    Human-readable description of this problem.
    Example
    "Field `id` is marked as a primary key and multiple, primary keys can not have multiple values"
    pathstring
    Location of the offending value in the request, such as fields.title or documents[1].nonexistent. Names join with ., one element of a list reads [n] counted from zero, and a key of a free-form map such as metadata goes in brackets and double quotes when it holds a dot or a bracket, as metadata["build.sha"]. A field inside an object field carries its own dotted path, so a path here reaches a field the same way a query does. Omitted when the problem applies to the request as a whole. See API conventions.
    Example
    "id"
    argumentsmap of string
    The values the message was rendered with, so a client can render a message of its own from the code.
    1 property
    <key>string

    Endpoints

    Endpoints where the request or responses uses this type.

    Exofind is built by Level Four AB and is available under the Apache License 2.0.