Create a machine learning model
post
/crmRestApi/resources/11.13.18.05/salesMLModels
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdditionalMetadata: string
The object version number for the record.
-
CriteriaFilterExpr: string
A previously defined object filter criteria and mapping that specifies the list of records that will be exported.
-
DebugFlag: boolean
Indicates if the model is in debug mode.
-
DebugMessage: string
The message associated with the debug mode.
-
DeployFlag: boolean
Indicates if the field can be deployed.
-
JobDescription: string
Maximum Length:
1040
The description of the model. -
JobId: integer
(int64)
The unique identifier of the model.
-
JobName(required): string
Maximum Length:
2000
The name of the machine learning model. -
JobStatus: string
Maximum Length:
255
The status of the machine learning model. -
NumofFeatures: integer
The number of selected attributes for the model.
-
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
QueryMetadata: string
The details of the query associated with the model.
-
QueryResultSet: string
The results of the query associated with the model.
-
Schedule: string
Maximum Length:
1000
The schedule used to run the machine learning experiment. -
Status: string
Maximum Length:
80
The status of the machine learning model. -
StorePredCriteriaFilter: string
The filter criteria to define the prediction data-set and store predictions for sales machine learning model.
-
StorePrediction: string
Maximum Length:
1
The ability to store predictions when executing a sales machine learning model. -
StorePredProbColumnName: string
Maximum Length:
60
The outcome of the sales machine learning model stored as prediction value. -
StorePredSchedule: string
Maximum Length:
1000
The ability to store predictions when executing a sales machine learning model. -
StorePredValueColumnName: string
Maximum Length:
60
The name of the column to store prediction value for sales machine learning model. -
SubmitFlag: boolean
Indicates if the model can be submitted.
-
UsecaseCode(required): string
Maximum Length:
200
The unique identifier of the use case used to find a use case. -
UsecaseName: string
The name of the use case.
-
ZcaOmlFixedFieldRules: array
Model Validation and Transformation Rules
Title:
Model Validation and Transformation Rules
Model Validation and Transformation Rules -
ZcaOmlJobsSelFields: array
Model Selected Fields
Title:
Model Selected Fields
Model Selected Fields -
ZcaOmlJobStatistics: array
Machine Learning Job Statistics Details
Title:
Machine Learning Job Statistics Details
Model Statistics -
ZcaOmlUsecaseFixedFields: array
Use Case Selected Fields
Title:
Use Case Selected Fields
Sales Machine Learning Selected Features
Nested Schema : Model Validation and Transformation Rules
Type:
array
Title:
Model Validation and Transformation Rules
Model Validation and Transformation Rules
Show Source
Nested Schema : Model Selected Fields
Type:
array
Title:
Model Selected Fields
Model Selected Fields
Show Source
Nested Schema : Machine Learning Job Statistics Details
Type:
array
Title:
Machine Learning Job Statistics Details
Model Statistics
Show Source
Nested Schema : Use Case Selected Fields
Type:
array
Title:
Use Case Selected Fields
Sales Machine Learning Selected Features
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AdditionalMetadata: string
(byte)
The additional details about the machine learning model.
-
FieldName: string
Maximum Length:
200
The root keyword associated with the synonym. -
FieldRuleCode: string
Maximum Length:
800
The unique identifier of the rule. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RuleCode: string
Maximum Length:
200
The unique identifier of the rule. -
RuleValue: string
(byte)
The value of the rule associated with the model.
-
UsecaseCode: string
Maximum Length:
200
The code associated with the use case.
Nested Schema : schema
Type:
Show Source
object
-
AdditionalMetadata: string
The object version number for the record.
-
FieldDataType(required): string
Maximum Length:
200
The date type of the selected field such as boolean, string, and so on. -
FieldName(required): string
Maximum Length:
800
The name of the field associated with the ML model. -
FieldTitle: string
Maximum Length:
800
The display name of the available field. -
IsFeature: string
Maximum Length:
20
Indicates if the field is a feature or not. The valid values are Yes, No, or Null. -
JobId(required): integer
(int64)
The unique identifier used to find the model.
-
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
UsecaseCode(required): string
Maximum Length:
200
The unique identifier of the use case used to find a use case. -
ZcaOmlJobRules: array
Model Validation and Transformation Rules
Title:
Model Validation and Transformation Rules
Sales Machine Learning Model Rules
Nested Schema : Model Validation and Transformation Rules
Type:
array
Title:
Model Validation and Transformation Rules
Sales Machine Learning Model Rules
Show Source
Nested Schema : salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-post-request
Type:
Show Source
object
-
FieldName: string
Maximum Length:
800
The name of the selected field. -
JobId: integer
(int64)
The unique identifier of the model.
-
JobRuleId: integer
(int64)
The unique identifier of the validation or transformation rule.
-
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RuleCode: string
Maximum Length:
200
The unique identifier of the validation or transformation rule. -
RuleValue: string
The value of the rule associated with the model.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case.
Nested Schema : schema
Type:
Show Source
object
-
AdditionalMetadataJson: string
The additional JSON details of the machine learning model.
-
DataSourceName: string
Maximum Length:
700
The name of the data source associated with the use case. -
DataSourceSQL: string
The SQL query for the data source associated with the use case.
-
DataSourceType: string
Maximum Length:
80
The type of the data source associated with the use case. -
ExplainabilityMetrics: string
The metrics used to explain the model and its performance.
-
JobId: integer
(int64)
The unique identifier used to find the model.
-
JobName: string
Maximum Length:
2000
The name of the machine learning model. -
JobRunId: integer
(int64)
The unique identifier of the job run.
-
ModelAccuracy: string
Maximum Length:
200
The accuracy of the machine learning model. -
ModelStatus: string
Maximum Length:
20
The status of the machine learning model. -
ModelType: string
Maximum Length:
200
The model type associated with the use case. The type of the model depends on the task you want to perform. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RangeValues: string
The range of possible values for underlying model attributes.
-
SelectedAlgorithm: string
Maximum Length:
200
The algorithm selected for the use case.
Nested Schema : schema
Type:
Show Source
object
-
AdditionalMetadata: string
(byte)
The object version number for the record.
-
FieldDataType: string
Maximum Length:
200
The data type of the field such as string, boolean, and so on. -
FieldName: string
Maximum Length:
800
The display name of the available field. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case used to find a use case.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : salesMLModels-item-response
Type:
Show Source
object
-
AdditionalMetadata: string
The object version number for the record.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CriteriaFilterExpr: string
A previously defined object filter criteria and mapping that specifies the list of records that will be exported.
-
DebugFlag: boolean
Indicates if the model is in debug mode.
-
DebugMessage: string
The message associated with the debug mode.
-
DeployFlag: boolean
Indicates if the field can be deployed.
-
JobDescription: string
Maximum Length:
1040
The description of the model. -
JobId: integer
(int64)
The unique identifier of the model.
-
JobName: string
Maximum Length:
2000
The name of the machine learning model. -
JobStatus: string
Maximum Length:
255
The status of the machine learning model. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumofFeatures: integer
The number of selected attributes for the model.
-
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
QueryMetadata: string
The details of the query associated with the model.
-
QueryResultSet: string
The results of the query associated with the model.
-
Schedule: string
Maximum Length:
1000
The schedule used to run the machine learning experiment. -
Status: string
Maximum Length:
80
The status of the machine learning model. -
StorePredCriteriaFilter: string
The filter criteria to define the prediction data-set and store predictions for sales machine learning model.
-
StorePrediction: string
Maximum Length:
1
The ability to store predictions when executing a sales machine learning model. -
StorePredProbColumnName: string
Maximum Length:
60
The outcome of the sales machine learning model stored as prediction value. -
StorePredSchedule: string
Maximum Length:
1000
The ability to store predictions when executing a sales machine learning model. -
StorePredValueColumnName: string
Maximum Length:
60
The name of the column to store prediction value for sales machine learning model. -
SubmitFlag: boolean
Indicates if the model can be submitted.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case used to find a use case. -
UsecaseName: string
The name of the use case.
-
ZcaOmlFixedFieldRules: array
Model Validation and Transformation Rules
Title:
Model Validation and Transformation Rules
Model Validation and Transformation Rules -
ZcaOmlJobsSelFields: array
Model Selected Fields
Title:
Model Selected Fields
Model Selected Fields -
ZcaOmlJobStatistics: array
Machine Learning Job Statistics Details
Title:
Machine Learning Job Statistics Details
Model Statistics -
ZcaOmlUsecaseFixedFields: array
Use Case Selected Fields
Title:
Use Case Selected Fields
Sales Machine Learning Selected Features
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Model Validation and Transformation Rules
Type:
array
Title:
Model Validation and Transformation Rules
Model Validation and Transformation Rules
Show Source
Nested Schema : Model Selected Fields
Type:
array
Title:
Model Selected Fields
Model Selected Fields
Show Source
Nested Schema : Machine Learning Job Statistics Details
Type:
array
Title:
Machine Learning Job Statistics Details
Model Statistics
Show Source
Nested Schema : Use Case Selected Fields
Type:
array
Title:
Use Case Selected Fields
Sales Machine Learning Selected Features
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : salesMLModels-ZcaOmlFixedFieldRules-item-response
Type:
Show Source
object
-
AdditionalMetadata: string
(byte)
The additional details about the machine learning model.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FieldName: string
Maximum Length:
200
The root keyword associated with the synonym. -
FieldRuleCode: string
Maximum Length:
800
The unique identifier of the rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RuleCode: string
Maximum Length:
200
The unique identifier of the rule. -
RuleValue: string
(byte)
The value of the rule associated with the model.
-
UsecaseCode: string
Maximum Length:
200
The code associated with the use case.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesMLModels-ZcaOmlJobsSelFields-item-response
Type:
Show Source
object
-
AdditionalMetadata: string
The object version number for the record.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FieldDataType: string
Maximum Length:
200
The date type of the selected field such as boolean, string, and so on. -
FieldName: string
Maximum Length:
800
The name of the field associated with the ML model. -
FieldTitle: string
Maximum Length:
800
The display name of the available field. -
IsFeature: string
Maximum Length:
20
Indicates if the field is a feature or not. The valid values are Yes, No, or Null. -
JobId: integer
(int64)
The unique identifier used to find the model.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case used to find a use case. -
ZcaOmlJobRules: array
Model Validation and Transformation Rules
Title:
Model Validation and Transformation Rules
Sales Machine Learning Model Rules
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Model Validation and Transformation Rules
Type:
array
Title:
Model Validation and Transformation Rules
Sales Machine Learning Model Rules
Show Source
Nested Schema : salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FieldName: string
Maximum Length:
800
The name of the selected field. -
JobId: integer
(int64)
The unique identifier of the model.
-
JobRuleId: integer
(int64)
The unique identifier of the validation or transformation rule.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RuleCode: string
Maximum Length:
200
The unique identifier of the validation or transformation rule. -
RuleValue: string
The value of the rule associated with the model.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesMLModels-ZcaOmlJobStatistics-item-response
Type:
Show Source
object
-
AdditionalMetadataJson: string
The additional JSON details of the machine learning model.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DataSourceName: string
Maximum Length:
700
The name of the data source associated with the use case. -
DataSourceSQL: string
The SQL query for the data source associated with the use case.
-
DataSourceType: string
Maximum Length:
80
The type of the data source associated with the use case. -
ExplainabilityMetrics: string
The metrics used to explain the model and its performance.
-
JobId: integer
(int64)
The unique identifier used to find the model.
-
JobName: string
Maximum Length:
2000
The name of the machine learning model. -
JobRunId: integer
(int64)
The unique identifier of the job run.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelAccuracy: string
Maximum Length:
200
The accuracy of the machine learning model. -
ModelStatus: string
Maximum Length:
20
The status of the machine learning model. -
ModelType: string
Maximum Length:
200
The model type associated with the use case. The type of the model depends on the task you want to perform. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RangeValues: string
The range of possible values for underlying model attributes.
-
SelectedAlgorithm: string
Maximum Length:
200
The algorithm selected for the use case.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesMLModels-ZcaOmlUsecaseFixedFields-item-response
Type:
Show Source
object
-
AdditionalMetadata: string
(byte)
The object version number for the record.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FieldDataType: string
Maximum Length:
200
The data type of the field such as string, boolean, and so on. -
FieldName: string
Maximum Length:
800
The display name of the available field. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case used to find a use case.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ZcaOmlFixedFieldRules
-
Parameters:
- JobId:
$request.path.JobId
Model Validation and Transformation Rules - JobId:
- ZcaOmlJobStatistics
-
Parameters:
- JobId:
$request.path.JobId
Model Statistics - JobId:
- ZcaOmlJobsSelFields
-
Parameters:
- JobId:
$request.path.JobId
Model Selected Fields - JobId:
- ZcaOmlUsecaseFixedFields
-
Parameters:
- JobId:
$request.path.JobId
Sales Machine Learning Selected Features - JobId: