POST /document/update
Update Document
Update documents using composable infra architecture.
Request Body (UpdateDocumentApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
documents | UpdateDocumentItem[] | No | List of documents to update (required on first call when all is false) |
all | boolean | No | When true, apply patch to every document matching the filter fields below (minus excluded_ids) |
excluded_ids | string[] | No | UUIDs to skip even when matched by all-mode filters |
patch | UpdateDocumentPatch | No | Shared change set applied to every matched row when all=true (sparse — only set fields are updated; patch.id ignored) |
search | string | No | Full-text search query |
scenario_ids | string[] | No | Filter by scenario UUIDs |
field_ids | string[] | No | Filter by field UUIDs |
filter_department_ids | string[] | No | Filter by department UUIDs |
scenario_search | string | No | Search text for scenario facet (no-op for row filtering) |
field_search | string | No | Search text for field facet (no-op for row filtering) |
department_search | string | No | Search text for department facet (no-op for row filtering) |
flag_search | string | No | Search text for flag facet (no-op for row filtering) |
idempotency_key | string | No | Operation key for ack — promotes or rejects a dormant update |
soft | boolean | No | Stage the update dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it |
accept | boolean | No | Accept (promote) or reject dormant state. Only meaningful with idempotency_key |
Response (UpdateDocumentApiResponse)
| Field | Type | Required | Description |
|---|---|---|---|
results | DocumentResultItem[] | Yes | List of operation results |
idempotency_key | string | No | Idempotency key echoed back for client correlation |
Last updated on