Retrieve a Document By Id

6min

GET /{appname}/data/{servicename}/{_id}
Get a single document by _id. This command will return the full JSON document identified by the URL _id parameter.
This API is changing! See Legacy Get Migration﻿ for details.
Parameters
Path
appname - string - the name of your hyper cloud application. 
servicename - string - the name of your hyper cloud service.
_id - string - unique document identifier
Examples
Don't forget!
Be sure to set your HYPER environment variable with the value of your hyper app's connection string.
Node.js
Curl
import { connect } from "hyper-connect";

const hyper = connect(process.env.HYPER);

const result = await hyper.data.get("movie-5")

console.log(result)

/* => {
  _id: 'movie-5',
  title: 'Better Off Dead',
  type: 'movie',
  year: '1985'
}
*/
import { connect } from "hyper-connect";

const hyper = connect(process.env.HYPER);

const result = await hyper.data.get("movie-5")

console.log(result)

/* => {
  _id: 'movie-5',
  title: 'Better Off Dead',
  type: 'movie',
  year: '1985'
}
*/
﻿
Responses
Status Code
Description
Example Response
200
Successfully retrieved document
{...}
404
Not Found
{"ok": false, "msg": "not found"}
500
Error
{"ok": false, "msg": "server error occured"}
Need Help?
You can always reach out to our support team for any additional assistance on slack.
﻿

Updated 21 Feb 2023

Did this page help you?

Create a Document

List Documents

Docs powered by Archbee

TABLE OF CONTENTS

GET /{appname}/data/{servicename}/{_id}

Status Code	Description	Example Response
200	Successfully retrieved document	{...}
404	Not Found	{"ok": false, "msg": "not found"}
500	Error	{"ok": false, "msg": "server error occured"}