OpenSearch/rest-api-spec/api/get_source.json

60 lines
1.8 KiB
JSON

{
"get_source": {
"documentation": "http://elasticsearch.org/guide/reference/api/get/",
"methods": ["GET"],
"url": {
"path": "/{index}/{type}/{id}/_source",
"paths": ["/{index}/{type}/{id}/_source"],
"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" : false,
"default" : "_all",
"description" : "The type of the document; use `_all` to fetch the first document matching the ID across all types"
}
},
"params": {
"exclude": {
"type" : "list",
"description" : "A list of fields to exclude from the returned _source field"
},
"include": {
"type" : "list",
"description" : "A list of fields to extract and return from the _source field"
},
"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"
}
}
},
"body": null
}
}