Return External Document Details and External Document Bytes from 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

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

This request returns external document details and external document bytes from an external batch.

Request Endpoint

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

Sample Curl

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

Sample Request

GET /ExternalBatch/BWB0000000001/ExternalDocument/BWD0000000001

Parameters

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

Response

Multi-part response contains document details and document content.

Sample Response

{}

Response Codes

Code Description
200 Document details and document content returned.
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.