Path parameters

• index string Required

  Name of the index to retrieve documents from when ids are specified, or when a document in the docs array does not specify an index.

Query parameters

• preference string

  Specifies the node or shard the operation should be performed on. Random by default.

• realtime boolean

  If true, the request is real-time as opposed to near-real-time.

• refresh boolean

  If true, the request refreshes relevant shards before retrieving documents.

• routing string

  Custom value used to route operations to a specific shard.

• _source boolean | string | array[string]

  True or false to return the _source field or not, or a list of fields to return.

• _source_excludes string | array[string]

  A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter.

• _source_includes string | array[string]

  A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

• stored_fields string | array[string]

  If true, retrieves the document fields stored in the index rather than the document _source.

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • docs array[object] Required
    One of:

    get:GetResult object mget:MultiGetError object

    Hide attributes Show attributes

    • _index string Required
    • fields object
      Hide fields attributes Show fields attributes object

      • Additional properties
      • key object
    • _ignored array[string]
    • found boolean Required
    • _id string Required
    • _primary_term number
    • _routing string
    • _seq_no number
    • _source object
    • _version number

    Hide attributes Show attributes

    • error object Required
      Hide error attributes Show error attributes object

      • type string Required

        The type of error

      • reason string

        A human-readable explanation of the error, in english

      • stack_trace string

        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

      • caused_by object
      • root_cause array[object]
      • suppressed array[object]
    • _id string Required
    • _index string Required