Delete a document

Removes a document from a table field's full-text index, including its stored text and facet values.

POST /v1/tenants/{tenant}/fts/{table}/{field}/delete

Remove one document's searchable textSuccessful removal does not prove the document previously existed.

Identify the text entrySelect table, field and document ID.
Remove its indexed contentDelete terms, stored text and facet values.
Read the deletion resultKeep source-row deletion separate if also required.

Before you start

Use your database bearer token.

Connection setup

Use the document ID and text field to remove. The example removes p1 from demo_docs/body.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`table`	`string`	Required
`field`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Request body

application/json

Limits and accepted values

Idempotent: deleting a document that was never indexed also succeeds.

Field	Type	Required
`doc_id`	`string`	Required

Read the result

deleted: true also applies when the document was never indexed. Treat it as confirmation that the requested removal succeeded, not as proof that the document previously existed.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
409	Resolve the conflict before retrying.
413	Split or reduce the request body.
415	Send the required Content-Type.
422	Correct the values or unsupported combination.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/fts/demo_docs/body/delete" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "doc_id": "p1"
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "deleted": true
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Request bodyCopy Anchor Link