Update a selected field
patch
/crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}
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=
-
ZcaOmlJobsSelFieldsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- JobId, UsecaseCode and FieldName ---for the Model Selected Fields resource and used to uniquely identify an instance of Model Selected Fields. The client should not generate the hash key value. Instead, the client should query on the Model Selected Fields collection resource with a filter on the primary key values in order to navigate to a specific instance of Model Selected Fields.
For example: ZcaOmlJobsSelFields?q=JobId=<value1>;UsecaseCode=<value2>;FieldName=<value3>
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.
-
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-patch-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.
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-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 : 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-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
Links
- ZcaOmlJobRules
-
Parameters:
- JobId:
$request.path.JobId
- ZcaOmlJobsSelFieldsUniqID:
$request.path.ZcaOmlJobsSelFieldsUniqID
Sales Machine Learning Model Rules - JobId: