summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/get.json
blob: 888f528093385b3031414b73cd500ba2550f7844 (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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
  "get": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html",
    "methods": ["GET"],
    "url": {
      "path": "/{index}/{type}/{id}",
      "paths": ["/{index}/{type}/{id}"],
      "parts": {
        "id": {
          "type" : "string",
          "required" : true,
          "description" : "The document ID"
        },
        "index": {
          "type" : "string",
          "required" : true,
          "description" : "The name of the index"
        },
        "type": {
          "type" : "string",
          "required" : true,
          "description" : "The type of the document (use `_all` to fetch the first document matching the ID across all types)"
        }
      },
      "params": {
        "fields": {
          "type": "list",
          "description" : "A comma-separated list of fields to return in the response"
        },
        "parent": {
          "type" : "string",
          "description" : "The ID of the parent document"
        },
        "preference": {
          "type" : "string",
          "description" : "Specify the node or shard the operation should be performed on (default: random)"
        },
        "realtime": {
          "type" : "boolean",
          "description" : "Specify whether to perform the operation in realtime or search mode"
        },
        "refresh": {
          "type" : "boolean",
          "description" : "Refresh the shard containing the document before performing the operation"
        },
        "routing": {
          "type" : "string",
          "description" : "Specific routing value"
        },
        "_source": {
          "type" : "list",
          "description" : "True or false to return the _source field or not, or a list of fields to return"
        },
        "_source_exclude": {
          "type" : "list",
          "description" : "A list of fields to exclude from the returned _source field"
        },
        "_source_include": {
          "type" : "list",
          "description" : "A list of fields to extract and return from the _source field"
        },
        "version" : {
          "type" : "number",
          "description" : "Explicit version number for concurrency control"
        },
        "version_type": {
          "type" : "enum",
          "options" : ["internal","external"],
          "description" : "Specific version type"
        }
      }
    },
    "body": null
  }
}