summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/msearch.json
blob: 97d8488e6ec1ca26c4faab71069a1bad9d534307 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "msearch": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-multi-search.html",
    "methods": ["GET", "POST"],
    "url": {
      "path": "/_msearch",
      "paths": ["/_msearch", "/{index}/_msearch", "/{index}/{type}/_msearch"],
      "parts": {
        "index": {
         "type" : "list",
         "description" : "A comma-separated list of index names to use as default"
        },
        "type": {
          "type" : "list",
          "description" : "A comma-separated list of document types to use as default"
        }
      },
      "params": {
        "search_type": {
          "type" : "enum",
          "options" : ["query_then_fetch", "query_and_fetch", "dfs_query_then_fetch", "dfs_query_and_fetch", "count", "scan"],
          "description" : "Search operation type"
        }
      }
    },
    "body": {
      "description": "The request definitions (metadata-search request definition pairs), separated by newlines",
      "required" : true,
      "serialize" : "bulk"
    }
  }
}