Website logo
⌘K
🖐️Introduction to hyper cloud
🍎Getting Started
😍What's New
Legacy Get Migration Guide
Blueberry Migration Guide
💪Workshops
Deno Workshops
NodeJS Workshops
⚡Quickstarts
NodeJS Quickstarts
🔌API Reference (hyper cloud)
🍎Basics
⚡hyper connect
🔑JWT Auth
💾Data API
🏎️Cache API
🔎Search API
🗄️Storage API
🤓Queue API
🔓Sign In
⚡Applications
⚙️Settings
🔑App Keys
👥Teams
Switching Between Accounts
Application Services
Application Service Instances
Adding a Queue Service
Adding a Search Service
Subscriptions
🤑Upgrade
📕Terminology
Parameters
💳Billing
Payment and Pricing Terms
💼Legal
Terms of Service
Acceptable Use Policy
Privacy Policy
🕶️Hyper Vision
Docs powered by Archbee
API Reference (hyper cloud)
Data API

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'
}
*/


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?
PREVIOUS
Create a Document
NEXT
List Documents
Docs powered by Archbee
TABLE OF CONTENTS
GET /{appname}/data/{servicename}/{_id}
Parameters
Path
Examples
Don't forget!
Responses
Need Help?
Docs powered by Archbee