Partially Update Documents

Perform partial updates on documents using MongoDB query and update operations. Returns the number of documents updated. Returns 0 if no documents matched — this is a successful response, not an error. $setOnInsert has no effect because AppDB partial updates do not perform upserts.

Supported update operators: currentDate, inc, min, max, mul, rename, set, unset, addToSet, pop, pull, pullAll, push

Supported modifiers: each, position, slice, sort

See the MongoDB Update Operators documentation for details.

PUT /api/datastores/v2/collections/{collectionId}/documents/update

cURL

set-field

curl --request PUT \
  --url https://{instance}.domo.com/api/datastores/v2/collections/{collectionId}/documents/update \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "query": {
    "content.status": "Draft"
  },
  "operation": {
    "$set": {
      "content.status": "Active"
    }
  }
}
'

200

1

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication.

Path Parameters

collectionId · string · required

The ID of the collection.

Body

application/json

query · object · required

MongoDB query that identifies the documents to update.

operation · object · required

MongoDB update operation to apply.

Response

200

application/json

Returns the number of updated documents or properties.

The response is of type integer.

Example:

1