Skip to Content

POST /document/delete

Delete Document

Bulk delete documents — composable infra architecture.

Request Body (DeleteDocumentApiRequest)

FieldTypeRequiredDescription
document_idsstring[]NoDocument UUIDs to delete (required on first call when all is false)
allbooleanNoWhen true, delete every document matching the filter fields below (minus excluded_ids)
excluded_idsstring[]NoUUIDs to skip even when matched by all-mode filters
searchstringNoFull-text search query
scenario_idsstring[]NoFilter by scenario UUIDs
field_idsstring[]NoFilter by field UUIDs
filter_department_idsstring[]NoFilter by department UUIDs
scenario_searchstringNoSearch text for scenario facet (no-op for row filtering)
field_searchstringNoSearch text for field facet (no-op for row filtering)
department_searchstringNoSearch text for department facet (no-op for row filtering)
flag_searchstringNoSearch text for flag facet (no-op for row filtering)
idempotency_keystringNoOperation key for ack — confirms or rejects a dormant delete
softbooleanNoStage the delete dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept (confirm deletion) or reject (restore). Only meaningful with idempotency_key

Response (DeleteDocumentApiResponse)

FieldTypeRequiredDescription
resultsDeleteDocumentResult[]YesList of operation results
idempotency_keystringNoIdempotency key echoed back for client correlation
Last updated on