mirror of
https://github.com/elastic/kibana.git
synced 2025-04-26 02:37:44 -04:00
5d8a7920c1
* add data view api docs, keep deprecated equivalents Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
54 lines
1.3 KiB
Text
54 lines
1.3 KiB
Text
[[data-views-runtime-field-api-get]]
|
|
=== Get runtime field API
|
|
++++
|
|
<titleabbrev>Get runtime field</titleabbrev>
|
|
++++
|
|
|
|
experimental[] Get a runtime field
|
|
|
|
|
|
[[data-views-runtime-field-get-request]]
|
|
==== Request
|
|
|
|
`GET <kibana host>:<port>/api/data_views/data_view/<data_view_id>/runtime_field/<name>`
|
|
|
|
`GET <kibana host>:<port>/s/<space_id>/api/data_views/data_view/<data_view_id>/runtime_field/<name>`
|
|
|
|
|
|
[[data-views-runtime-field-get-params]]
|
|
==== Path parameters
|
|
|
|
`space_id`::
|
|
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
|
|
|
`data_view_id`::
|
|
(Required, string) The ID of the data view.
|
|
|
|
`name`::
|
|
(Required, string) The name of the runtime field you want to retrieve.
|
|
|
|
|
|
[[data-views-runtime-field-get-example]]
|
|
==== Example
|
|
|
|
Retrieve a runtime field named `foo` of data view with the `my-view` ID:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X GET api/data_views/data_view/my-view/runtime_field/foo
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
The API returns a runtime `field` object array, and a `runtimeField` definition object:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
{
|
|
"fields": [
|
|
...
|
|
],
|
|
"runtimeField": {
|
|
...
|
|
}
|
|
}
|
|
--------------------------------------------------
|