Navigate
/srt/api/v1/search/navigation
This method filters the current set of results based on the specified facet. The faceted navigation helps you narrow the search results within a subset of results. For example, from the results list you can choose to display only the results that are tagged as Articles. The current result set includes the maximum number of results as defined in the Search Configuration.
Example URI
The example URI for this method is as follows:
-
http://<SEARCH_REST_API_HOST>/srt/api/v1/search/navigation?priorTransactionId=12345&facet=CMS-PRODUCT.TENANT.TABLETS
The request returns a filtered list of search results for the specified facet. The filtering is done based on the specified facet CMS-PRODUCT.TENANT.TABLETS.
-
http://
/srt/api/v1/search/navigation?priorTransactionId=12345&facet=CMS-PRODUCT.RN_PRODUCT_1,CMS-PRODUCT.RN_PRODUCT_2&multiFacets=OR The request returns a set of pre-filtered search results for the specified products RN_PRODUCT_1 or RN_PRODUCT_2.
Request
- application/json
- application/xml
-
facet: string
The facet or category which should be used in narrowing down the search results. The maximum number of facets recommended is 12.
-
facetShowAllFlag: boolean
Returns all the children of the selected facet and the specified facet remains selected.
-
multiFacets(optional): string
If the newly added multiFacets parameter is not passed in or the value is not set, then the last facet of the same facet type is used to ensure API backward compatibility.
-
priorTransactionId: integer
This ID relates to the current result set. This includes the displayed results plus any result up to the max number of results, as defined in the search configuration. If the request is for pagination or navigation, it applies pagination or navigation only to the current result set and doesn't retrieve new results.
object
SearchSession
-
baseURL(optional):
string
Base URL
-
ccaInfo(optional):
object CCAInfo
Title:
CCAInfo
-
clientInfo(optional):
object ClientInfo
Title:
ClientInfo
-
domainGroup(optional):
string
The domain group to use for this request
-
facetPriorTransactionId(optional):
integer
The ID that is set from the transactionId of a previous transaction to retain the facets. You can set the value of this ID to the transactionId of a previous transaction in the same session to retain the facets selected in a previous transaction. You must either set the value of the startOverFlag to false or omit the flag. Omitting the flag defaults to false. You can use the transactionIds from the most recent transaction or five previous transactions in the history to set facetPriorTransactionId of the current transaction. Note that the facetPriorTransactionId applies only to the /question endpoint.
-
isDeflection(optional):
boolean
Is this request an attempt to deflect
-
locale(optional):
string
locale of the request
- navigationApplicationId(optional): string
-
pageSize(optional):
integer
Max results in this page
-
querySource(optional):
string
The query source for this request
-
requestSource(optional):
string
Request Source
-
resultLocales(optional):
string
A comma separted list of the desired resulting locales
-
segment(optional):
string
The analytics segment to associate with this request
-
session(optional):
string
Session Node
-
subject(optional):
string
The subject/vertical to use for this request
-
transactionId(optional):
integer
TransactionId
-
uiMode(optional):
string
The UI mode for this request
object
CCAInfo
-
answerSolutionList(optional):
string
Answer Solution List
-
caseDescription(optional):
string
Case Description
-
connected(optional):
boolean
Connected
-
contentIds(optional):
string
ContentIds
-
extSolutionList(optional):
string
External Solution List
-
name(optional):
string
Name
-
SRKey(optional):
string
SRKey
-
system(optional):
string
System
-
types(optional):
string
Types
object
ClientInfo
-
address(optional):
string
Address
-
agentAddress(optional):
string
Agent Address
-
cookies(optional):
string
Cookies
-
extSessionId(optional):
string
External Session Id
-
host(optional):
string
Host
-
referrer(optional):
string
Referrer URL
-
requestAttributes(optional):
array requestAttributes
list of Map Entries
-
requestHeaders(optional):
array requestHeaders
list of Map Entries
-
requestParameters(optional):
array requestParameters
list of Map Entries
array
-
Array of:
object MapEntry
Title:
MapEntry
array
-
Array of:
object MapEntry
Title:
MapEntry
array
-
Array of:
object MapEntry
Title:
MapEntry
object
MapEntry
-
key(optional):
string
Key Name
-
value(optional):
string
Value
Response
- application/json
- application/xml
200 Response
object
GIML
-
constraints(optional):
object SearchConstraints
Title:
SearchConstraints
-
priorTransactionId(optional):
integer
Prior TransactionId
-
query(optional):
object Query
Title:
Query
-
results(optional):
object RequestResult
Title:
RequestResult
-
session(optional):
string
Session Node
-
transactionId(optional):
integer
TransactionId
object
SearchConstraints
-
baseURL(optional):
string
BaseURL of the SearchConstraints object
-
domainGroup(optional):
string
DomainGroup of the SearchConstraints object
-
language(optional):
string
Language of the SearchConstraints object
- navigationApplicationId(optional): string
-
querySource(optional):
string
QuerySource of the SearchConstraints object
-
requestSource(optional):
string
RequestSource of the SearchConstraints object
-
resultLanguages(optional):
string
ResultLanguages of the SearchConstraints object
-
segment(optional):
string
Segment of the SearchConstraints object
-
subject(optional):
string
Subject of the SearchConstraints object
-
uiMode(optional):
string
UiMode of the SearchConstraints object
object
Query
-
interactive(optional):
boolean
Interactive Spellchecking enabled
-
original(optional):
string
Original Question
-
paraphrase(optional):
string
Paraphrased Question
-
spellchecked(optional):
object Spellchecked
Title:
Spellchecked
object
RequestResult
-
facets(optional):
array facets
To Many Relationship to child facets
-
message(optional):
string
-
messageCode(optional):
string
-
results(optional):
array results
list of textElements
object
Spellchecked
-
corrections(optional):
array corrections
list of SuggestionBO
array
-
Array of:
object Correction
Title:
Correction
object
Correction
-
correction(optional):
string
-
suggestions(optional):
array suggestions
list of SuggestionBO
-
word(optional):
string
array
-
Array of:
object Suggestion
Title:
Suggestion
array
-
Array of:
object FacetResultNode
Title:
FacetResultNode
array
-
Array of:
object ComponentResult
Title:
ComponentResult
object
FacetResultNode
-
children(optional):
array children
To Many Relationship to child facets
-
count(optional):
integer
FacetResultNode of the FacetResultNode object
-
desc(optional):
string
FacetResultNode of the FacetResultNode object
-
id(optional):
string
FacetResultNode of the FacetResultNode object
-
incomplete(optional):
boolean
FacetResultNode of the FacetResultNode object
-
inEffect(optional):
boolean
FacetResultNode of the FacetResultNode object
-
showLink(optional):
boolean
FacetResultNode of the FacetResultNode object
-
tempSelect(optional):
boolean
FacetResultNode of the FacetResultNode object
array
-
Array of:
object FacetResultNode
Title:
FacetResultNode
array
-
Array of:
object ResultItem
Title:
ResultItem
object
ResultItem
-
answerId(optional):
integer
Id of this answer
-
clickThroughLink(optional):
string
The URL contains the file name with original encoding when the search result is an Content(IM) file attachment. Otherwise, the value is same as the URL parameter value.
-
dateModified(optional):
string(date-time)
The date when the Article was last modified
-
docId(optional):
integer
Id of the document corresponding to this answer
-
fileType(optional):
string
type of file that the result item is from, if applicable
-
globalAnswerId(optional):
string
Global AnswerId of this answer
-
highlightedLink(optional):
string
-
link(optional):
string
- relatedIds(optional): array relatedIds
-
rule(optional):
string
rule for result item
-
score(optional):
number
-
similarResponseLink(optional):
string
-
textElements(optional):
array textElements
list of textElements
-
title(optional):
object TextElement
Title:
TextElement
-
type(optional):
string
type of result item
array
-
Array of:
object TextElement
Title:
TextElement
object
TextElement
-
snippets(optional):
array snippets
-
type(optional):
Allowed Values:
[ "UNSTRUCTURED", "STRUCTURED", "STRING", "URL", "HTML" ]
Text element type String, URL, HTML -
url(optional):
string
Examples
The following example shows how to filter the current set of results based on the specified facet by submitting a post request on the REST resource using cURL.
cURL Command
curl -X POST "https://<SEARCH_REST_API_HOST>/srt/api/latest/search/navigation" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"
Example of Request Body
The following shows an example of the request body in JSON format.
{ "session" : "SESSION_VALUE", "transactionId" : -470886747, "facetPriorTransactionId" : 0, "baseURL" : "BASEURL_VALUE", "locale" : "LOCALE_VALUE", "resultLocales" : "RESULTLOCALES_VALUE", "domainGroup" : "DOMAINGROUP_VALUE", "navigationApplicationId" : "NAVIGATIONAPPLICATIONID_VALUE", "segment" : "SEGMENT_VALUE", "querySource" : "QUERYSOURCE_VALUE", "uiMode" : "UIMODE_VALUE", "requestSource" : "REQUESTSOURCE_VALUE", "subject" : "SUBJECT_VALUE", "isDeflection" : true, "clientInfo" : { "agentAddress" : "AGENTADDRESS_VALUE", "extSessionId" : "EXTSESSIONID_VALUE", "referrer" : "REFERRER_VALUE", "cookies" : "COOKIES_VALUE", "address" : "ADDRESS_VALUE", "host" : "HOST_VALUE", "requestHeaders" : [ { "key" : "KEY_VALUE", "value" : "VALUE_VALUE" } ], "requestParameters" : [ { "key" : "KEY_VALUE", "value" : "VALUE_VALUE" } ], "requestAttributes" : [ { "key" : "KEY_VALUE", "value" : "VALUE_VALUE" } ] } }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "constraints" : { "baseURL" : "BASEURL_VALUE", "language" : "LANGUAGE_VALUE", "resultLanguages" : "RESULTLANGUAGES_VALUE", "domainGroup" : "DOMAINGROUP_VALUE", "navigationApplicationId" : "NAVIGATIONAPPLICATIONID_VALUE", "segment" : "SEGMENT_VALUE", "querySource" : "QUERYSOURCE_VALUE", "uiMode" : "UIMODE_VALUE", "requestSource" : "REQUESTSOURCE_VALUE", "subject" : "SUBJECT_VALUE" }, "results" : { "results" : [ { "name" : "NAME_VALUE", "pageNumber" : 119012499, "pageMore" : -1787984382, "pageStart" : 1011298310, "score" : 0.8950256205517777, "pageSize" : -356445925, "unshownResults" : -567000158, "totalResults" : 964064210, "resultItems" : [ { "rule" : "RULE_VALUE", "type" : "TYPE_VALUE", "fileType" : "FILETYPE_VALUE", "answerId" : -2113305261, "docId" : -1406261280, "score" : 0.0, "title" : { "url" : "URL_VALUE", "type" : "HTML", "snippets" : [ { "text" : "TEXT_VALUE", "level" : 1829155447 } ] }, "link" : "LINK_VALUE", "clickThroughLink" : "CLICKTHROUGHLINK_VALUE", "similarResponseLink" : "SIMILARRESPONSELINK_VALUE", "highlightedLink" : "HIGHLIGHTEDLINK_VALUE", "textElements" : [ { "url" : "URL_VALUE", "type" : "UNSTRUCTURED", "snippets" : [ { "text" : "TEXT_VALUE", "level" : -1117285219 } ] } ] } ] } ] }, "session" : "SESSION_VALUE", "transactionId" : -1551467838, "priorTransactionId" : 28680311 }