Update a selected field
patch
/crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobStatistics/{JobRunId}
Request
Path Parameters
-
JobId(required): integer(int64)
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=
-
JobRunId(required): integer(int64)
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
-
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.
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-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 : 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.