Delete a Document from an External Batch - Brainware Intelligent Capture - Foundation 23.1 - Foundation 23.1 - Brainware - external

Brainware API Requests

Brainware Intelligent Capture
Foundation 23.1

DELETE /api/v1/ExternalBatch/{ExternalBatchRef}/ExternalDocument/{ExternalDocumentRef}

This request deletes a document from an external batch.

An external document can be deleted from an external batch provided that the external batch is at a status less than 20.

Request Endpoint


Sample Curl

curl -X DELETE --header 'Accept: application/json' --header 'Pragma: no-cache' --header 'Cache-Control: no-cache' 'http://localhost/BrainwareAPI/api/v1/ExternalBatch/BWB0000000001/ExternalDocument/BWD0000000001'

Sample Request

DELETE --header 'Accept: application/json' --header 'Pragma: no-cache' --
header 'Cache-Control: no-cache'
DELETE /ExternalBatch/BWB0000000001/ExternalDocument/BWD0000000001


Parameter Description Type Required
ExternalBatchRef External batch reference string Required
ExternalDocumentRef External document reference string Required

Sample Response


Response Codes

Code Description
204 External document deleted.
404 External batch and/or document does not exist, or document is not in this external batch.
422 External batch and/or document reference is invalid.
423 External batch is marked "Ready for Import" or RTS processing has already started.