Newer Version Available
OCR Text Extraction (GET, POST)
Retrieve details of the extracted key-value pairs for a document from
the latest version of the OCR document scan result. Create an OCR document scan result record
using the extracted text from the latest version of a document.
- Resource
-
1/connect/form-reader/contentDocuments/${contentDocumentId}/ocrDocumentScanResults
- Examples for GET
-
1https://yourInstance.salesforce.com/services/data/vXX.X/connect 2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults -
1https://yourInstance.salesforce.com/services/data/vXX.X/connect 2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults?startPageIndex=1 -
1https://yourInstance.salesforce.com/services/data/vXX.X/connect 2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults?endPageIndex=1 -
1https://yourInstance.salesforce.com/services/data/vXX.X/connect 2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults?startPageIndex=1&endPageIndex=1 - Example for POST
-
1https://yourInstance.salesforce.com/services/data/vXX.X/connect 2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults - Available version
- 55.0
- Requires Chatter
- No
- HTTP methods
- GET, POST
- Request parameters for GET
-
Parameter Name Type Description Required or Optional Available Version endPageIndex Integer Page number in the document to end extraction. Optional 55.0 startPageIndex Integer Page number in the document to start extraction. Optional 55.0 - Response body for GET
- Document Extraction Output
- Request body for POST
-
JSON examples
1{ 2 3 "startPageIndex" : 4, 4 "endPageIndex" : 4 5}1{ 2 "startPageIndex" : 4 3}1{ 2 "endPageIndex" : 4 3} -
Parameter Name Type Description Required or Optional Available Version endPageIndex Integer Page number in the document to end extraction. Optional 55.0 startPageIndex Integer Page number in the document to start extraction. Optional 55.0 - Response body for POST
- Trigger Text Extraction Output