Get an object hint
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints/{ObjectHintId}
Request
Path Parameters
-
ObjectHintId(required): integer(int64)
The unique identifier of the object hint.
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : opportunities-AiObjectHints-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EnabledFlag: boolean
Title:
Enabled
Read Only:true
Maximum Length:1
Indicates whether the record is enabled or not. Y or null for enabled and N for disabled. -
EndDate: string
(date-time)
Title:
End Date
The date when the hint ends. -
Explanations: string
(byte)
The explanatory text for the reasoning behind predictions from the AI models.
-
HintCode: string
Title:
Hint Code
Maximum Length:10
The unique identifier of the hint. -
HintType: string
Title:
Hint Type
Read Only:true
Maximum Length:30
The record type. For example, RECOMMENDATION, WIN_PROB, etc. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocalizedDetail: string
Title:
Explanation
Read Only:true
Maximum Length:255
The translated explanation and details for the hint. -
LocalizedSummary: string
Title:
Action
Read Only:true
Maximum Length:180
The translated short summary of the hint. -
ObjectHintId: integer
(int64)
Title:
Object Hint ID
The unique identifier of the object hint. -
ObjectInstanceId: integer
(int64)
Title:
Object ID
The unique identifier of the object specified by OBJECT_TYPE column. -
ObjectType: string
Title:
Object Type
Maximum Length:30
The object for which hint is applicable for example, OPPORTUNITY, LEAD, etc. -
ObjectUuid: string
Title:
Object Unique ID
Maximum Length:50
The unique identifier of the object which is an alternate key. -
PredWinProb: number
Title:
Predicted Win Probability
The win probability predicted by the AI engine. -
RespResourceId: integer
(int64)
Title:
Response Resource ID
The resource ID of the user who provided feedback on the recommendation. -
StartDate: string
(date-time)
The date when the hint starts.
-
TaskId: integer
(int64)
The unique identifier of the task that was created for the recommendation.
-
TopHintFlag: boolean
Maximum Length:
1
Indicates the current highest ranked recommendation to display in the UI. -
UserResponse: string
Title:
User Response
Maximum Length:1
The user's response to a recommendation.
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.