Sign in

v47

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-06-17465244.2 KB
Database Management

Add an Element to an Array in a Document

Add an Element to an Array in a Document. You can pass in the Document ID and the Field/Key that you want to add an element to and we will add the element to the Array for you. If the Array does not exist, we will create a new Array and add the element to it.

post/api/collections/data/array/update/add

Request body

collectionstring

The Name of the Collection or the Group where you want to store all your data.

docIdstring

The ID of the Document that you want to update.

fieldstring

The Field/Key that you want to increment or decrement.

Example request

{
  "collection": "Users",
  "docId": "1234567890",
  "field": "identities",
  "arrayUnion": "sfdcsfc"
}

Response

Output from the Database Collection Edits Process

statusstring

Status indicating the success of the text moderation.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_countinteger

The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

Example response

{
  "status": "success",
  "processing_time": 888,
  "processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
  "processing_count": 6554,
  "data": {
    "databaseId": "1234567890",
    "collection": "Users",
    "elapsed_time": 800,
    "documentId": "1234567890"
  }
}