Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Application API / chatbotKnowledgeSearch

Operation Information

  • Application Reference: com.hornbill.servicemanager
  • Scope: Global
  • Class: Application
  • Required Privilege Level: user
  • Required Rights: Group H - executeSystemAPIs

Description

This operation is responsible for querying various entities via chatbot integrations, and returns relevant search results

Request Parameters

The chatbotKnowledgeSearch API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
entities xs:string Yes Array of Entities to Search against i.e. ["Faqs", "PublishedRequests","Requests"]
userId xs:string Yes ID of the user to search against
searchQuery xs:string Yes The User's Search Query
serviceId xs:string No The service ID
site xs:string No The site
category xs:string No The category
rowStart xs:integer Yes Used for paginating the results
limit xs:integer Yes Used for paginating the results
getCount xs:boolean No If true, then returns the total number of results
getData xs:boolean No If true, then returns the results
openRequestsOnly xs:boolean No If true, then returns the open requests only

Response Parameters

Name Type Description
searchResults xs:string List of results
totalSearchResults xs:string The total count of the results
exceptionName xs:string The name of the exception, if any exception occurs
exceptionDescription xs:string The description of the exception, if any exception occurs

Code Examples

In This Document