Search
This endpoint API allows you to perform search against any of the Entities available given that the authenticated user has access to the Entity. The query is an “HTTP GET” call that returns an array of results for an entity in JSON format.
Search API uses full text search capabilities, ignores the noise words and sorts the results based on ranking of the data and the search keywords provided.
GET https://<your-portal-domain>/rest/2.0/search?q=<search query string>
-H "Authorization: Bearer <token>"
-H "Content-Type: application/json"
-H "Accept: application/json"
Below is the general format of search query strings:
Query Format:
FIND {keywords} IN <entityName>
WHERE <conditions>
ORDER BY <field direction>
LIMIT <n>
SELECT <field1>, <field2>, <field3>
Below is sample search query for finding 10 most relevant knowledge articles for a given search term:
FIND {cannot connect to IDP using SAML} IN BlogPost
WHERE Blog.BlogName = "Knowledge Base"
LIMIT 10