Delete an External Batch - Brainware Intelligent Capture - Foundation 23.1 - Foundation 23.1 - Brainware - external

Brainware API Requests

Platform
Brainware
Product
Brainware Intelligent Capture
Release
Foundation 23.1
License

DELETE /api/v1/ExternalBatch/{ExternalBatchRef}

This request deletes an external batch.

An external batch can be deleted provided that RTS processing has not yet started.

Deleting an external batch also deletes any documents contained within the external batch.

Request Endpoint

/api/v1/ExternalBatch/{ExternalBatchRef}

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'

Sample Request

DELETE /ExternalBatch/BWB0000000001

Parameters

Parameter Description Type Required
ExternalBatchRef External batch reference string Required

Sample Response

{}

Response Codes

Code Description
204 External batch deleted.
404 External batch does not exist.
422 External batch reference is invalid.
423 RTS processing has already started.