Create or update a runtime field

PUT /api/data_views/data_view/{viewId}/runtime_field

Headers

kbn-xsrf string Required

Cross-site request forgery protection

Path parameters

viewId string Required

The ID of the data view fields you want to update.

application/json; Elastic-Api-Version=2023-10-31

Body Required

name string Required

The name for a runtime field.
runtimeField object Required

The runtime field definition object.

Additional properties are allowed.

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Indicates a successful call.
Hide response attributes Show response attributes object
- data_view object
  
  Additional properties are allowed.
- fields array[object]
  
  Additional properties are allowed.
400 application/json; Elastic-Api-Version=2023-10-31

Bad request
Hide response attributes Show response attributes object
- error string Required
- message string Required
- statusCode number Required

PUT /api/data_views/data_view/{viewId}/runtime_field

curl \
 -X PUT https://localhost:5601/api/data_views/data_view/{viewId}/runtime_field \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "kbn-xsrf: string"

Request example

{
  "name": "runtimeFoo",
  "runtimeField": {
    "type": "long",
    "script": {
      "source": "emit(doc[\"foo\"].value)"
    }
  }
}

Response examples (200)

{
  "data_view": {},
  "fields": [
    {}
  ]
}

Response examples (400)

{
  "error": "Bad Request",
  "message": "string",
  "statusCode": 400
}