GenOpPlanReferenceRecord | Object Reference for the Salesforce Platform

Supported Calls

describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Field Name	Details
DisplayName	Type string Properties Filter, Group, Nillable, Sort Description The display name of the similar record only if it is configured in the Custom Retriever. If it isn’t configured, this field is blank. Available in API version 68.0 and later.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autonumber name of the generated operation plan reference record.
PlanId	Type reference Properties Filter, Group, Sort Description The ID of the related GenOpPlan. This field is a relationship field. Relationship Name: Plan. Refers To: GenOpPlan. This field is a relationship field. Relationship Name Plan Refers To GenOpPlan
Ranking	Type int Properties Filter, Group, Nillable, Sort Description The relevance order of this reference record relative to other references associated with the same plan, with lower numbers indicating higher relevance.
ReferenceRecord	Type string Properties Filter, Group, Sort Description The ID or identifier of the record being referenced, such as a similar case, that grounds the content of the generated operation plan.
Url	Type string Properties Filter, Group, Nillable, Sort Description The URL prefix of the similar record only if it is configured in the custom retriever. If it isn’t configured, this field is blank. Available in API version 68.0 and later.

Usage

Use this object to store and retrieve the reference records, such as similar cases, associated with a generated operation plan. Each GenOpPlanReferenceRecord is linked to its parent plan through PlanId and provides the display label, ranking, and URL used to surface citations for the plan's generated content. The DisplayName and Url fields are populated only when a custom retriever is configured for the reference source. If no custom retriever is set up, these fields remain blank.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

GenOpPlanReferenceRecordChangeEvent.: Change events are available for the object.
GenOpPlanReferenceRecordFeed.: Feed tracking is available for the object.
GenOpPlanReferenceRecordHistory.: History is available for tracked fields of the object.
GenOpPlanReferenceRecordOwnerSharingRule.: Sharing rules are available for the object.
GenOpPlanReferenceRecordShare.: Sharing is available for the object.