deleteResponse

Response object for successful delete request

SearchFull-Text SearchVector SearchElasticsearch CompatibleOpen SourceDatabase

Properties

Name	Type	Description
table	string	The name of the table from which the document was deleted
deleted	integer	Number of documents deleted
id	integer	The ID of the deleted document. If multiple documents are deleted, the ID of the first deleted document is returned
found	boolean	Indicates whether any documents to be deleted were found
result	string	Result of the delete operation, typically 'deleted'

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/manticore/main/json-schema/deleteResponse.json",
  "title": "deleteResponse",
  "description": "Response object for successful delete request",
  "type": "object",
  "properties": {
    "table": {
      "type": "string",
      "description": "The name of the table from which the document was deleted"
    },
    "deleted": {
      "type": "integer",
      "description": "Number of documents deleted"
    },
    "id": {
      "type": "integer",
      "format": "uint64",
      "description": "The ID of the deleted document. If multiple documents are deleted, the ID of the first deleted document is returned"
    },
    "found": {
      "type": "boolean",
      "description": "Indicates whether any documents to be deleted were found"
    },
    "result": {
      "type": "string",
      "description": "Result of the delete operation, typically 'deleted'"
    }
  },
  "example": {
    "table": "test",
    "deleted": 29
  }
}