12min

Add document to search index

POST /{appname}/search/{servicename}

This command adds a document to your search index. The document must have the fields specified by the mapping object when you created the index.

Parameters

Path Parameters

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

Request Body

The request body contains two properties:

  • key - string - this is the unique identifier for the search index
  • doc - object - this is the document that will be added to the index.
JSON
|

Examples

Creates a document in the search index named "default".

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.

Example Add Search Service configuration:

Field

Value

Service Name

default

Fields to index

author

Fields to store

id, name, published

Don't forget!

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

Node.js
Curl
|

Responses

Status Code

Description

Example Response

201

Success

{"ok": true}

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