14min

Search Index

POST /{appname}/search/{servicename}/_query

Query the search index by including a JSON object containing a query property with the value of your search string. You can optionally include:

  • a fields property containing a list of fields you would like to target the search against
  • a filter property which is an object of key/value pairs to filter the search results

Parameters

Path parameters

  • appname - string - the name of your hyper cloud application.
  • servicename - string - the name of your hyper cloud service.

Request Body

  • query - string - the text you would like to search for matches
  • fields - array[string] - a list of fields you would like to target the search against [optional]
    • Each string in the array should match a property in the Fields to store list in the indexed document. See Adding a Search Service.
  • filter - object - this object contains key/value pairs that should reduce the results based on the result of the filter. [optional]. Each key should match a property in the Fields to store list that you provided when you created the search index. See Adding a Search Service.
JSON
|

Examples

We are searching for all books within the default index where the author is "Frank Herbert".

Don't forget!

Be sure to set your HYPER environment variable with the value of your hyper app's connection string.

You'll need a search service

ο»ΏBe sure to add a search service and provide the following details within the Add Search Service form. This will create a search service instance named default and create an index based on the author field. This way we can search for books by the author.

Node.js
Curl
|

Responses

Status Code

Description

Example Response

200

Success

{"ok": true, "matches": [...]}

500

Error

{"ok": false, "msg": "..."}

Need Help?

You can always reach out to our support team for any additional assistance on slack.

ο»Ώ

Updated 24 Mar 2022
Did this page help?
Yes
No