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

Search Request Parameters

Parameter

Default Value

Range of Values

Description

queryValid query syntaxSearch query
feUTF-8Valid web page encodingEncoding of the search form
colAll available CollectionsExisting collection IDCollection ID
page1Search results page number
pagesize101 to 1000Number of results per page
xsldefault.xsl (Use xml or json for xml/json output)Any XSL file placed in the /stylesheets directory or xml or jsonName of the XSL file to use or xml/json
cnameAll available CollectionsAny Collection NameName of collection
filterValid query syntaxFilter query
startdateYYYYMMDDHHMMSS
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
enddateYYYYMMDDHHMMSS
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
sortrelevancerelevance
date
alpha
Sort options for the search results
relevance – search result score
date – search result date
alpha – alphabetical sorting of search result title
sortdirascasc or descSort direction for search results – ascending or descending
mlt_id & mlt_colmlt id is the object id, mlt col is the collection noUsed to get More Like This search results
downloadAsZip &zipSizedownloadAsZip values are true or false, zipSize is the no of files to be downloadedUsed to download files from file system collection search results
clusterfalsetrue or trueEnabling clustering of search results (used with clustered.xsl)

Advanced Search Request Parameters

Parameter

Default Value

Range of Values

Description

stadvadvSearch type
q-allValid query syntaxSearch all the words
a-phrValid query syntaxExact Phrase
q-lowValid query syntaxAt least one word
q-notValid query syntaxWithout the words
ocallall, title, description, content, urlOccurrence of words
contenttypepdf – 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
languagear – 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
feUTF-8Valid web page encodingEncoding of the search form
colAll available CollectionsExisting collection IDCollection ID
page1Search results page number
page size101 to 1000Number of results per page
xsldefault.xslAny XSL file placed in the /stylesheets directoryName of the XSL file to use
cnameAll available collectionsAny Collection NameName of collection
filterValid query syntaxFilter query
startdateYYYYMMDDHHMMSS
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
enddateYYYYMMDDHHMMSS
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
sortrelevancerelevance
date
alpha
Sort options for the search results
relevance – search result score
date – search result date
alpha – alphabetical sorting of search result title
sortdirascasc or descSort direction for search results – ascending or descending

Faceted Search Request Parameters

Parameter

Default Value

Range of Values

Description

facetononEnable facets
facet.fieldNo default fieldAny standard or custom field including term, number or date fieldsProvides the ability to facet on any field
f.{fieldname}.size101-1000Sets the number of values returned
f.{fieldname}.rangeNo default valueExamples of ranges [TO100000], [1000TO100000], [100TO]Sets the range of values for the filtering
f.{fieldname}.rangeNo default valueExamples 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}.intervalNo default valuePossible values are minute, hour, day, week, month, quarter, yearSets 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

hitsNumber of hits or matches for the query
timeTime taken to return the results of the search query in seconds
queryThe search query
suggestSpelling suggestions if available
filterPreset filter used for the query
sortIndicates how the search results are sorted. The possible values for this attribute are relevance, date and alpha.
sortdirIndicates whether the search results are sorted in ascending or descending order. The possible values for this attribute are asc and desc.
startThe hit or match number of the first search result in this page
endThe hit or match number of the last search result in this page
currentpageThis indicates the current page number for this set of search results
lastpageThis indicates the last possible page number for this set of search results
startdateIndicates the start date for the date range search
enddateIndicates the end date for the date range search
pagesizeNumber 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

noNumber of hits or matches for the query
urlSearch result document URL
lastmodifiedLast modified date of document
indexdateDate the document was indexed
titleTitle of the document
alphaThe text for the search result that is used for alphabetical sorting.
keywordsThe keywords contained in the document
contenttypeThe format of the document
contextThis 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.
descriptionThe description contained in the document
languageLanguage setting for the document
scoreThe relevance score for the document for this query
highlightIndicates terms that have been highlighted
sizeDocument 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