Industries Common Resources Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Industries Common Resources
AI Accelerator and Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Collections and Recovery
Context Service
Criteria-Based Search and Filter
Data Processing Engine, Batch Management, and Monitor Workflow Services
Digital Lending
Discovery Framework
Decision Explainer
Einstein Relationship Insights
Einstein Standard Invocable Actions
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Intelligent Form Reader Standard Objects
Intelligent Form Reader Business APIs
Intelligent Form Reader Metadata API Types
Intelligent Form Reader Tooling API Objects
Intelligent Form Reader Standard Invocable Actions
Fetch Active OCR Templates Action
Fetch Extracted Text Action
Initiate Text Extraction Action
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Process Compliance Navigator
Record Alerts
Record Rollup Definitions
Scheduled Reminders
Sentiment Insights
Service Process Studio
Timeline
Virtual Calls
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

Fetch Active OCR Templates Action

Fetch all the active OCR templates in an org.

Use this action to automate OCR template selection for the text extracted from an uploaded document.

Special Access Rules

This action is available in API version 58.0 and later for users with the AWSTextract1000LimitAddOn or IntelligentDocumentReaderAddOn license.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/fetchActiveOcrTemplates
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
documentTypeId
Type
string
Description
Optional. The ID of the document type associated with the OCR template.

You can specify up to 20 document type IDs.

Note
targetObjects
Type
string
Description
Optional. The comma-separated list of target object API names associated with the OCR template.

Outputs

Output Details
ocrTemplates
Type
string
Description
The comma-separated list of OCR template records that match the specified document type ID and target objects.

Example

Sample Request

{
   "inputs":[
      {
         "documentTypeId":"0deT10000004CCbIAM,0ghT11000004CCbIF",
         "targetObjects":"Account,Contact"
      }
   ]
}

Sample Response

[
   {
      "actionName":"fetchActiveOcrTemplates",
      "errors":null,
      "isSuccess":true,
      "outputValues":{
         "ocrTemplates":{
            "ocrTemplates":[
               {
                  "ocrTemplateId":"48tT1000000004IIAQ",
                  "ocrTargetObjects":[
                     {
                        "targetObjectRecordType":null,
                        "targetObject":"Account",
                        "ocrTargetObjectId":"97hT100000000HjIAI"
                     },
                     {
                        "targetObjectRecordType":null,
                        "targetObject":"CareDiagnosis",
                        "ocrTargetObjectId":"97hT100000000HoIAI"
                     }
                  ],
                  "name":"bb",
                  "documentTypeId":"0deT10000004CCbIAM",
                  "developerName":"bb"
               },
               {
                  "ocrTemplateId":"48tT10000004CF1IAM",
                  "ocrTargetObjects":[
                     {
                        "targetObjectRecordType":null,
                        "targetObject":"Account",
                        "ocrTargetObjectId":"97hT10000004CelIAE"
                     }
                  ],
                  "name":"scrlicense",
                  "documentTypeId":"0deT10000004CCbIAM",
                  "developerName":"scrlicense"
               },
               {
                  "ocrTemplateId":"48tT1000000004NIAQ",
                  "ocrTargetObjects":[
                     {
                        "targetObjectRecordType":null,
                        "targetObject":"Contact",
                        "ocrTargetObjectId":"97hT100000000HtIAI"
                     }
                  ],
                  "name":"bb2",
                  "documentTypeId":"0ghT11000004CCbIF",
                  "developerName":"bb2"
               }
            ]
         }
      },
      "version":1
   }
]