Create an attribute prediction
post
/crmRestApi/resources/11.13.18.05/attributePredictions
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
-
Accuracy: number
Title:
Accuracy
Indicates the accuracy of an attribute prediction. -
AttributeName: string
Title:
Attribute Name
Maximum Length:100
Indicates the name of the attribute whose value is predicted. -
AttrPredictionId: integer
(int64)
Title:
Attribute Prediction ID
Indicate the unique identifier of an attribute prediction record. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Indicates the attribute prediction corporate currency code. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Indicates the type of currency conversion rate for the currency on the attribute prediction. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
Indicates the attribute prediction currency code. -
PredictedValueChar: string
Title:
Predicted Character Value
Maximum Length:100
Indicates the predicted value of an attribute in the target object whose type is character. -
PredictedValueNumber: integer
(int64)
Title:
Predicted Number Value
Indicates the predicted value of an attribute in the target object whose type is numeric. -
PredictedValueTimestamp: string
(date-time)
Title:
Predicted Time Stamp Value
Indicates the predicted value of an attribute in the target object whose type is time stamp. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
Indicates the unique identifier of the source object that is used for prediction. -
SourceObjectType: string
Title:
Source Object Type
Maximum Length:30
Indicates the type of the source object whose attributes are used for prediction. -
StampedFlag: boolean
Title:
Stamped
Maximum Length:1
Default Value:false
Indicates whether the service request has been stamped by attribute detection. -
TargetObjectId: integer
(int64)
Title:
Target Object ID
Indicates the unique identifier of the target object for which the attributes are predicted. -
TargetObjectType: string
Title:
Target Object Type
Maximum Length:30
Indicates the type of the target object for which attributes are predicted.
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 : attributePredictions-item-response
Type:
Show Source
object
-
Accuracy: number
Title:
Accuracy
Indicates the accuracy of an attribute prediction. -
AttributeName: string
Title:
Attribute Name
Maximum Length:100
Indicates the name of the attribute whose value is predicted. -
AttrPredictionId: integer
(int64)
Title:
Attribute Prediction ID
Indicate the unique identifier of an attribute prediction record. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Indicates the attribute prediction corporate currency code. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Indicates the creator of the attribute prediction. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Indicates the creation date of the attribute prediction. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Indicates the type of currency conversion rate for the currency on the attribute prediction. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
Indicates the attribute prediction currency code. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates the user who last updated the attribute prediction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PredictedValueChar: string
Title:
Predicted Character Value
Maximum Length:100
Indicates the predicted value of an attribute in the target object whose type is character. -
PredictedValueNumber: integer
(int64)
Title:
Predicted Number Value
Indicates the predicted value of an attribute in the target object whose type is numeric. -
PredictedValueTimestamp: string
(date-time)
Title:
Predicted Time Stamp Value
Indicates the predicted value of an attribute in the target object whose type is time stamp. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
Indicates the unique identifier of the source object that is used for prediction. -
SourceObjectType: string
Title:
Source Object Type
Maximum Length:30
Indicates the type of the source object whose attributes are used for prediction. -
StampedFlag: boolean
Title:
Stamped
Maximum Length:1
Default Value:false
Indicates whether the service request has been stamped by attribute detection. -
TargetObjectId: integer
(int64)
Title:
Target Object ID
Indicates the unique identifier of the target object for which the attributes are predicted. -
TargetObjectType: string
Title:
Target Object Type
Maximum Length:30
Indicates the type of the target object for which attributes are predicted.
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.