Get stored script contexts

Introduced 1.0

Retrieves all contexts for stored scripts.

Example request

  1. GET _script_context

copy

Example response

The GET _script_context request returns the following fields:

  1. {
  2.   "contexts" : [
  3.     {
  4.       "name" : "aggregation_selector",
  5.       "methods" : [
  6.         {
  7.           "name" : "execute",
  8.           "return_type" : "boolean",
  9.           "params" : [ ]
  10.         },
  11.         {
  12.           "name" : "getParams",
  13.           "return_type" : "java.util.Map",
  14.           "params" : [ ]
  15.         }
  16.       ]
  17.     },
  18.     {
  19.       "name" : "aggs",
  20.       "methods" : [
  21.         {
  22.           "name" : "execute",
  23.           "return_type" : "java.lang.Object",
  24.           "params" : [ ]
  25.         },
  26.         {
  27.           "name" : "getDoc",
  28.           "return_type" : "java.util.Map",
  29.           "params" : [ ]
  30.         },
  31.         {
  32.           "name" : "getParams",
  33.           "return_type" : "java.util.Map",
  34.           "params" : [ ]
  35.         },
  36.         {
  37.           "name" : "get_score",
  38.           "return_type" : "java.lang.Number",
  39.           "params" : [ ]
  40.         },
  41.         {
  42.           "name" : "get_value",
  43.           "return_type" : "java.lang.Object",
  44.           "params" : [ ]
  45.         }
  46.       ]
  47.     },
  48.     {
  49.       "name" : "aggs_combine",
  50.       "methods" : [
  51.         {
  52.           "name" : "execute",
  53.           "return_type" : "java.lang.Object",
  54.           "params" : [ ]
  55.         },
  56.         {
  57.           "name" : "getParams",
  58.           "return_type" : "java.util.Map",
  59.           "params" : [ ]
  60.         },
  61.         {
  62.           "name" : "getState",
  63.           "return_type" : "java.util.Map",
  64.           "params" : [ ]
  65.         }
  66.       ]
  67.     },
  68.     {
  69.       "name" : "aggs_init",
  70.       "methods" : [
  71.         {
  72.           "name" : "execute",
  73.           "return_type" : "void",
  74.           "params" : [ ]
  75.         },
  76.         {
  77.           "name" : "getParams",
  78.           "return_type" : "java.util.Map",
  79.           "params" : [ ]
  80.         },
  81.         {
  82.           "name" : "getState",
  83.           "return_type" : "java.lang.Object",
  84.           "params" : [ ]
  85.         }
  86.       ]
  87.     },
  88.     {
  89.       "name" : "aggs_map",
  90.       "methods" : [
  91.         {
  92.           "name" : "execute",
  93.           "return_type" : "void",
  94.           "params" : [ ]
  95.         },
  96.         {
  97.           "name" : "getDoc",
  98.           "return_type" : "java.util.Map",
  99.           "params" : [ ]
  100.         },
  101.         {
  102.           "name" : "getParams",
  103.           "return_type" : "java.util.Map",
  104.           "params" : [ ]
  105.         },
  106.         {
  107.           "name" : "getState",
  108.           "return_type" : "java.util.Map",
  109.           "params" : [ ]
  110.         },
  111.         {
  112.           "name" : "get_score",
  113.           "return_type" : "double",
  114.           "params" : [ ]
  115.         }
  116.       ]
  117.     },
  118.     {
  119.       "name" : "aggs_reduce",
  120.       "methods" : [
  121.         {
  122.           "name" : "execute",
  123.           "return_type" : "java.lang.Object",
  124.           "params" : [ ]
  125.         },
  126.         {
  127.           "name" : "getParams",
  128.           "return_type" : "java.util.Map",
  129.           "params" : [ ]
  130.         },
  131.         {
  132.           "name" : "getStates",
  133.           "return_type" : "java.util.List",
  134.           "params" : [ ]
  135.         }
  136.       ]
  137.     },
  138.     {
  139.       "name" : "analysis",
  140.       "methods" : [
  141.         {
  142.           "name" : "execute",
  143.           "return_type" : "boolean",
  144.           "params" : [
  145.             {
  146.               "type" : "org.opensearch.analysis.common.AnalysisPredicateScript$Token",
  147.               "name" : "token"
  148.             }
  149.           ]
  150.         }
  151.       ]
  152.     },
  153.     {
  154.       "name" : "bucket_aggregation",
  155.       "methods" : [
  156.         {
  157.           "name" : "execute",
  158.           "return_type" : "java.lang.Number",
  159.           "params" : [ ]
  160.         },
  161.         {
  162.           "name" : "getParams",
  163.           "return_type" : "java.util.Map",
  164.           "params" : [ ]
  165.         }
  166.       ]
  167.     },
  168.     {
  169.       "name" : "field",
  170.       "methods" : [
  171.         {
  172.           "name" : "execute",
  173.           "return_type" : "java.lang.Object",
  174.           "params" : [ ]
  175.         },
  176.         {
  177.           "name" : "getDoc",
  178.           "return_type" : "java.util.Map",
  179.           "params" : [ ]
  180.         },
  181.         {
  182.           "name" : "getParams",
  183.           "return_type" : "java.util.Map",
  184.           "params" : [ ]
  185.         }
  186.       ]
  187.     },
  188.     {
  189.       "name" : "filter",
  190.       "methods" : [
  191.         {
  192.           "name" : "execute",
  193.           "return_type" : "boolean",
  194.           "params" : [ ]
  195.         },
  196.         {
  197.           "name" : "getDoc",
  198.           "return_type" : "java.util.Map",
  199.           "params" : [ ]
  200.         },
  201.         {
  202.           "name" : "getParams",
  203.           "return_type" : "java.util.Map",
  204.           "params" : [ ]
  205.         }
  206.       ]
  207.     },
  208.     {
  209.       "name" : "ingest",
  210.       "methods" : [
  211.         {
  212.           "name" : "execute",
  213.           "return_type" : "void",
  214.           "params" : [
  215.             {
  216.               "type" : "java.util.Map",
  217.               "name" : "ctx"
  218.             }
  219.           ]
  220.         },
  221.         {
  222.           "name" : "getParams",
  223.           "return_type" : "java.util.Map",
  224.           "params" : [ ]
  225.         }
  226.       ]
  227.     },
  228.     {
  229.       "name" : "interval",
  230.       "methods" : [
  231.         {
  232.           "name" : "execute",
  233.           "return_type" : "boolean",
  234.           "params" : [
  235.             {
  236.               "type" : "org.opensearch.index.query.IntervalFilterScript$Interval",
  237.               "name" : "interval"
  238.             }
  239.           ]
  240.         }
  241.       ]
  242.     },
  243.     {
  244.       "name" : "moving-function",
  245.       "methods" : [
  246.         {
  247.           "name" : "execute",
  248.           "return_type" : "double",
  249.           "params" : [
  250.             {
  251.               "type" : "java.util.Map",
  252.               "name" : "params"
  253.             },
  254.             {
  255.               "type" : "double[]",
  256.               "name" : "values"
  257.             }
  258.           ]
  259.         }
  260.       ]
  261.     },
  262.     {
  263.       "name" : "number_sort",
  264.       "methods" : [
  265.         {
  266.           "name" : "execute",
  267.           "return_type" : "double",
  268.           "params" : [ ]
  269.         },
  270.         {
  271.           "name" : "getDoc",
  272.           "return_type" : "java.util.Map",
  273.           "params" : [ ]
  274.         },
  275.         {
  276.           "name" : "getParams",
  277.           "return_type" : "java.util.Map",
  278.           "params" : [ ]
  279.         },
  280.         {
  281.           "name" : "get_score",
  282.           "return_type" : "double",
  283.           "params" : [ ]
  284.         }
  285.       ]
  286.     },
  287.     {
  288.       "name" : "painless_test",
  289.       "methods" : [
  290.         {
  291.           "name" : "execute",
  292.           "return_type" : "java.lang.Object",
  293.           "params" : [ ]
  294.         },
  295.         {
  296.           "name" : "getParams",
  297.           "return_type" : "java.util.Map",
  298.           "params" : [ ]
  299.         }
  300.       ]
  301.     },
  302.     {
  303.       "name" : "processor_conditional",
  304.       "methods" : [
  305.         {
  306.           "name" : "execute",
  307.           "return_type" : "boolean",
  308.           "params" : [
  309.             {
  310.               "type" : "java.util.Map",
  311.               "name" : "ctx"
  312.             }
  313.           ]
  314.         },
  315.         {
  316.           "name" : "getParams",
  317.           "return_type" : "java.util.Map",
  318.           "params" : [ ]
  319.         }
  320.       ]
  321.     },
  322.     {
  323.       "name" : "score",
  324.       "methods" : [
  325.         {
  326.           "name" : "execute",
  327.           "return_type" : "double",
  328.           "params" : [
  329.             {
  330.               "type" : "org.opensearch.script.ScoreScript$ExplanationHolder",
  331.               "name" : "explanation"
  332.             }
  333.           ]
  334.         },
  335.         {
  336.           "name" : "getDoc",
  337.           "return_type" : "java.util.Map",
  338.           "params" : [ ]
  339.         },
  340.         {
  341.           "name" : "getParams",
  342.           "return_type" : "java.util.Map",
  343.           "params" : [ ]
  344.         },
  345.         {
  346.           "name" : "get_score",
  347.           "return_type" : "double",
  348.           "params" : [ ]
  349.         }
  350.       ]
  351.     },
  352.     {
  353.       "name" : "script_heuristic",
  354.       "methods" : [
  355.         {
  356.           "name" : "execute",
  357.           "return_type" : "double",
  358.           "params" : [
  359.             {
  360.               "type" : "java.util.Map",
  361.               "name" : "params"
  362.             }
  363.           ]
  364.         }
  365.       ]
  366.     },
  367.     {
  368.       "name" : "similarity",
  369.       "methods" : [
  370.         {
  371.           "name" : "execute",
  372.           "return_type" : "double",
  373.           "params" : [
  374.             {
  375.               "type" : "double",
  376.               "name" : "weight"
  377.             },
  378.             {
  379.               "type" : "org.opensearch.index.similarity.ScriptedSimilarity$Query",
  380.               "name" : "query"
  381.             },
  382.             {
  383.               "type" : "org.opensearch.index.similarity.ScriptedSimilarity$Field",
  384.               "name" : "field"
  385.             },
  386.             {
  387.               "type" : "org.opensearch.index.similarity.ScriptedSimilarity$Term",
  388.               "name" : "term"
  389.             },
  390.             {
  391.               "type" : "org.opensearch.index.similarity.ScriptedSimilarity$Doc",
  392.               "name" : "doc"
  393.             }
  394.           ]
  395.         }
  396.       ]
  397.     },
  398.     {
  399.       "name" : "similarity_weight",
  400.       "methods" : [
  401.         {
  402.           "name" : "execute",
  403.           "return_type" : "double",
  404.           "params" : [
  405.             {
  406.               "type" : "org.opensearch.index.similarity.ScriptedSimilarity$Query",
  407.               "name" : "query"
  408.             },
  409.             {
  410.               "type" : "org.opensearch.index.similarity.ScriptedSimilarity$Field",
  411.               "name" : "field"
  412.             },
  413.             {
  414.               "type" : "org.opensearch.index.similarity.ScriptedSimilarity$Term",
  415.               "name" : "term"
  416.             }
  417.           ]
  418.         }
  419.       ]
  420.     },
  421.     {
  422.       "name" : "string_sort",
  423.       "methods" : [
  424.         {
  425.           "name" : "execute",
  426.           "return_type" : "java.lang.String",
  427.           "params" : [ ]
  428.         },
  429.         {
  430.           "name" : "getDoc",
  431.           "return_type" : "java.util.Map",
  432.           "params" : [ ]
  433.         },
  434.         {
  435.           "name" : "getParams",
  436.           "return_type" : "java.util.Map",
  437.           "params" : [ ]
  438.         },
  439.         {
  440.           "name" : "get_score",
  441.           "return_type" : "double",
  442.           "params" : [ ]
  443.         }
  444.       ]
  445.     },
  446.     {
  447.       "name" : "template",
  448.       "methods" : [
  449.         {
  450.           "name" : "execute",
  451.           "return_type" : "java.lang.String",
  452.           "params" : [ ]
  453.         },
  454.         {
  455.           "name" : "getParams",
  456.           "return_type" : "java.util.Map",
  457.           "params" : [ ]
  458.         }
  459.       ]
  460.     },
  461.     {
  462.       "name" : "terms_set",
  463.       "methods" : [
  464.         {
  465.           "name" : "execute",
  466.           "return_type" : "java.lang.Number",
  467.           "params" : [ ]
  468.         },
  469.         {
  470.           "name" : "getDoc",
  471.           "return_type" : "java.util.Map",
  472.           "params" : [ ]
  473.         },
  474.         {
  475.           "name" : "getParams",
  476.           "return_type" : "java.util.Map",
  477.           "params" : [ ]
  478.         }
  479.       ]
  480.     },
  481.     {
  482.       "name" : "trigger",
  483.       "methods" : [
  484.         {
  485.           "name" : "execute",
  486.           "return_type" : "boolean",
  487.           "params" : [
  488.             {
  489.               "type" : "org.opensearch.alerting.script.QueryLevelTriggerExecutionContext",
  490.               "name" : "ctx"
  491.             }
  492.           ]
  493.         },
  494.         {
  495.           "name" : "getParams",
  496.           "return_type" : "java.util.Map",
  497.           "params" : [ ]
  498.         }
  499.       ]
  500.     },
  501.     {
  502.       "name" : "update",
  503.       "methods" : [
  504.         {
  505.           "name" : "execute",
  506.           "return_type" : "void",
  507.           "params" : [ ]
  508.         },
  509.         {
  510.           "name" : "getCtx",
  511.           "return_type" : "java.util.Map",
  512.           "params" : [ ]
  513.         },
  514.         {
  515.           "name" : "getParams",
  516.           "return_type" : "java.util.Map",
  517.           "params" : [ ]
  518.         }
  519.       ]
  520.     }
  521.   ]
  522. }

Response body fields

The GET _script_context request returns the following response fields:

FieldData typeDescription
contextsListA list of all contexts. See Script object.

Script context

FieldData typeDescription
nameStringThe context name.
methodsListList of the context’s allowable methods. See Script object.

Context methods

FieldData typeDescription
nameStringMethod name.
nameStringType that the method returns (boolean, object, number, and so on).
paramsListList of the parameters accepted by the method. See Script object.

Method parameters

FieldData typeDescription
typeStringParameter data type.
nameStringParameter name.