Update a Document

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.

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 _ $ + -

{
    "_id": "unique identifier",
    ...
}

Examples

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: