Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpActivation Class
CdpActivationExternalPlatform Class
CdpActivationTarget Class
CdpAudienceDMO Class
CdpCalculatedInsight Class
CdpConnection Class
CdpDataSpace Class
CdpDataStreams Class
CdpIdentityResolution Class
CdpMachineLearning Class
CdpQuery Class
CdpSegment Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceCatalogManagement Class
CommercePromotions Class
CommerceSearch Class
CommerceSearchConnectFamily Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EinsteinLLM Class
EmailMergeFieldService Class
EmployeeProfiles Class
Exchanges Class
ExtendedCommerceDelivery Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FlowApprovalProcesses Class
FulfillmentOrder Class
IBusinessObjectivesAndRecsFamily Class
IBusinessObjectivesAndRecsFamily Methods
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentChannels Class
ManagedContentDelivery Class
ManagedContentSpaces Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NamedCredentials Class
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
OMSAnalytics Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
PickTicket Class
QuestionAndAnswers Class
Recommendations Class
RecordFilterCriteriaFamily Class
Records Class
RecordUi Class
RegisterGuestBuyer Class
Repricing Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Search Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
ConnectApi Release Notes
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

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

IBusinessObjectivesAndRecsFamily Class

Get and patch business objectives, or goals. Get, create, patch, and update recommended actions for business objectives.

Namespace

ConnectApi

IBusinessObjectivesAndRecsFamily Methods

These methods are for IBusinessObjectivesAndRecsFamily. All methods are static.

createRecommendations(busObjRecommendationInput)

Create recommended actions for a business objective, or goal.

API Version

60.0

Requires Chatter

No

Signature

public static ConnectApi.RecRepresentation createRecommendations(ConnectApi.BusObjRecommendationInputRepresentation busObjRecommendationInput)

Parameters

busObjRecommendationInput
Type: ConnectApi.BusObjRecommendationInputRepresentation
A ConnectApi.BusObjRecommendationInputRepresentation object representing a recommended action for a business objective.

Return Value

Type: ConnectApi.RecRepresentation

getBusinessObjectives(webstoreId, channelId, kpiName, includeRecSummary, includeInsightSummary)

Get business objectives, or goals, for a webstore.

API Version

59.0

Requires Chatter

No

Signature

public static ConnectApi.BusinessObjectivesSummaryOutputRepresentation getBusinessObjectives(String webstoreId, String channelId, String kpiName, Boolean includeRecSummary, Boolean includeInsightSummary)

Parameters

webstoreId
Type: String
ID of the webstore.
channelId
Type: String
ID of the channel.
kpiName
Type: String
Name of the key performance indicator (KPI).
includeRecSummary
Type: Boolean
Specifies whether to include a summary of recommended actions in the response.
includeInsightSummary
Type: Boolean
Specifies whether to include insight summary information in the response.

Return Value

Type: ConnectApi.BusinessObjectivesSummaryOutputRepresentation

getRecommendations(businessObjectiveId, domain, channelId, externalName, state, secondaryState, tertiaryState, grouping)

Get recommended actions for a business objective, or goal.

API Version

59.0

Requires Chatter

No

Signature

public static ConnectApi.RecommendationsOutputRepresentation getRecommendations(String businessObjectiveId, String domain, String channelId, String externalName, String state, String secondaryState, String tertiaryState, String grouping)

Parameters

businessObjectiveId
Type: String
ID of the business objective.
domain
Type: String
Recommendation domain.
channelId
Type: String
ID of the channel.
externalName
Type: String
External name of the recommended action.
state
Type: String
State of the recommended action.
secondaryState
Type: String
Secondary state of the recommended action.
tertiaryState
Type: String
Tertiary state of the recommended action.
grouping
Type: String
Grouping associated with the recommended action. This is a free-form categorization field.

Return Value

Type: ConnectApi.RecommendationsOutputRepresentation

patchBusinessObjective(busObjRecommendationInput)

Partially update a business objective, or goal.

API Version

62.0

Requires Chatter

No

Signature

public static ConnectApi.BusObjSummaryOutputRepresentation patchBusinessObjective(ConnectApi.BusinessObjectivesInputRepresentation busObjRecommendationInput)

Parameters

busObjRecommendationInput
Type: ConnectApi.BusinessObjectivesInputRepresentation
A ConnectApi.BusinessObjectivesInputRepresentation object representing the business objective or objectives to update.

Return Value

Type: ConnectApi.BusObjSummaryOutputRepresentation

patchRecommendations(busObjRecommendationInput)

Partially update a recommended action associated with a business objective, or goal.

API Version

61.0

Requires Chatter

No

Signature

public static ConnectApi.RecRepresentation patchRecommendations(ConnectApi.BusObjRecommendationInputRepresentation busObjRecommendationInput)

Parameters

busObjRecommendationInput
Type: ConnectApi.BusObjRecommendationInputRepresentation
A ConnectApi.BusObjRecommendationInputRepresentation object representing the recommended action to update.

Return Value

Type: ConnectApi.RecRepresentation

updateRecommendations(busObjRecommendationInput)

Update a recommended action for a business objective, or goal.

API Version

60.0

Requires Chatter

No

Signature

public static ConnectApi.RecRepresentation updateRecommendations(ConnectApi.BusObjRecommendationInputRepresentation busObjRecommendationInput)

Parameters

busObjRecommendationInput
Type: ConnectApi.BusObjRecommendationInputRepresentation
A ConnectApi.BusObjRecommendationInputRepresentation object representing the recommended action to update.

Return Value

Type: ConnectApi.RecRepresentation