OcrTargetObjFieldMapping

Represents the details of how information from a document field is mapped to fields in an object. 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

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the field mapping is active.
  • Default value: false

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:
    • 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

OcrSampleDocFieldId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the associated OCR sample document field.

    This is a relationship field.

  • Relationship Name: OcrSampleDocField
  • Relationship Type: Lookup
  • Refers To: OcrSampleDocumentField

OcrTargetObjectId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: ID of the target object.

    This is a relationship field.

  • Relationship Name: OcrTargetObject
  • Relationship Type: Lookup
  • Refers To: OcrTargetObject

TargetField

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Field to which information is mapped.

    The possible values depend on the license configuration in the org. The supported fields are those belonging to the objects that are available in the TargetObject field of OcrTargetObject. Not all fields of these supported objects are available for mapping.

Type

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The type of document field that’s mapped to the target object. Available in API version 56.0 and later.
  • Default value: FormField
  • Possible values:
    • FormField
    • TableColumn