Skip to navigation

Edit one row of an extracted document

View as Markdown

Overwrites extracted field values on ONE row of a terminal rows_per_document extract run. Body: { fields: { <fieldKey>: <value> } }, the same shape the document edit takes. A field whose value changes LOSES its source citation (the evidence no longer backs a human-supplied value); untouched fields, and every other row, keep theirs. Rows are addressed by their zero-based index in the extracted order, which is stable for a finished run. Requires space:contribute (denied → 403). A run stays editable for 7 days after it starts; after that an edit answers 404 state_gone. The same 404 covers a document that is not a table-rows one and an index out of range. Results stay readable through getRunResult.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired
runIdstringRequired
docIdstringRequired
rowIndexstringRequiredformat: "^\d+$"

Request

This endpoint expects an object.
fieldsmap from strings to anyRequired

Field key → new value. A field whose value changes loses its source citation; untouched fields keep theirs.

Response

The edited row.
savedboolean
syncedboolean

False when the durable result was not refreshed. With changed or edited true, the edit is stored but a later read still returns the old value: save again to publish it. With both false, nothing needed publishing and there is nothing to retry.

changedboolean
False when nothing in the patch differed.
editedboolean

The stored document carries a human edit, from this request or an earlier one. Tells a synced: false that is waiting to be published apart from one that had nothing to publish.

rowinteger-9007199254740991-9007199254740991

Zero-based index of the edited row, echoed back.

datamap from strings to anyOptional
evidencemap from strings to lists of maps from strings to anyOptional

Errors

400
Bad Request Error
404
Not Found Error