Process data

cmd (required)

The operation to perform. Valid values: add, update, delete.

update is not supported for standard applications. Use add instead.

add

Creates a document. If a document with the same primary key already exists, OpenSearch deletes the original before creating the new one.

{
  "cmd": "add",
  "fields": {
    "id": "1",
    "title": "This is the title",
    "body": "This is the body"
  }
}

update

Updates the specified fields in an existing document. Only the fields you include in the request are modified.

{
  "cmd": "update",
  "fields": {
    "id": "2",
    "title": "This is the new title"
  }
}

delete

Deletes the document with the specified primary key. If no document with that primary key exists, the delete operation still executes.

{
  "cmd": "delete",
  "fields": {
    "id": "3"
  }
}

fields (required)

The document fields to operate on. Always include the primary key field — OpenSearch uses it to identify the document.

For a delete operation, only the primary key field is required.

For fields of the ARRAY type, specify the value as a JSON array:

[
  {
    "cmd": "add",
    "fields": {
      "id": "0",
      "int_array": [14, 85],
      "string_array": ["abc", "xyz"]
    }
  }
]

timestamp (optional, advanced applications only)

The time the operation was performed, in milliseconds. OpenSearch uses this to determine the order of operations on the same primary key.

If omitted, OpenSearch uses the time it receives the request.

Standard applications do not support timestamp. If you include it in a request to a standard application, OpenSearch returns error code 4007.