13min

Get Search Document

GET /{appname}/search/{servicename}/{key}

This command will retrieve an indexed document by key name.

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.

Parameters

Path Parameters

  • appname - string - the name of your hyper cloud application.
  • servicename - string - the name of your hyper cloud service. see Parameters.
  • key - string
    • value requirements
      • must begin with a lowercase letter (a-z)
      • must be lowercase letters (a-z)
      • digits (0-9)
      • any of these characters _ $ + -

Example

Retrieve a document from a search instance named "default".

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

200

Success

{"ok": true}

404

Not Found

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

500

Error

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

Need Help?

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

ο»Ώ