Uploads

Cancel one of the upload's document jobs, with the job read's auth and scoping, whatever DOCUMENT_JOBS_ENABLED says. A queued job (or one backing off after a failure, which no delivery holds) ends cancelled at once; a running job is flagged (cancelRequested) and its delivery ends it cancelled between units, never inside one. A cancelled analysis ends "error" with the message "Cancelled", keeping the rows its finished units wrote; Re Analysis reads the document again. A cancelled submit keeps the records its committed chunks wrote and is settled exactly as a failed submit, so the upload records what remains. A GreenBot chat waiting on the job is told it was cancelled. Repeating the cancel answers the same way. A job already past its last unit (a submit whose chunks all committed, an analysis in its finish) is not stopped: its finish runs and it ends succeeded or failed (e.g. MONEY_UNRECONCILED), so a client polls until any terminal status.

post/uploads/{id}/factor-agent/jobs/{documentJobId}/cancel

Path parameters

idinteger required
documentJobIdstring required

Response

The job after the cancel: cancelled, or still queued or running with cancelRequested true until its delivery ends it.

Changes

Changed in 1 of the 7 revisions of this API.1