Restore document extraction

Restores an archived inbox document as the app's Restore does: the bank line its archive let go is linked again while it is still free, and the duplicate pairs the archive settled are asked again. meta.restore_notes lists what did not come back as it was, each a stable code and a plain message: payment_link_released (the line was paid, booked or picked for another document meanwhile: pick the payment again in Cybooks) and duplicate_decision_reopened (settle the duplicate again, documentExtraction.duplicate.review); empty when everything came back. A document that is not archived answers 404, as an unknown id does. A file that was split answers 409 document_extraction_not_restorable with error.fields.reason restore_split (undo the split in Cybooks); a converted, merged or still-processing document 409 document_extraction_history_protected. Requires If-Match with the document ETag and an Idempotency-Key (a retry with the same key returns the first answer). Requires the document-extractions:write OAuth scope and the delete_document_extractions permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*