Painless execute APIedit

Warning

The painless execute api is new and the request / response format may change in a breaking way in the future

The Painless execute API allows an arbitrary script to be executed and a result to be returned.

Table 1. Parameters

Name Required Default Description

script

yes

-

The script to execute

context

no

painless_test

The context the script should be executed in.


Contextsedit

Contexts control how scripts are executed, what variables are available at runtime and what the return type is.

Painless test script contextedit

The painless_test context executes scripts as is and do not add any special parameters. The only variable that is available is params, which can be used to access user defined values. The result of the script is always converted to a string. If no context is specified then this context is used by default.

Exampleedit

Request:

POST /_scripts/painless/_execute
{
  "script": {
    "source": "params.count / params.total",
    "params": {
      "count": 100.0,
      "total": 1000.0
    }
  }
}

Response:

{
  "result": "0.1"
}