MLDataDefinition | Tooling API | Salesforce Developers

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
DeveloperName	Type string Properties Filter, Group, Nillable, 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. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow as a DeveloperName is generated for each record. Note
EntityDeveloperName	Type string Properties Filter, Group, Nillable, Sort Description The developer name of the object from which the model data is retrieved. After the MLDataDefinition entity is created, `EntityDeveloperName` can’t be updated. Note
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated MLDataDefinition type in Metadata API. The full name can include a namespace prefix. 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 The language of the MLDataDefinition.
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`
MasterLabel	Type string Properties Filter, Group, Nillable, Sort Description Label that identifies the MLDataDefinition throughout the Salesforce user interface.
Metadata	Type MLDataDefinition Properties Create, Nillable, Update Description The metadata of MLDataDefinition. 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.
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.
ParentDefinitionId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the MLrecommendationDefinition or MLPredictionDefinition that this MLDatadefinition belongs to. This is a polymorphic relationship field. Relationship Name ParentDefinition Relationship Type Lookup Refers To MLPredictionDefinition, MLRecommendationDefinition
ScoringFilterId	Type reference Properties Filter, Group, Nillable, Sort Description Specifies the record ID to which the prediction scores are written. This is a relationship field. Relationship Name ScoringFilter Relationship Type Lookup Refers To MLFilter
SegmentFilterId	Type reference Properties Filter, Group, Nillable, Sort Description Specifies the record IDs of the data used for training and scoring. This is a relationship field. Relationship Name SegmentFilter Relationship Type Lookup Refers To MLFilter
TrainingFilterId	Type reference Properties Filter, Group, Nillable, Sort Description Specifies the record IDs that make up the training set. This is a relationship field. Relationship Name TrainingFilter Relationship Type Lookup Refers To MLFilter
Type	Type picklist Properties Filter, Group, Restricted picklist, Nillable, Sort Description Specifies the data type. Valid values are: `Candidate` `Interaction` `Prediction` `Recipient` After the model is created, `type` can’t be updated.. Note