AIUsecaseFieldMapping | Industries Common Resources Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field	Details
AiUsecaseDefinitionId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. The ID of the use case definition that’s related to the field mapping. This is a relationship field. Relationship Name AiUsecaseDefinition Relationship Type Lookup Refers To AIUsecaseDefinition
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The developer name of the use case field mapping. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the use case field mapping.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged` Available in API version 56.0 and later.
MappedFieldName	Type string Properties Create, Filter, Group, Sort, Update Description The name of the field where the prediction scoring response is stored.
MappedFieldType	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of the response field. Valid values are: `FEATURE` `INSIGHT` `PREDICTION_SCORE` `SUGGESTION` The default value is `FEATURE`.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The label for the use case field mapping.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects. Available in API version 56.0 and later.
ResponseFieldName	Type string Properties Create, Filter, Group, Sort, Update Description The name of the response object’s field that’s mapped to the field storing the scoring response.
ResponseObject	Type string Properties Create, Filter, Group, Sort, Update Description The object whose field is mapped to the field storing the scoring response.
SequenceNumber	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The sequence number for the information stored in the field mapping.