Skip to content

Commit f5293c0

Browse files
authored
Added async headers info
1 parent 9b7e41d commit f5293c0

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

explore-analyze/query-filter/languages/esql-rest.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ Complete responses with metadata. Useful for automatic parsing.
7070

7171
| `format` | HTTP header | Description |
7272
| --- | --- | --- |
73-
| Structured | | _Complete response with metadata_ |
7473
| `json` | `application/json` | [JSON](https://www.json.org/) (JavaScript Object Notation) human-readable format |
7574
| `yaml` | `application/yaml` | [YAML](https://en.wikipedia.org/wiki/YAML) (YAML Ain’t Markup Language) human-readable format |
7675

@@ -80,7 +79,6 @@ Query results only, without metadata. Useful for quick and manual data previews.
8079

8180
| `format` | HTTP header | Description |
8281
| --- | --- | --- |
83-
| Tabular | | _Query results only, no metadata_ |
8482
| `csv` | `text/csv` | [Comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values) |
8583
| `tsv` | `text/tab-separated-values` | [Tab-separated values](https://en.wikipedia.org/wiki/Tab-separated_values) |
8684
| `txt` | `text/plain` | CLI-like representation |
@@ -341,3 +339,8 @@ Use the [{{esql}} async query delete API](https://www.elastic.co/docs/api/doc/el
341339
```console
342340
DELETE /_query/async/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=
343341
```
342+
343+
::::{note}
344+
You will also receive the async ID and running status in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.
345+
Useful if you use a tabular text format like `txt`, `csv` or `tsv`, as you won't receive those fields in the body there.
346+
::::

0 commit comments

Comments
 (0)