Newer Version Available

This content describes an older version of this product. View Latest

AiVisitTaskRcmdRequest

Represents the request parameters and responses of visit task recommendations. This object is available in API version 51.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AcceptedCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort
Description
Number of recommendations created by this recommendation request that are accepted.
ErrorMessage
Type
textarea
Properties
Create, Nillable
Description
Details of why the visit task recommendations weren't generated.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last referenced a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Unique identification of the task.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the user associated with this record.
RecommendationCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort
Description
Number of recommendations created for the request.
RecommendationResponse
Type
textarea
Properties
Create, Nillable
Description
JSON data containing the recommendations.
RecommendationStrategyName
Type
string
Properties
Create, Filter, Group, Nillable, Sort
Description
Name of the visit recommendation strategy.
RejectedCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort
Description
Number of recommendations created by this recommendation request that are rejected.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Status of the visit task recommendation request. The default value is QUEUED.
Possible values are:
  • COMPLETED
  • FAILED
  • IN_PROGRESS
  • QUEUED
TargetRecordList
Type
textarea
Properties
Create
Description
List of targets for which recommendations are required.
TargetRecordObjectName
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The type of targets for which activities are recommended.
Possible values are:
  • AiVisitRecommendation
  • Visit

Associated Objects

This object has the following associated objects. Unless noted, they’re available in the same API version as this object.

AiVisitTaskRcmdRequestFeed
Feed is available for the object.
AiVisitTaskRcmdRequestHistory
History is available for the object.
AiVisitTaskRcmdRequestOwnerSharingRule
Sharing rule is available for the object.
AiVisitTaskRcmdRequestShare
Sharing is available for the object.