Industries Common Resources Developer Guide

Industries Common Resources
AI Accelerator
Business Rules Engine
Data Processing Engine, Batch Management, and Monitor Workflow Services
Discovery Framework
Decision Table
Intelligent Document Reader
Intelligent Form Reader
Intelligent Form Reader Standard Objects
Intelligent Form Reader Business APIs
OCR Metadata API Types
OCR Tooling API Objects
OcrSampleDocument
OcrSampleDocumentField
OcrSampleDocumentPage
OcrTargetObject
OcrTargetObjFieldMapping
OcrTemplate
OcrTemplateSampleDocument
Interest Tagging
Omnistudio Business APIs
Record Alerts
Sentiment Insights
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

Newer Version Available

This content describes an older version of this product. View Latest

OcrSampleDocument

Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form. This object is available in API version 52.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

To use this tooling API object, your Salesforce org must have the AWSTextract1000LimitAddOn license.

Fields

Field Details
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

Note
DocumentHeight
Type
double
Properties
Filter, Nillable, Sort
Description
Normalized height of the OCR sample document page.
FullName
Type
string
Properties
Create, Group, Nillable
Description
Full name of the associated metadata type in Metadata API.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Language of the OCR sample document.
ManageableState
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package.
Possible values are:
  • beta—Managed-Beta
  • deleted—Managed-Proposed-Deleted
  • deprecated—Managed-Proposed-Deprecated
  • deprecatedEditable—SecondGen-Installed-Deprecated
  • installed—Managed-Installed
  • installedEditable—SecondGen-Installed-Editable
  • released—Managed-Released
  • unmanaged—Unmanaged
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Label of the OCR sample document.
Metadata
Type
complexvalue
Properties
Create, Nillable, Update
Description
OCR sample document metadata.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix.