afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/MLDataDefinition.json

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields"
  ],
  "title": "MLDataDefinition - Tooling API",
  "description": "Represents a modeling data definition, which specifies the data used to create a model for a machine learning (ML) application. Examples of such data can include filters, fields to include, and fields to exclude. Available from API version 50.0 or later.",
  "supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
  "supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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. Note: 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."
    },
    "EntityDeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The developer name of the object from which the model data is retrieved. Note: After the MLDataDefinition entity is created, EntityDeveloperName can’t be updated."
    },
    "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 Note: After the model is created, type can’t be updated.."
    }
  }
}