Google Search Appliance Administrative API Developers Guide: Protocol - Manual (Page 27)

Google Search Appliance: Administrative API Developer’s Guide: Protocol 27
OneBox Settings
Retrieve or update a OneBox setting for a search appliance using the oneboxSetting entry of the
config feed.
Retrieving OneBox Settings
To get a OneBox setting for a search appliance, send an authenticated GET request to the config feed
URL:
http://Search_Appliance:8000/feeds/config/oneboxSetting
The following example result is an entry that includes current OneBox setting values for the search
appliance:
<?xml version=’1.0’ encoding=’UTF-8’?>
<entry xmlns=’http://www.w3.org/2005/Atom’
xmlns:gsa=’http://schemas.google.com/gsa/2007’>
<id>http://gsa:8000/feeds/config/oneboxSetting</id>
<updated>2008-12-12T09:21:47.477Z</updated>
<link rel=’self’ type=’application/atom+xml’
href=’http://gsa:8000/feeds/config/oneboxSetting’/>
<link rel=’edit’ type=’application/atom+xml’
href=’http://gsa:8000/feeds/config/oneboxSetting’/>
<gsa:content name=’entryID’>oneboxSetting</gsa:content>
<gsa:content name=’maxResults’>2</gsa:content>
<gsa:content name=’timeout’>1000</gsa:content>
</entry>
Updating OneBox Settings
To update the OneBox settings for a search appliance, send an authenticated PUT request to the config
feed URL:
http://Search_Appliance:8000/feeds/config/oneboxSetting
The following example overwrites the OneBox setting specified in the entry to update:
<?xml version=’1.0’ encoding=’UTF-8’?>
<entry xmlns=’http://www.w3.org/2005/Atom’
xmlns:gsa=’http://schemas.google.com/gsa/2007’>
<id>http://gsa:8000/feeds/config/oneboxSetting</id>
<gsa:content name=’entryID’>oneboxSetting</gsa:content>
<gsa:content name=’maxResults’>3</gsa:content>
<gsa:content name=’timeout’>2000</gsa:content>
</entry>
Property Description
maxResults Maximum number of OneBox results per search.
timeout OneBox response timeout.