Get all attribute predictions
get
/crmRestApi/resources/11.13.18.05/attributePredictions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey
Finder Variables- AttrPredictionId; integer;
- PrimaryKey
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Accuracy; number; Indicates the accuracy of an attribute prediction.
- AttrPredictionId; integer; Indicate the unique identifier of an attribute prediction record.
- AttributeName; string; Indicates the name of the attribute whose value is predicted.
- CorpCurrencyCode; string; Indicates the attribute prediction corporate currency code.
- CreatedBy; string; Indicates the creator of the attribute prediction.
- CreationDate; string; Indicates the creation date of the attribute prediction.
- CurcyConvRateType; string; Indicates the type of currency conversion rate for the currency on the attribute prediction.
- CurrencyCode; string; Indicates the attribute prediction currency code.
- LastUpdateDate; string; Indicates the date the record was last updated.
- LastUpdatedBy; string; Indicates the user who last updated the attribute prediction.
- PredictedValueChar; string; Indicates the predicted value of an attribute in the target object whose type is character.
- PredictedValueNumber; integer; Indicates the predicted value of an attribute in the target object whose type is numeric.
- PredictedValueTimestamp; string; Indicates the predicted value of an attribute in the target object whose type is time stamp.
- SourceObjectId; integer; Indicates the unique identifier of the source object that is used for prediction.
- SourceObjectType; string; Indicates the type of the source object whose attributes are used for prediction.
- StampedFlag; boolean; Indicates whether the service request has been stamped by attribute detection.
- TargetObjectId; integer; Indicates the unique identifier of the target object for which the attributes are predicted.
- TargetObjectType; string; Indicates the type of the target object for which attributes are predicted.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.