Search.

API URL http://localhost:8080/searchblox/servlet/SearchServlet

Search Request Parameters

Parameter

Default Value

Range of Values

Description

query Valid query syntax Search query
fe UTF-8 Valid web page encoding Encoding of the search form
col All available Collections Existing collection ID Collection ID
page 1 Search results page number
pagesize 10 1 to 1000 Number of results per page
xsl default.xsl Any XSL file placed in the /stylesheets directory Name of the XSL file to use
cname All available Collections Any Collection Name Name of collection
filter Valid query syntax Filter query
startdate YYYYMMDDHHMMSS
where
YYYY – is the year (eg: 2007)
MM – is the month (01 to 12)
DD – is the day (01 to 31)
HH – is hours (00 to 23)
MM – is minutes (00 to 59)
SS – is seconds (00 to 59)
Start date for date range search
enddate YYYYMMDDHHMMSS
where
YYYY – is the year (eg: 2007)
MM – is the month (01 to 12)
DD – is the day (01 to 31)
HH – is hours (00 to 23)
MM – is minutes (00 to 59)
SS – is seconds (00 to 59)
End date for date range search
sort relevance relevance
date
alpha
Sort options for the search results
relevance – search result score
date – search result date
alpha – alphabetical sorting of search result title
sortdir asc asc or desc Sort direction for search results – ascending or descending

Advanced Search Request Parameters

Parameter

Default Value

Range of Values

Description

st adv adv Search type
q-all Valid query syntax Search all the words
a-phr Valid query syntax Exact Phrase
q-low Valid query syntax At least one word
q-not Valid query syntax Without the words
contenttype pdf – Adobe Acrobat PDF (.pdf)
word – Word (.doc)
excel – Excel (.xls)
ppt – PowerPoint (.ppt)
rtf – Rich Text Format (.rtf)
txt – Text (.txt)
odf – OpenOffice
wp – WordPerfect
email – Emails from PST
attachment – Email attachments
Document Format
language ar – Arabic
bn – Bengali
zhcn – Chinese (Simplified)
zhtw – Chinese (Traditional)
cs – Czech
da – Danish
nl – Dutch
en – English
es – Estonian
fi – Finnish
fr – French
de – German
el – Greek
gu – Gujarati
iw – Hebrew
hi – Hindi
hu – Hungarian
it – Italian
ja – Japanese
kn – Kannada
ko – Korean
lv – Latvian
lt – Lithuanian
mal – Malayalam
no – Norwegian
pl – Polish
pt – Portuguese
ru – Russian
ro – Romanian
sk – Slovak
sl – Slovenian
es – Spanish
sv – Swedish
ta – Tamil
te – Telugu
th – Thai
tr – Turkish
Document language
fe UTF-8 Valid web page encoding Encoding of the search form
col All available Collections Existing collection ID Collection ID
page 1 Search results page number
page size 10 1 to 1000 Number of results per page
xsl default.xsl Any XSL file placed in the /stylesheets directory Name of the XSL file to use
cname All available collections Any Collection Name Name of collection
filter Valid query syntax Filter query
startdate YYYYMMDDHHMMSS
where
YYYY – is the year (eg: 2007)
MM – is the month (01 to 12)
DD – is the day (01 to 31)
HH – is hours (00 to 23)
MM – is minutes (00 to 59)
SS – is seconds (00 to 59)
Start date for date range search
enddate YYYYMMDDHHMMSS
where
YYYY – is the year (eg: 2007)
MM – is the month (01 to 12)
DD – is the day (01 to 31)
HH – is hours (00 to 23)
MM – is minutes (00 to 59)
SS – is seconds (00 to 59)
End date for date range search
sort relevance relevance
date
alpha
Sort options for the search results
relevance – search result score
date – search result date
alpha – alphabetical sorting of search result title
sortdir asc asc or desc Sort direction for search results – ascending or descending

Faceted Search Request Parameters

Parameter

Default Value

Range of Values

Description

facet on on Enable facets
facet.field No default field Any standard or custom field including term, number or date fields Provides the ability to facet on any field
f.{fieldname}.size 10 1-1000 Sets the number of values returned
f.{fieldname}.range No default value Examples of ranges [TO100000], [1000TO100000], [100TO] Sets the range of values for the filtering
f.{fieldname}.range No default value Examples of date ranges [*TO2012-02-28T00:00:26], [2010-02-28T00:00:26TO2012-02-28T00:00:26] Sets the range of dates for the date field filtering
f.{fieldname}.interval No default value Possible values are minute, hour, day, week, month, quarter, year Sets the date histogram period for date field faceting

Search Response

Search results as XML (shown below as a collapsed XML tree)
The SearchBlox XML Searh results consist of 4 types of information:

Search Details

All information regarding the processed search query is encapsulated in the element tag. Below is the list of information available in the attributes of this element.

Attribute

Description

hits Number of hits or matches for the query
time Time taken to return the results of the search query in seconds
query The search query
suggest Spelling suggestions if available
filter Preset filter used for the query
sort Indicates how the search results are sorted. The possible values for this attribute are relevance, date and alpha.
sortdir Indicates whether the search results are sorted in ascending or descending order. The possible values for this attribute are asc and desc.
start The hit or match number of the first search result in this page
end The hit or match number of the last search result in this page
currentpage This indicates the current page number for this set of search results
lastpage This indicates the last possible page number for this set of search results
startdate Indicates the start date for the date range search
enddate Indicates the end date for the date range search
pagesize Number of search results per page

Search Result Details

All information about each search result is contained in the element and its child elements.

Element / Attribute

Description

no Number of hits or matches for the query
url Search result document URL
lastmodified Last modified date of document
indexdate Date the document was indexed
title Title of the document
alpha The text for the search result that is used for alphabetical sorting.
keywords The keywords contained in the document
contenttype The format of the document
context This is the fragment of the content where the search
query appears. This is available only when the documents
have been indexed with the Keyword-In-Context feature
enabled.
description The description contained in the document
language Language setting for the document
score The relevance score for the document for this query
highlight Indicates terms that have been highlighted
size Document size in bytes

Link Details

The element contains pre-canned page URLs to simplify the process of paginating through the search results. The page URLs available here includes links to specific page numbers, the next and previous pages to the current page and the URLs for the alternative sorting options.

Search Form Details

The element provides all the information to display the search form as part of the search results. The information available here includes the list of selected collections used for the query.

Back to Top