EndPoint Get documents from Index or Alias
Name
get_documents
Description
Gets documents from Index or Alias
[API Help]
Parameters
| Parameter |
Label |
Required |
Options |
Description |
| Index |
Index |
YES |
|
|
| Alias |
Alias |
NO |
|
|
| Query |
Enter Query (JSON Format) |
NO |
| Option |
Value |
| All Records |
{"match_all": { } } |
| Record where comment or name contains TV word |
{"query_string": {"query": "comment:TV OR name:TV"} } |
| Record with comment field (attribute exists) |
{"query_string": {"query": "_exists_:comment"} } |
|
[API Help..]
|
| CursorTimeout |
CursorTimeout (Minutes) |
NO |
| Option |
Value |
| 1 |
1 |
| 2 |
2 |
| 5 |
5 |
| 10 |
10 |
| 60 |
60 |
| 180 |
180 |
|
Enter this value carefully. Do not enter very long timeout else it will hold cursor longer on server memory space
|
| PageSize |
How many Record to fetch per request |
NO |
|
Do not enter very large number or too small number to avoid performance issues.
|
Output Columns
| Label |
DataType |
Length |
Raw |
Description |
| _id |
DT_WSTR |
4000 |
False |
|
| _score |
DT_R8 |
0 |
False |
|
| [$parent.Pivot_Path$] |
DT_WSTR |
4000 |
False |
|
Input Columns
| Label |
DataType |
Length |
Raw |
Description |
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |
