Skip to content

EntityCreateExternalFieldMapping

Experimental

Maps an external source field to its internal column.

Properties

Property Type Description
directionType DataDirectionType Experimental Read-only vs read/write direction for this field.
externalFieldDisplayName? string Experimental Display name of the external source field.
externalFieldName string Experimental Name of the field on the external source (for a native source, the column name). Joins refer to a field by this name.
externalFieldType? string Experimental Type of the field on the external source, as the source reports it (for example string).
isRequiredForRead? boolean Experimental Whether the source needs this field's value to read the object at all (a required List parameter).
searchability? Searchability Experimental Whether and how the field can be filtered, as the source reports it. Without it the field cannot be used in filters.
sortable? boolean Experimental Whether the entity can be sorted on this field.