Application Framework Reference

Splunk API

getRequiredFieldList()

The getRequiredFieldList() method gets the requiredFieldList of the current search. This is a list of fields that must be present in the result set, even if empty. The default value is empty .

Synopsis

fieldList = getRequiredFieldList()

Return Value

Example

var context = this.getContext();var search  = context.get("search");
var rfl = search.getRequiredFieldList();
if (rfl) {
    $.each(rfl, function(i, v) {
        alert('requireField = ' + escape(v));
    });
} else {
    alert('this search has no required field list');
}
 

See Also