Update a Document

8min

PUT /{appname}/data/{servicename}/{_id}
This command updates an existing document in your data service, you can change/add any property on the JSON document except the _id property it must stay the same. If you need to change the _id, simply remove the existing document and create a new document with the new _id.
The update command only supports full document updates, not partial updates.
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.
See Parameters﻿﻿
Request Body
A JSON document with one-to-many fields, an _id field is required. No other fields that start with _ are allowed. Each field name must follow the following rules:
must begin with a lowercase letter (a-z), unless it is the _id field.
must be lowercase letters (a-z)
digits (0-9)
any of these characters _ $ + -  
Request Payload Limit
When creating or updating a document within the Data service, the request body payload size limit for the Data service is 5MB.
JSON
{
    "_id": "unique identifier",
    ...
}
{
    "_id": "unique 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 doc = {_id: "movie-5", title: "Better Off Dead", type: "movie", year: "1986"}
const result = await hyper.data.update("movie-5", doc).then(updateResult => {
    console.log('update result', updateResult)
    return hyper.data.get("movie-5")
})

console.log(result)

/*
update result { ok: true, id: 'movie-5' }
{
  _id: 'movie-5',
  title: 'Better Off Dead',
  type: 'movie',
  year: '1986'
}
*/
import { connect } from "hyper-connect";

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

const doc = {_id: "movie-5", title: "Better Off Dead", type: "movie", year: "1986"}
const result = await hyper.data.update("movie-5", doc).then(updateResult => {
    console.log('update result', updateResult)
    return hyper.data.get("movie-5")
})

console.log(result)

/*
update result { ok: true, id: 'movie-5' }
{
  _id: 'movie-5',
  title: 'Better Off Dead',
  type: 'movie',
  year: '1986'
}
*/
﻿
Responses
When making a request to this endpoint you can get the following responses returned:
Status Code
Description
Response
201
Successfully updated document
{"ok": true, "id": "1234"}
500
An error occurred trying to update the document
{"ok": false, "msg": "..."}
Need Help?
You can always reach out to our support team for any additional assistance on slack.
﻿

Updated 03 Mar 2023

Did this page help you?

Run a Query

Delete a Document

Docs powered by Archbee

TABLE OF CONTENTS

PUT /{appname}/data/{servicename}/{_id}

Parameters

Path

Request Body

Request Payload Limit

Status Code	Description	Response
201	Successfully updated document	{"ok": true, "id": "1234"}
500	An error occurred trying to update the document	{"ok": false, "msg": "..."}