Return External Document Details and External Document Bytes - 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/ExternalDocument/{ExternalDocumentRef}

This request returns external document details, such as file name, index, and upload time, as well as external document content.

Request Endpoint

/api/v1/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/ExternalDocument/BWD0000000001'

Sample Request

GET /ExternalDocument/BWD0000000001

Parameters

Parameter Description Type 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 document does not exist.
422 External document reference is invalid.