Update a machine learning model
patch
/crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlJobs/{JobId}
Request
Path Parameters
-
JobId(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
UsecaseCode(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
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: 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: 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.
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 : salesMLUsecases-ZcaOmlJobs-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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.