Datasets:

Vishwas1
/

sf_apex_help

Dataset card Data Studio Files Files and versions Community

Split (1)

train · 1.29k rows

text stringlengths 24 5.1k
the status of the job. (e.g., "pending," "completed," 51.0 etc.). uploadid string identifier of the job. 51.0 validationerrors list<string> list of any validation errors returned by the job. 51.0 validationstatus string the validation status of the job. 51.0 connectapi.orchestrationinstance orchestration instance. property name type description available version flowdefinition string developer name of the flow definition. 54.0 developername flowdefinitionid string id of the flow definition. 54.0 flowdefinitionname string name of the flow definition. 54.0 id string id of the orchestration instance. 54.0 interviewid string id of the interview to resume. 54.0 1871apex reference guide connectapi output classes property name type description available version stageinstances list<connectapi. orchestration stage instances. 54.0 orchestrationstage instance> status connectapi. status of the orchestration instance. values are: 54.0 orchestration • completed status • inprogress • notstarted see also: connectapi.orchestrationinstancecollection connectapi.orchestrationinstancecollection collection of orchestration instances. property name type description available version instances list<connectapi. collection of orchestration instances. 54.0 orchestrationinstance> connectapi.orchestrationstageinstance orchestration stage instance. property name type description available version id string id of the orchestration stage instance. 54.0 label string orchestration stage instance label. 54.0 name string orchestration stage instance name. 54.0 status connectapi. status of the orchestration instance. values are: 54.0 orchestration • completed status • inprogress • notstarted stepinstances list<connectapi. orchestration stage instance steps. 54.0 orchestrationstep instance> see also: connectapi.orchestrationinstance 1872apex reference guide connectapi output classes connectapi.orchestrationstepinstance orchestration step instance. property name type description available version id string id of the orchestration step instance. 54.0 label string orchestration step instance label. 54.0 name string orchestration step instance name. 54.0 status connectapi. status of the orchestration instance. values are: 54.0 orchestration • completed status • inprogress • notstarted steptype connectapi. type of orchestration step. values are: 54.0 orchestration • asynchronousbackgroundstep steptype • backgroundstep • interactivestep • managedcontentroleinteractivestep • managedcontentvariantsetlock backgroundstep • managedcontentvariantsetready backgroundstep workitems list<connectapi. orchestration step instance work items. 54.0 orchestration workitem> see also: connectapi.orchestrationstageinstance connectapi.orchestrationworkitem orchestration work item. property name type description available version assigneeid string id of the assignee for the orchestration work item. 54.0 description string description of the orchestration work item. 54.0 id string id of the orchestration work item. 54.0 label string label key for the orchestration work item. 54.0 1873apex reference guide connectapi output classes property name type description available version relatedrecordid string id of the record the orchestration work item is related 54.0 to. screenflow string developer name of the screen flow to start when 54.0 developername assignees work on the orchestration work item. screenflowid string id of the screen flow to start when assignees work 54.0 on the orchestration work item. screenflowinputs string input parameters for the screen flow. 54.0 status connectapi. status of the orchestration work item. values are: 54.0 orchestrationwork • assigned itemstatus • completed see also: connectapi.orchestrationstepinstance connectapi.orderdeliverygroupsummary order delivery group summary. property name type description available version fields map<string, map of fields from order delivery group summary and 51.0 connectapi. other related objects that were queried. recordfield> see also: connectapi.orderdeliverygroupsummarycollection connectapi.orderdeliverygroupsummarycollection collection of order delivery group summaries. property name type description
available version currentpagetoken string token identifying the current page of order delivery 51.0 group summaries. currentpageurl string url to the current page of order delivery group 51.0 summaries. nextpagetoken string token identifying the next page of order delivery 51.0 group summaries. 1874apex reference guide connectapi output classes property name type description available version nextpageurl string url to the next page of order delivery group 51.0 summaries. orderdeliverygroups list<connectapi. collection of order delivery group summaries. 51.0 orderdelivery groupsummary> previouspagetoken string token identifying previous page of order delivery 51.0 group summaries. previouspageurl string url to the previous page of order delivery group 51.0 summaries. connectapi.orderitemsummary order item summary. property name type description available version adjustmentaggregates connectapi. adjustment aggregates associated with an order item 55.0 orderitemsummary summary. adjustmentaggregates fields map<string, map of fields from order item summary and other 51.0 connectapi. related objects that were queried. recordfield> orderitem string id of the order item summary. 51.0 summaryid ordersummaryid string id of the order summary. 51.0 product connectapi. associated product item information. 51.0 orderitemsummary product see also: connectapi.orderitemsummarycollection connectapi.orderitemsummaryadjustmentaggregates adjustment aggregates associated with an order item summary. property name type description available version available boolean indicates whether adjustment aggregates are 55.0 available (true) or not (false). 1875apex reference guide connectapi output classes property name type description available version status connectapi. order summary adjustment aggregate job status. 55.0 ordersummaryadjustment • failed—the adjustment aggregate data job aggregatesstatus for the order summary failed. • inprogress—the adjustment aggregate data job for the order summary is in progress. • notinitiated—the adjustment aggregate data job for the order summary is not initiated. • submitted—the adjustment aggregate data job for the order summary is submitted. totalline string total of all line item promotions applied to this 55.0 promotionamount specific product. totalpromotion string total of all order level promotions applied to this 55.0 distamount specific product. connectapi.orderitemsummaryadjustmentcollection collection of adjustments for order item summaries. property name type description available version orderitemsummaries map<string, order item summaries and their associated 53.0 connectapi. adjustments. orderitemsummary adjustmentlist> connectapi.orderitemsummaryadjustmentlist representation for list of adjustments for an order item summary. property name type description available version adjustments list<connectapi. adjustments associated with an order item summary. 53.0 ordersummary adjustment> see also: connectapi.orderitemsummaryadjustmentcollection connectapi.orderitemsummarycollection collection of order item summaries. 1876apex reference guide connectapi output classes property name type description available version currentpagetoken string token identifying the current page of items. 51.0 currentpageurl string url to the current page of items. 51.0 items list<connectapi. collection of order item summaries. 51.0 orderitemsummary> nextpagetoken string token identifying the next page of items. 51.0 nextpageurl string url to the next page of items. 51.0 previouspagetoken string token identifying the previous page of items. 51.0 previouspageurl string url to the previous page of items. 51.0 connectapi.orderitemsummaryoutputrepresentation details of an orderitemsummary from a failed fulfillmentorder in a create multiple fulfillment orders request. property name type description available version errors list<connectapi. list of errors specific to the orderitemsummary, if 50.0 errorresponse> any. orderitemsummaryid string id of the orderitemsummary. 50.0 quantity double quantity of the orderitemsummary. 50.0 connectapi.orderitemsummaryproduct product item mapped to the order item summary. property name type description available version canviewproduct boolean specifies whether the context user can view the 51.0 product (true) or not (false). errorcode string error code for the product with errors. 51.0 errormessage string error message for the product with
errors. 51.0 fields map<string, map of the product fields queried. 51.0 connectapi. recordfield> media connectapi. associated product media. 51.0 productmedia productattributes connectapi. summary of the product attributes. 51.0 productattributeset summary 1877apex reference guide connectapi output classes property name type description available version productid string id of the product. 51.0 see also: connectapi.orderitemsummary connectapi.ordershipment order shipment. property name type description available version expecteddeliverydate datetime expected delivery date for the shipment. 52.0 fields map<string, map of requested fields. 52.0 connectapi. recordfield> ordersummaryid string id of the order summary. 52.0 shipmentid string id of the shipment. 52.0 shipmentnumber string number of the shipment. 52.0 status string status of the shipment. 52.0 see also: connectapi.ordershipmentcollection connectapi.ordershipmentcollection collection of order shipments. property name type description available version count integer total number of records returned in the collection. 52.0 currentpagetoken string token identifying the current page of order 52.0 shipments. currentpageurl string url to the current page of order shipments. 52.0 nextpagetoken string token identifying the next page of order shipments. 52.0 nextpageurl string url to the next page of order shipments. 52.0 previouspagetoken string token identifying the previous page of order 52.0 shipments. previouspageurl string url to the previous page of order shipments. 52.0 1878apex reference guide connectapi output classes property name type description available version shipments list<connectapi. collection of order shipments. 52.0 ordershipment> sortorder connectapi. sort order for order shipments. values are: 52.0 ordershipmentsort • expecteddeliverydateasc—sorts by the oldest expected delivery date. • expecteddeliverydatedesc—sorts by the most recent expected delivery date. • shipmentnumberasc—sorts by shipment number in ascending order (0–9). • shipmentnumberdesc—sorts by shipment number in descending order (9–0). connectapi.ordershipmentitem shipment item. property name type description available version fields map<string, map of requested fields. 52.0 connectapi. recordfield> orderitemsummaryid string id of the order item summary. 52.0 product connectapi. product mapped to an order item summary. 52.0 orderitem summaryproduct productid string id of the product. 52.0 quantity double quantity of the product. 52.0 shipmentid string id of the shipment. 52.0 shipmentitemid string id of the shipment item. 52.0 connectapi.ordershipmentitemcollection collection of order shipment items. property name type description available version count integer total number of records returned in a page. 52.0 currentpagetoken string token identifying the current page of order shipment 52.0 items. currentpageurl string url to the current page of order shipment items. 52.0 1879apex reference guide connectapi output classes property name type description available version items list<connectapi. collection of order shipment items. 52.0 ordershipmentitem> nextpagetoken string token identifying the next page of order shipment 52.0 items. nextpageurl string url to the next page of order shipment items. 52.0 previouspagetoken string token identifying the previous page of order 52.0 shipment items. previouspageurl string url to the previous page of order shipment items. 52.0 sortorder connectapi. sort order for order shipment items. values are: 52.0 ordershipment • idasc—sorts by id in ascending alphanumeric itemsort order (a–z, 0–9). • iddesc—sorts by id in descending alphanumeric order (z–a, 9–0). connectapi.ordersummaryoutputrepresentation id of the created order summary. subclass of connectapi.baseoutputrepresentation. property name type description available version ordersummaryid string id of the order summary. 48.0 connectapi.ordersummaryrepresentation order summary. property name type description available version adjustmentaggregates connectapi. adjustment aggregates associated with the order 55.0
ordersummary summary. adjustmentaggregates createddate datetime created date of the order summary. 51.0 fields map< string, map of requested order summary fields. 51.0 connectapi. recordfield > ordernumber string order number of the order summary. 51.0 ordersummaryid string id of the order summary. 51.0 ordereddate datetime ordered date of the order summary. 51.0 1880apex reference guide connectapi output classes property name type description available version ownerid string id of the owner of the order summary. 51.0 status string status of the order summary. 51.0 totalamount string total amount of the order summary. 51.0 see also: connectapi.ordersummarycollectionrepresentation connectapi.ordersummaryadjustment adjustment associated with an order summary. property name type description available version amount string amount associated with the adjustment. 53.0 basisreferencedisplayname string display name for secondary cause of the adjustment 54.0 (for example, null or the couponcode that’s associated with a coupon) currencyisocode string three-letter iso 4217 currency code associated with 53.0 the adjustment. displayname string display name for the primary cause of the adjustment 53.0 (for example, display name of the promotion) targettype connectapi. type of price adjustment in promotions. values are: 56.0 ordersummary • splitline—price adjustment on an order adjustmenttarget item. type • header—price adjustment on the entire order. type string type of adjustment (for example, promotion, other). 53.0 see also: connectapi.ordersummaryadjustmentcollection connectapi.orderitemsummaryadjustmentlist connectapi.ordersummaryadjustmentaggregates adjustment aggregates associated with an order summary. property name type description available version available boolean indicates if adjustment aggregate values are available 55.0 (true) or not (false). 1881apex reference guide connectapi output classes property name type description available version status connectapi. order summary adjustment aggregate job status. 55.0 ordersummaryadjustment values are: aggregatesstatus • failed—the adjustment aggregate data job for the order summary failed. • inprogress—the adjustment aggregate data job for the order summary is in progress. • notinitiated—the adjustment aggregate data job for the order summary is not initiated. • submitted—the adjustment aggregate data job for the order summary is submitted. totaldelivery string total distributed delivery promotion amounts 55.0 promotiondistamount associated with an order summary. totaldelivery string total delivery promotion line amounts associated 55.0 promotionlineamount with an order summary. totaldelivery string total delivery promotion amount associated with an 55.0 promotion order summary. totalamount totalproduct string total distributed product promotion amounts 55.0 promotiondistamount associated with an order summary. totalproduct string total product promotion line amount associated with 55.0 promotionlineamount an order summary. totalproduct string total product promotion amount associated with an 55.0 promotion order summary. totalamount connectapi.ordersummaryadjustmentaggregatesasyncoutput async adjustment aggregates output. property name type description available version statusurl string status url. 55.0 connectapi.ordersummaryadjustmentcollection collection of adjustments for an order summary. property name type description available version adjustments list<connectapi. collection of adjustments for an order summary. 53.0 ordersummary adjustment> 1882
apex reference guide connectapi output classes connectapi.ordersummarycollectionrepresentation collection of order summaries. property name type description available version count integer total count of order summaries returned on the 51.0 current page. currentpagetoken string token identifying the current page. 51.0 currentpageurl string connect rest api url identifying the current page. 51.0 nextpagetoken string token identifying the next page, or null if there 51.0 isn’t a next page. nextpageurl string connect rest api url identifying the next page, or 51.0 null if there isn’t a next page. ordersummaries list<connectapi. collection of order summaries. 51.0 ordersummary representation> previouspagetoken string token identifying the previous page, or null if 51.0 there isn’t a previous page. previouspageurl string connect rest api url identifying the previous page, 51.0 or null if there isn’t a previous page. sortorder connectapi. sort order for order summaries. values are: 51.0 ordersummary • createddateasc—sorts by the oldest sortorder created date. • createddatedesc—sorts by the most recent created date. • ordereddateasc—sorts by the oldest ordered date. • ordereddatedesc—sorts by the most recent ordered date. connectapi.ordertocartfailedproduct product that could not be added to the cart from an order, with error information. property name type description available version errorcode string error code. 57.0 errormessage string error message about the cause of the failure. 57.0 productid string id of the product. 57.0 productname string name of the product. 57.0 1883apex reference guide connectapi output classes property name type description available version productsku string sku of the product. 57.0 connectapi.ordertocartresult result of action adding an order to a cart. property name type description available version cartid string id of the cart. 57.0 totalfailedproductcount integer number of products that could not be successfully 57.0 added to the cart from the order. totalsucceededproductcount integer number of products successfully added to the cart 57.0 from the order. unaddedproducts <stliconnectapi.ordertocartfailedproduct> list of products not successfully added to the cart. 57.0 connectapi.organizationsettings org settings. name type description available version accesstimeout integer amount of time after which the system prompts users 28.0 who have been inactive to log out or continue working. features connectapi.features information about features available in the org. 28.0 maintenanceinfo list<connectapi. information about a list of upcoming scheduled 34.0 maintenanceinfo> maintenances for the org. name string org name. 28.0 orgid string 18-character id for the org. 28.0 usersettings connectapi.usersettings information about the org permissions for the user. 28.0 connectapi.origincapability if a feed element has this capability, it was created by a feed action. subclass of connectapi.feedelementcapability. property name type description available version actor connectapi.user the user who executed the feed action. 33.0 summary 1884apex reference guide connectapi output classes property name type description available version originrecord connectapi.reference a reference to the feed element containing the feed 33.0 action. see also: connectapi.feedelementcapabilities connectapi.outofoffice user's out-of-office message. property name type description available version message string out-of-office message for the user. 40.0 see also: connectapi.user connectapi.mentioncompletion connectapi.pardotbusinessunitcontextitem pardot business unit context item. important: where possible, we changed noninclusive terms to align with our company value of equality. we maintained certain terms to avoid any effect on customer implementations. property name type description available version id string id of the pardottenant record. 55.0 iscurrent boolean specifies whether the business unit is selected as the 55.0 context user's current business unit context in the business unit switcher of the pardot lightning app (true) or not (false). name string name of the pardot business unit as it is
specified in 55.0 the masterlabel of the pardottenant record. see also: connectapi.pardotbusinessunitcontextoutput connectapi.pardotbusinessunitcontextoutput pardot business unit context. 1885apex reference guide connectapi output classes property name type description available version businessunits list<connectapi. list of the pardot business unit context items that 55.0 pardotbusiness the context user has access to. unitcontextitem> issuccess boolean indicates whether the requested resource was 55.0 successfully provided. totalbusinessunits integer indicates the total number of pardot business units 55.0 that the context user has access to. connectapi.paymentauthorizationresponse payment authorization output representation. property name type description available version accountid string salesforce account for the payment authorization. 51.0 amount double amount that the gateway authorized for the payment 51.0 transaction. currencyisocode string three-letter iso 4217 currency code associated with 51.0 the payment group record. effectivedate datetime date that the authorization becomes effective. 51.0 expirationdate datetime date that the authorization expires. 51.0 id string id of the payment authorization record. 51.0 paymentauthorizationnumber string system-defined number for the payment 51.0 authorization record. requestdate datetime date that the authorization occurred. 51.0 status string status of the payment authorization as returned by 51.0 the gateway. connectapi.paymentgroupresponse payment group. property name type description available version currencyisocode string three-letter iso 4217 currency code associated with 50.0 the payment group record. id string id of the payment group record. 50.0 sourceobjectid string source object id of the payment group record. 50.0 supports only orderid. 1886apex reference guide connectapi output classes connectapi.paymentmethoddetails details about the payment method. property name type description available version alternative connectapi. alternative payment method details. 56.0 paymentmethod alternativepayment methodoutput cardpaymentmethod connectapi.cardpayment card payment method details. 56.0 methodoutput connectapi.paymentmethodresponse payment method information response. property name type description available version accountid string salesforce payments account to which this payment 51.0 method is linked. id string id of the payment method. 51.0 paymentmethod connectapi. details about the payment method. details paymentmethoddetails status string status of the payment method. 51.0 connectapi.paymentmethodtokenizationgatewayresponse payment method tokenization gateway response representation. subclass of connectapi.abstractgatewayresponse. property name type description available version gatewaytoken string the payment method token sent from the gateway. 52.0 connectapi.paymentmethodtokenizationresponse payment method tokenization output representation. property name type description available version error connectapi. error representation for the payment method 52.0 errorresponse tokenization process. sent only if the tokenization process encounters an error in the gateway. gatewayresponse connectapi. response containing the tokenized payment method 52.0 paymentmethodtokenization value from the payment gateway. gatewayresponse 1887apex reference guide connectapi output classes property name type description available version paymentgatewaylogs list<connectapi. logs showing more details about the tokenization 52.0 gatewaylogresponse> process that occurred in the gateway. paymentmethod connectapi.paymentmethod object representation of the payment method object 52.0 response that was tokenized. connectapi.paymentresponse payment output. property name type description available version accountid string id of the account related the payment record. 50.0 amount double total amount of the payment transaction performed 50.0 in the payment request. currencyisocode string three-letter iso 4217 currency code associated with 50.0 the payment output. effectivedate datetime date that the payment becomes effective. 50.0 id string id of the payment record. 50.0 paymentnumber string number of the payment record created as a result of 50.0 the request processing. requestdate datetime date when the payment transaction occurred. 50.0 status string status of the new payment record. can be draft, 50.0 processed or cancelled. connectapi.percentrecordfield record field containing a percentage value. subclass of connect
api.labeledrecordfield. name type description available version value double value of the percentage. 29.0 connectapi.phonenumber phone number. name type description available version label string a localized string indicating the phone type. 30.0 phonenumber string phone number. 28.0 1888apex reference guide connectapi output classes name type description available version phonetype string phone type. values are: 30.0 • fax • mobile • work these values are not localized. type string 28.0–29.0 note: this property is not available after version 29.0. use the phonetype property instead. values are: • fax • mobile • work these values are not localized. see also: connectapi.datacloudcompany connectapi.datacloudcontact connectapi.userdetail connectapi.photo profile photo. name type description available version fullemailphotourl string a temporary url to the large profile picture. the url expires after 28.0 30 days and is available to unauthenticated users. largephotourl string url to the large profile picture. the default width is 200 pixels, and 28.0 the height is scaled so the original image proportions are maintained. if a user hasn’t uploaded a photo, this url points to a default photo. if the user hasn’t uploaded a photo and the request header included x-connect-theme: salesforce1, this url points to a default photo based on a theme that the admin selected for the org. mediumphotourl string url to the medium profile picture. the default width is 160 pixels, 37.0 and the height is scaled so the original image proportions are maintained. if a user hasn’t uploaded a photo, this url points to a default photo. if the user hasn’t uploaded a photo and the request header included 1889apex reference guide connectapi output classes name type description available version x-connect-theme: salesforce1, this url points to a default photo based on a theme that the admin selected for the org. photoversionid string 18–character id to that version of the photo 28.0 smallphotourl string url to the small profile picture. the default size is 64x64 pixels. 28.0 if a user hasn’t uploaded a photo, this url points to a default photo. if the user hasn’t uploaded a photo and the request header included x-connect-theme: salesforce1, this url points to a default photo based on a theme that the admin selected for the org. standardemail string a temporary url to the small profile. the url expires after 30 days 28.0 photourl and is available to unauthenticated users. url string a resource that returns a photo object: for example, 28.0 /services/data/v58.0/chatter/users/005d0000001ll8oiaw/photo. see also: connectapi.chattergroup connectapi.recommendationdefinition connectapi.user connectapi.picklistrecordfield record field containing an enumerated value. subclass of connectapi.labeledrecordfield. connectapi.pincapability if a feed element has this capability, users who have permission can pin it to a feed. subclass of connectapi.feedelementcapability. property name type description available version ispinnablebyme boolean specifies whether the context user can pin or unpin 41.0 the entity to the feed (true) or not (false). ispinned boolean specifies whether the entity is pinned (true) or not 41.0 pinned (false) to the feed. see also: connectapi.feedelementcapabilities 1890apex reference guide connectapi output classes connectapi.pinnedfeedelements list of pinned feed elements for a feed. property name type description available version elements list<connectapi. list of pinned feed elements. 41.0 feedelement> note: in the ui, pinned feed elements don’t show all auxiliary information, such as comments, likes, interaction counts, or read by information. as a result, the connectapi.pinnedfeedelements output class doesn’t include all the information for these capabilities. connectapi.platformaction a platform action instance with state information for the context user. property name type description available version actionurl string for action links of subtype ui or download, 33.
0 direct the user to download or visit the ui from this link. salesforce issues a javascript redirect for the link in this format: /action-link-redirect/communityid /actionlinkid?_bearer=bearertoken. for api action links and for all platform actions, this value is null and salesforce handles the call. apiname string the api name. the value may be null. 33.0 confirmation string if this action requires a confirmation and has a status 33.0 message of newstatus, this is a default localized message that should be shown to an end user prior to invoking the action. otherwise, this is null. executinguser connectapi.user the user who initiated execution of this platform 33.0 summary action. groupdefault boolean true if this platform action is the default or primary 33.0 platform action in the platform action group; false otherwise. there can be only one default platform action per platform action group. iconurl string the url of the icon for the platform action. this value 33.0 may be null. 1891apex reference guide connectapi output classes property name type description available version id string the id for the platform action. 33.0 if the type is quickaction and the subtype is create, this value is null. label string the localized label for this platform action. 33.0 modifieddate datetime iso 8601 format date string, for example, 33.0 2011-02-25t18:24:31.000z. platformaction connectapi. a reference to the platform action group containing 33.0 group reference this platform action. status connectapi. the execution status of the platform action. values 33.0 platformaction are: status • failedstatus—the action link execution failed. • newstatus—the action link is ready to be executed. available for download and ui action links only. • pendingstatus—the action link is executing. choosing this value triggers the api call for api and apiasync action links. • successfulstatus—the action link executed successfully. subtype string the subtype of a platform action or null. 33.0 if the type property is actionlink, possible values are: • api—the action link calls a synchronous api at the action url. salesforce sets the status to successfulstatus or failedstatus based on the http status code returned by your server. • apiasync—the action link calls an asynchronous api at the action url. the action remains in a pendingstatus state until a third party makes a request to /connect/action-links/actionlinkid to set the status to successfulstatus or failedstatus when the asynchronous operation is complete. • download—the action link downloads a file from the action url. • ui—the action link takes the user to a web page at the action url. 1892apex reference guide connectapi output classes property name type description available version note: invoking apiasync action links from an app requires a call to set the status. however, there isn’t currently a way to set the status of an action link using apex. to set the status, use connect rest api. see the action link resource in the connect rest api developer guide for more information. type connectapi. the type of platform action. values are: 33.0 platformactiontype • actionlink—an indicator on a feed element that targets an api, a web page, or a file, represented by a button in the salesforce ui. • custombutton—when clicked, opens a url or a visualforce page in a window or executes javascript. • productivityaction—productivity actions are predefined and attached to a limited set of objects. productivity actions include send email, call, map, view website, and read news. except for the call action, you can’t edit productivity actions. • quickaction—a global or object-specific action. • standardbutton—a predefined salesforce button such as new, edit, or delete. url string the url for this platform action. 33.0 if the type is quickaction and the subtype is create, this value is null. see also: connectapi.platformactiongroup connectapi.platformactiongroup a platform action group instance with state appropriate for the context user. action link groups are one type of platform action group and are therefore represented as connectapi.platformaction
group output classes. 1893apex reference guide connectapi output classes property name type description available version category connectapi. indicates the priority and relative locations of platform 33.0 platformaction actions. values are: groupcategory • primary—the action link group is displayed in the body of the feed element. • overflow—the action link group is displayed in the overflow menu of the feed element. id string the 18-character id or an opaque string id of the 33.0 platform action group. if the connectapi.platformactiontype is quickaction and the subtype is create, this value is null. modifieddate datetime iso 8601 date string, for example, 33.0 2014-02-25t18:24:31.000z. platformactions list<connectapi. the platform action instances for this group. 33.0 platformaction> within an action link group, action links are displayed in the order listed in the actionlinks property of the connectapi.actionlinkgroup definitioninput class. within a feed item, action link groups are displayed in the order specified in the actionlinkgroupids property of the connectapi.associatedactions capabilityinput class. url string the url for this platform action group. 33.0 if the connectapi.platformactiontype is quickaction and the subtype is create, this value is null. see also: connectapi.abstractrecommendation connectapi.associatedactionscapability connectapi.pollcapability if a feed element has this capability, it includes a poll. subclass of connectapi.feedelementcapability. property name type description available version choices list<connectapi. collection of poll choices that make up the poll. 32.0 feedpollchoice> 1894apex reference guide connectapi output classes property name type description available version mychoiceid string 18-character id of the poll choice that the context 32.0 user has voted for in this poll. returns null if the context user has not voted. totalvotecount integer total number of votes cast on the feed poll element. 32.0 see also: connectapi.feedelementcapabilities connectapi.postauthorizationresponse gateway response following a post authorization request. property name type description available version error connectapi. information about errors that occurred in the 54.0 errorresponse payment gateway while evaluating the post authorization request. gatewayresponse connectapi. payment gateway's response to the post 54.0 postauth authorization request. gatewayresponse paymentauthorization connectapi. payment gateway's response to the original payment 54.0 paymentauthorization authorization request. response paymentgatewaylogs list<connectapi. stores information exchanged between the 54.0 gatewaylog salesforce payments platform and external payment response> gateways. gateway logs can also record payloads from external payment entities. paymentgroup connectapi. payment group, consisting of one or more payments, 54.0 paymentgroup sent to the gateway for the post authorization response request. paymentmethod connectapi. payment method used in the post authorization 54.0 paymentmethod request. response connectapi.postauthgatewayresponse gateway response after confirmation that the merchant is ready to capture payment of an existing pre-authorized transaction. sublass of connectapi.abstractgatewayresponse 1895apex reference guide connectapi output classes property name type description available version gateway string code used to authorize the payment that the 54.0 authorizationcode payment gateway is processing. paymentmethod connectapi. details about the payment method. 54.0 details paymentmethoddetails connectapi.previewcanceloutputrepresentation expected financial values for a proposed cancel action. subclass of connectapi.baseoutputrepresentation. property name type description available version changebalances connectapi. expected financial values for the proposed cancel 48.0 changeitem action. outputrepresentation ordersummaryid string id of the ordersummary. 48.0 connectapi.previewreturnoutputrepresentation expected financial values for a proposed return action. subclass of connectapi.baseoutputrepresentation. property name type description available version changebalances connectapi. expected financial values for the proposed return 48.0 changeitem action. outputrepresentation ordersummaryid string id of the ordersummary. 48.0 connectapi.priceadjustmentschedule price adjustment schedule. property name type description available version id string id
of the price adjustment schedule. 49.0 priceadjustment list<connectapi. list of price adjustment tiers. 49.0 tiers priceadjustment tier> see also: connectapi.productprice 1896apex reference guide connectapi output classes connectapi.priceadjustmenttier price adjustment tier. property name type description available version adjustmenttype connectapi. type of price adjustment for the tier. values are: 49.0 priceadjustment • amountbasedadjustment—price is tiertype adjusted by a specified amount. • percentagebasedadjustment—price is adjusted by a specified percentage. adjustmentvalue string adjustment value of the tier. 49.0 id string id of the price adjustment tier. 49.0 lowerbound string lower limit of the tier. 49.0 tierunitprice string unit price of the tier. 49.0 upperbound string upper limit of the tier. 49.0 see also: connectapi.priceadjustmentschedule connectapi.pricingresult product pricing result. property name type description available version currencyisocode string three-letter iso 4217 currency code associated with 49.0 the product. error connectapi. error code and message. 49.0 errorresponse pricingline list<connectapi. pricing result line items. 49.0 itemresults pricingresultlineitem> success boolean specifies whether the execution was successful 49.0 (true) or not (false). connectapi.pricingresultlineitem pricing result line item. property name type description available version error connectapi. error code and message. 49.0 errorresponse 1897apex reference guide connectapi output classes property name type description available version listprice string list price for the product. 49.0 pricebookentryid string id of the pricebook entry. 49.0 productid string id of the product to price. 49.0 success boolean specifies whether the execution was successful 49.0 (true) or not (false). unitprice string unit price for the product. 49.0 see also: connectapi.pricingresult connectapi.productsummary connectapi.productattributeinfo product attribute metadata. property name type description available version allowablevalues list<string> active attribute picklist values that can be used to 50.0 create variations. these values are determined by the order of the picklist values in object manager. apiname string api name of the attribute. 50.0 availablevalues list<string> attribute picklist values that are available for the 50.0 product in the store. these values are sorted by the order of values in the allowablevalues property. fieldenumorid string field id for custom fields or enumeration value for 50.0 standard fields. label string label of the attribute. 50.0 objectname string name of the object that contains the field. 50.0 sequence integer sequence value determined by the order of the 50.0 attributes under commerce setup for the attribute set. see also: connectapi.productdetail connectapi.productattributesetinfo connectapi.productvariationinfo 1898apex reference guide connectapi output classes connectapi.productattributeselectioninfo product attribute. property name type description available version apiname string api name of the attribute. 50.0 label string label of the attribute. 50.0 sequence integer sequence value determined by the order of the 50.0 attributes under commerce setup for the attribute set. value string display value of the attribute. 50.0 see also: connectapi.productattributestoproductentry connectapi.productattributeset product attribute set data. property name type description available version attributes map<string, string> map of the attributes that are members of the 50.0 attribute set. developername string name of the attribute set. 50.0 id string id of the product attribute record that represents the 50.0 product attribute set. connectapi.productattributesetinfo attribute set metadata. important: where possible, we changed noninclusive terms to align with our company value of equality. we maintained certain terms to avoid any effect on customer implementations. property name type description available version attributeinfo map<string, map of the api name of the attribute field to the 50.0 connectapi. attribute metadata. productattributeinfo> description string description of the attribute set. 50.0 developername string developer name of the attribute set. 50.0
id string id of the attribute set. 50.0 masterlabel string label of the attribute set. 50.0 1899apex reference guide connectapi output classes property name type description available version sequence integer sequence of the attribute set for the product. 50.0 see also: connectapi.productdetail connectapi.productattributesetsummary summary of a product attribute set. property name type description available version apiname string api name of the attribute set. 51.0 attributes list<connectapi. list of attributes in the attribute set. 51.0 productattribute summary> label string display label of the attribute set. 51.0 see also: connectapi.orderitemsummaryproduct connectapi.productsummary connectapi.productattributesummary summary of a product attribute. property name type description available version apiname string api name of the attribute. 51.0 label string display label of the attribute. 51.0 sequence integer sequence of the attribute in the attribute set. 51.0 value string display value of the attribute. 51.0 see also: connectapi.productattributesetsummary connectapi.productattributestoproductentry mapping of an attribute value combination to a variation product id. 1900apex reference guide connectapi output classes property name type description available version canonicalkey string attribute api values concatenated with an underscore 50.0 (_) based on the sequence number of the attributes in the attribute set. productid string variation product id for the selection of attributes. 50.0 selectedattributes list<connectapi. ordered list of attribute values and metadata that 50.0 productattribute can be used to form a key that maps to product id. selectioninfo> see also: connectapi.productvariationinfo connectapi.productcategorydata product category. property name type description available version description string description of the category. 49.0 id string id of the category. 49.0 name string name of the category. 49.0 see also: connectapi.productcategorypath connectapi.searchcategory connectapi.productcategorydetail details of a product category. property name type description available version bannerimage connectapi. banner image of the product category. 49.0 productcategorymedia fields map<string, string> list of fields for the product category. 49.0 id string id of the product category. 49.0 mediagroups list<connectapi. list of media groups of the product category. 49.0 productcategory mediagroup> 1901apex reference guide connectapi output classes property name type description available version tileimage connectapi. tile image of the product category. 49.0 productcategorymedia see also: connectapi.productcategorydetailcollection connectapi.productcategorydetailcollection collection of product category details. property name type description available version productcategories list<connectapi. list of product category details. 52.0 productcategory detail> connectapi.productcategorymedia media associated with a product category. property name type description available version alternatetext string alternative text for the product category media. 49.0 contentversionid string id of the latest published content version if the media 49.0 is stored as a contentdocument. if the image is a customer-provided external url, the value is null. not supported in enhanced cms workspaces. id string id of the product category image. 49.0 mediatype connectapi. type of product media. values are: 49.0 productmediatype • document • image • video sortorder integer sort order of a media item inside a media group. 49.0 thumbnailurl string url of the thumbnail for product media. if a value 49.0 exists, it should be used for the thumbnail whether the image is natively uploaded or hosted externally. not supported in enhanced cms workspaces. title string title of the product category media. 49.0 1902apex reference guide connectapi output classes property name type description available version url string url of the product category media. 49.0 see also: connectapi.productcategorymediagroup connectapi.productcategorydetail connectapi.productcategorymediagroup media group associated with a product category. property name type description available version developername string api name of the product category media group. 49.0 id string id of the product category media group. 49.0 mediaitems list<connectapi. list of media
items within a product category media 49.0 productcategorymedia> group. name string name of the product category media group. 49.0 usagetype connectapi. usage type of a product media item within a media 49.0 productmedia group. values are: usagetype • attachment—product media group with product documents as attachments. • banner—product category media group with banner images of the product. • listing—product media group with listing images of the product. • standard—product media group with standard images and videos of the product. • tile—product category media group with tile images of the product. connectapi.productcategorypath list of product categories in a path. property name type description available version path list<connectapi. list of product categories in a path. 49.0 productcategorydata> see also: connectapi.productdetail 1903apex reference guide connectapi output classes connectapi.productchild child product related to a parent product. property name type description available version defaultquantity string default quantity of child products to be ordered. 57.0 productinfo connectapi. product details of the child product. 57.0 productdetail connectapi.productchildcollection collection of child products related to a parent product. property name type description available version count integer number of child products returned on this page. 57.0 currentpagetoken string current page token, if any. 57.0 currentpageurl string url of the current page in the response. 57.0 items list<connectapi. list of child products related to the parent product. 57.0 productchild> the child products are sorted by their configured sequence values, in ascending order, with null values sorted last. if there are no configured sequence values, the child products are sorted by createddate, in ascending order. nextpagetoken string token for the next page, if any. a value is included in 57.0 the response only if a value is returned for nextpageurl. nextpageurl string url of the next page, if any. 57.0 previouspagetoken string token for the previous page, if any. a value is 57.0 included in the response only if a value is returned for previouspageurl. previouspageurl string url of the previous page, if any. 57.0 total integer total number of child products in the collection. 57.0 connectapi.productdetail details of a product. 1904apex reference guide connectapi output classes property name type description available version attributesetinfo map<string, map of the attribute set developer name to its 50.0 connectapi. metadata. productattribute setinfo> defaultimage connectapi. default image of the product. 49.0 productmedia entitlement connectapi. entitlement details for the product. 49.0–56.0 productentitlement to get pricing information for products in version 57 and later, use the commercestorepricing class. fields map<string, string> list of fields for the product. 49.0 id string id of the product. 49.0 mediagroups list<connectapi. list of media groups of the product. 49.0 productmediagroup> primaryproduct connectapi. primary category path of the product. 49.0 categorypath productcategorypath productclass connectapi. class of product. values are: 50.0 productclass • simple • variation • variationparent productselling list<connectapi. list of product selling models for the product. 56.0 models productselling model> purchasequantity connectapi. if one exists, purchase quantity rule for the product. 52.0 rule purchasequantity rule variationattribute connectapi. variation attribute set for the product. 50.0 set productattributeset variationinfo connectapi. available and allowable values for variation attributes 50.0 productvariationinfo and a map to resolve variation product ids from attribute value combinations. variationparentid string id of the variation parent. 50.0 connectapi.productdetailsoutputrepresentation details about a product. subclass of connectapi.baseoutputrepresentation. 1905apex reference guide connectapi output classes property name type description available version attributes lsit<connectapi.productvariation list of variation attributes that define variations of 55.0 attributeoutput the product. representation> currencyisocode string currency iso code. 55.0 description
string description of the product. 55.0 fields map<string, string> list of the product’s fields. 55.0 imagegroups list<connectapi. list of the product’s image groups. 55.0 productimage groupoutput representation> listprice double list price. 55.0 name string name. 55.0 productquantityrule purchase quantity rule if one exists, purchase quantity rule for the product. 55.0 productid string product id. 55.0 stockkeepingunit string stock keeping unit. 55.0 unitprice double unit price. 55.0 variants list<connectapi. list of variations of the product. 55.0 productvariant output representation> connectapi.productentitlement entitlements for a product. property name type description available version canviewprice boolean specifies whether the product's price can be viewed 49.0 (true) or not (false). see also: connectapi.productdetail connectapi.productimageoutputrepresentation details about a product image. 1906apex reference guide connectapi output classes property name type description available version alternatetext string alternate text for accessibility. 55.0 mediatype string media type. 55.0 thumbnailurl string url of the thumbnail version of the product image. 55.0 title string title. 55.0 url string url of the product image. 55.0 connectapi.productimagegroupoutputrepresentation details about a product image group. property name type description available version images list<connectapi. list of product images in the group. 55.0 productimage outputrepresentation> viewtype string the type of product images in the group. 55.0 connectapi.productmedia media associated with a product. property name type description available version alternatetext string alternative text for the product media. 49.0 contentversionid string id of the latest published content version if the media 49.0 is stored as a contentdocument. if the image is a customer-provided external url, the value is null. not supported in enhanced cms workspaces. id string id of the product image. 49.0 mediatype connectapi. type of product media. values are: 49.0 productmediatype • document • image • video sortorder integer sort order of a media item within a media group. 49.0 thumbnailurl string url of the thumbnail for product media. if a value 49.0 exists, it should be used for the thumbnail whether the image is natively uploaded or hosted externally. not supported in enhanced cms workspaces. title string title of the product media. 49.0 1907apex reference guide connectapi output classes property name type description available version url string url of the product media. 49.0 see also: connectapi.cartitemproduct connectapi.productdetail connectapi.productmediagroup connectapi.orderitemsummaryproduct connectapi.productsummary connectapi.productmediagroup media group associated with a product. property name type description available version developername string api name of the product media group. 49.0 id string id of the product media group. 49.0 mediaitems list<connectapi. list of media items within a product media group. 49.0 productmedia> name string name of the product media group. 49.0 usagetype connectapi. usage type of a product media item within a media 49.0 productmedia group. values are: usagetype • attachment—product media group with product documents as attachments. • banner—product category media group with banner images of the product. • listing—product media group with listing images of the product. • standard—product media group with standard images and videos of the product. • tile—product category media group with tile images of the product. see also: connectapi.productdetail connectapi.productcategorydetail connectapi.productoverview overview of a product, with summary information about prices, selected fields, and the product’s default image. 1908apex reference guide connectapi output classes property name type description available version defaultimage connectapi. media representation of the product's default image. 54.0 productmedia error connectapi. error code and error message. 54.0 errorresponse fields map<string, string> map of fields belonging to the product. 54.0 id string id of the product. 54.0
prices connectapi. price of the product. 54.0–57.0 pricingresult to get pricing information for products in version 58 lineitem and later, use the commercestorepricing class. sku string sku of the product. 54.0 success boolean represents whether execution was successful and 54.0 product overview information was retrieved without error. connectapi.productoverviewcollection collection of product overviews. property name type description available version products list<connectapi. collection of product overview. 54.0 productoverview> total integer total number of products returned. 54.0 connectapi.productprice pricing information for a product. property name type description available version currencyisocode string three-letter iso 4217 currency code associated with 49.0 the product. products are priced using the currency for the buyer account or guest buyer profile. if your store doesn’t support the currency for the buyer account or guest buyer profile, products are priced using the default currency for your store. listprice string list price for the product. 49.0 1909apex reference guide connectapi output classes property name type description available version priceadjustment connectapi. price adjustment schedule for the product. if a 49.0 priceadjustment product selling model id is specified in a request schedule parameter, this property is empty. pricebookentryid string id of the price book entry. if a product selling model 49.0 id is specified in a request parameter, this property is empty. productpriceentries ls<ticonnectapi.productpriceentry> list of line item prices for the product. 56.0 unitprice string unit price for the product. if a product selling model 49.0 id is specified in a request parameter, this property is empty. connectapi.productpriceentry line item price for the product. property name type description available version error connectapi. error code and error message. 56.0 errorresponse listprice string list price for the product entry. 56.0 priceadjustment connectapi. price adjustment schedule. 56.0 priceadjustment schedule pricebookentryid string id of the pricebook entry. 56.0 productselling string id of the product selling model. if no product selling 56.0 modelid model id is specified in a request parameter, this property is empty. success boolean specifies whether execution was successful (true) 56.0 or not (false). unitprice string unit price for the product entry. 56.0 connectapi.productvariationinfo product variation attributes, metadata, and mappings of attribute combinations to variation product ids. property name type description available version attributesto list<connectapi. list ordered by 50.0 productmappings productattributes productattribute.sequence values that toproductentry> map the attribute value combinations to the variation product id. 1910apex reference guide connectapi output classes property name type description available version variationattributeinfo map<string, map of field api name to product attribute 51.0 connectapi. information. productattributeinfo> see also: connectapi.productdetail connectapi.productsearchresults product search results. property name type description available version categories connectapi. categories from the search results. 52.0 searchcategory correlationid string reserved for future use. 55.0 facets list<connectapi. facets from the search results. 52.0 searchfacet> locale string locale of the search results. 52.0 productspage connectapi. page of products from the search results. 52.0 productsummarypage connectapi.productsearchsuggestionsresults product search suggestions results. property name type description available version recentsearch list<connectapi. suggestions based on the user’s recent searches. 52.0 suggestions searchsuggestion> connectapi.productsellingmodel product selling model for commerce subscriptions. property name type description available version id string id of the product selling model. 56.0 name string name of the product selling model. 56.0 pricingterm integer number of pricing term units in the pricing term. 56.0 used with pricingtermunit to define the length of the pricing term. for example, if 1911apex reference guide connectapi output classes property name type description available version pricingtermunit is months and this property is 1, the subscription is priced monthly. however, if the sellingmodeltype property is set to one
time, the pricingterm property is empty, because the product isn’t sold as a subscription. the only allowed value for this property is 1. pricingtermunit connectapi. unit of time used to define a pricing term. value is: 56.0 pricingtermunit • months—product is priced on a monthly basis. • annual—product is priced on an annual basis. this unit of time is combined with a number (specified by the pricingterm property) to define the full term of the subscription. for example, if the unit of time is months and the pricingterm property is set to 1, the subscription is priced monthly. however, if the sellingmodeltype property is set to onetime, the pricingtermunit property is empty, because the product isn’t sold as a subscription. sellingmodeltype connectapi. type of product selling model. values are: 56.0 sellingmodeltype • evergreen—a subscription without an end date. an evergreen subscription continues until the shopper affirmatively cancels it. • onetime—a product that isn’t sold as a subscription. • termdefined—a subscription with a defined end date. the subscription continues for a specified time period. when the term ends, the subscription ends. connectapi.productsummary product summary. property name type description available version defaultimage connectapi. default image of the product. 52.0 productmedia fields map<string, map of fields belonging to the product. 52.0 connectapi. fieldvalue> 1912apex reference guide connectapi output classes property name type description available version id string id of the product. 52.0 name string name of the product. 52.0 prices connectapi. prices of the product. 52.0 pricingresult lineitem productclass connectapi. class of product. values are: 52.0 productclass • simple • variation • variationparent purchasequantityrule connectapi. if one exists, purchase quantity rule for the product. 52.0 purchasequantity rule variationattributeset connectapi. variation attribute set that’s associated with the 52.0 productattribute product. setsummary see also: connectapi.productsummarypage connectapi.productsummarypage page of product summaries. property name type description available version currencyisocode string three-letter iso 4217 currency code associated with 52.0 the product. pagesize integer number of products per page in the search results. 52.0 products list<connectapi. collection of product summaries. 52.0 productsummary> total long total number of products in the search results. 52.0 see also: connectapi.productsearchresults connectapi.productvariantoutputrepresentation details about a product variation. 1913apex reference guide connectapi output classes property name type description available version listprice double list price. 55.0 price double price. 55.0 productid string product id. 55.0 stockkeepingunit string stock keeping unit. 55.0 unitprice double unit price. 55.0 variationvalues map<string, string> the variation attribute values that define the variation. 55.0 connectapi.productvariationattributeoutputrepresentation details about a product variation attribute. property name type description available version apiname string api name of the attribute. 55.0 label string label of the attribute. 55.0 variationattribute list<connectapi. list of valid values for the variation attribute. 55.0 values productvariation attributevalue outputrepresentation> connectapi.productvariationattributevalueoutputrepresentation valid value for a product variation attribute. property name type description available version name string api name of the attribute this value belongs to. 55.0 orderable boolean whether the value defines an orderable product 55.0 variation. value string value of the value. 55.0 connectapi.promotioncart a cart, its items, and its adjustment groups. property name type description available version cartadjustment list<connectapi. cart adjustment groups belonging to the cart. 57.0 groups promotioncart adjustmentgroup> 1914apex reference guide connectapi output classes property name type description available version cartitems list<connectapi. cart items belonging to the cart. 57.0 promotion cartitem> currencyisocode string currency code of the cart. 57
.0 id string id of the cart. 57.0 totaladjustment string total adjustment base amount for the cart. 57.0 baseamount totalnetamount string total price of the cart, including adjustments. 57.0 totalproduct string total price of all cart items in the cart. 57.0 baseamount see also: connectapi.promotionevaluation evaluate(salestransaction) connectapi.promotioncartadjustmentgroup adjustment group associated with a cart. property name type description available version adjustmentbasis string id of the associated coupon, if applicable. 57.0 reference adjustment string description of the adjustment. 57.0 description adjustmenttype connectapi. how the price adjustment amount is calculated. 57.0 adjustmenttype values are: • adjustmentamount—the adjustment is a fixed amount. • adjustmentpercentage—the adjustment is a percentage. adjustmentvalue string price value of the adjustment. 57.0 baseamount string total amount of the adjustment. 57.0 cartid string id of the cart. 57.0 id string id of the cart adjustment group. 57.0 priceadjustment string id of the related promotion. 57.0 causeid 1915apex reference guide connectapi output classes property name type description available version priority integer where in the sequence of adjustments this 57.0 adjustment was applied. see also: connectapi.promotioncart connectapi.promotionevaluation evaluate(salestransaction) connectapi.promotioncartitem a cart item and its adjustments. property name type description available version cartdelivery string id of the associated cart delivery group. 57.0 groupid cartid string id of the associated cart. 57.0 cartitemprice list<connectapi. list of price adjustments applied to the cart item. 57.0 adjustments promotioncartitem priceadjustment> id string id of the cart item. 57.0 itemdescription string description of the cart item. 57.0 itemname string name of the cart item. 57.0 listprice string unit list price of the cart item. 57.0 product2id string id of the product. 57.0 quantity string quantity of the cart item. 57.0 salesprice string unit sales price of the cart item. 57.0 sku string stock keeping unit of the cart item. 57.0 totaladjustment string total adjustment amount for the cart item. 57.0 baseamount totalline string total amount for the cart item, based on sales price 57.0 baseamount and quantity, not including adjustments. totallist string total amount for the cart item, based on list price 57.0 baseamount and quantity, not including adjustments. totalnetamount string total amount for the cart item, based on list price 57.0 and quantity, including adjustments. 1916apex reference guide connectapi output classes property name type description available version type connectapi. type of item in a cart. values are: 57.0 cartitemtype • deliverycharge • product see also: connectapi.promotioncart connectapi.promotionevaluation evaluate(salestransaction) connectapi.promotioncartitempriceadjustment price adjustments applied to a cart item. property name type description available version adjustmentamount connectapi. scope of the price adjustment amount. values are: 57.0 scope adjustmentamount • total—the adjustment scope is the total price. scope • unit—the adjustment scope is the unit price. • unproratedtotal—the adjustment scope is the unprorated total price. adjustmentbasis string id of the associated coupon, if applicable. 57.0 reference adjustment string description of the adjustment. 57.0 description adjustmenttarget connectapi. level of the promotion target. values are: 57.0 type cartpromotiontype • cart—the target is cart-level. • item—the target is item-level. adjustmenttype connectapi. how the price adjustment amount is calculated. 57.0 adjustmenttype values are: • adjustmentamount—the adjustment is a fixed amount. • adjustmentpercentage—the adjustment is a percentage. adjustmentvalue string value of the price adjustment. 57.0 baseamount string total adjustment amount. 57.0 cartadjustment string id of the associated cart adjustment group. 57.0 groupid 1917apex reference guide connectapi output classes property name type description available version cartitemid string
id of the associated cart item. 57.0 id string id of the cart item price adjustment. 57.0 priceadjustment string id of the associated promotion. 57.0 causeid priority integer where in the sequence of adjustments this 57.0 adjustment was applied. see also: connectapi.promotioncartitem connectapi.promotioncart connectapi.promotionevaluation evaluate(salestransaction) connectapi.promotioncoupon a coupon used in a promotion. property name type description available version couponcode string coupon code. 57.0 couponerrorcode string error code returned if the coupon is invalid. 57.0 id string id of the coupon. 57.0 isvalidcoupon boolean indicates whether the coupon is valid (true) or 57.0 invalid (false). see also: connectapi.promotionevaluation evaluate(salestransaction) connectapi.promotionevaluation results of a promotion evaluation. property name type description available version cart connectapi. cart and its items. 57.0 promotioncart 1918apex reference guide connectapi output classes property name type description available version coupons list<connectapi. list of coupon codes to enable promotions. a 57.0 promotioncoupon> customer can apply a maximum of two coupons. see also: evaluate(salestransaction) connectapi.purchasequantityrule rule that restricts the quantity of a product that can be purchased. property name type description available version increment string increment value of the quantity that can be 52.0 purchased. maximum string maximum quantity that can be purchased. 52.0 minimum string minimum quantity that can be purchased. 52.0 see also: connectapi.cartitemproduct connectapi.productdetail connectapi.productsummary connectapi.questionandanswerscapability if a feed element has this capability, it has a question and comments on the feed element are answers to the question. subclass of connectapi.feedelementcapability. property name type description available version bestanswer connectapi. comment selected as the best answer for the 32.0 comment question. bestanswer connectapi. user who selected the best answer for the question. 32.0 selectedby usersummary cancurrentuser boolean indicates whether the context user can select or 32.0 selectorremove remove a best answer (true) or not (false). bestanswer candidateanswers connectapi. status of candidate answers for the question. 41.0 candidateanswers status escalatedcase connectapi. if a question post is escalated, this is the case to which 33.0 reference it was escalated. 1919apex reference guide connectapi output classes property name type description available version questiontitle string title for the question. 32.0 see also: connectapi.feedelementcapabilities connectapi.questionandanswerssuggestions question and answers suggestions. property name type description available version articles list<connectapi. list of articles. 32.0 articleitem> questions list<connectapi. list of questions. 32.0 feedelement> connectapi.rankaveragedistanceoutputrepresentation the results of calculating the average distances from sets of inventory locations to an order recipient. subclass of connectapi.baseoutputrepresentation. property name type description available version distanceunit string the specified unit of distance (miles or kilometers). 51.0 results list<connectapi. the results of the shipping distance calculations. 51.0 averagedistanceresult outputrepresentation> connectapi.readby information about who read the feed element and when. property name type description available version lastreaddatebyuser datetime when the user last read the feed element in iso 8601 40.0 format. user connectapi. information about the user who read the feed 40.0 usersummary element. see also: connectapi.readbypage 1920apex reference guide connectapi output classes connectapi.readbycapability if a feed element has this capability, the context user can mark it as read. subclass of connectapi.feedelementcapability. property name type description available version isreadbyme boolean specifies whether the feed element has been read 40.0 (true) or not (false) by the context user. lastreaddatebyme datetime last date when the feed element was marked read 40.0 for the
context user in iso 8601 format. otherwise, null. page connectapi. first page of information about who read the feed 40.0 readbypage element and when. see also: connectapi.feedelementcapabilities connectapi.readbypage a collection of information about who read the feed element and when. property name type description available version currentpagetoken string token identifying the current page. 40.0 currentpageurl string connect rest api url identifying the current page. 40.0 the default is 25 items per page. items list<connectapi. collection of read-by information, including users 40.0 readby> and when they last read the feed element. nextpagetoken string token identifying the next page, or null if there 40.0 isn’t a next page. nextpageurl string connect rest api url identifying the next page, or 40.0 null if there isn’t a next page. previouspagetoken string reserved for future use. 40.0 previouspageurl string reserved for future use. 40.0 1921apex reference guide connectapi output classes property name type description available version total integer total number of users who read the feed element. 40.0 note: this count appears in the ui under feed posts in private and unlisted chatter groups as the “seen by” number, for example, “seen by 48.” see also: connectapi.readbycapability connectapi.recommendation a next best action recommendation object. property name type description available version acceptancelabel string text indicating user acceptance of the 45.0 recommendation. actionreference string reference to the action to perform, for example, 45.0 launching a flow. description string description of the recommendation. 45.0 externalid string external id of the recommendation. this id doesn’t 46.0 need to be a salesforce 18-character id. for example, it can be a product number from an external system. id string id of the recommendation. 45.0 image connectapi. image to display. 45.0 fileasset name string name of the recommendation. 45.0 rejectionlabel string text indicating user rejection of the recommendation. 45.0 url string url to the recommendation. 45.0 connectapi.recommendationaudience a custom recommendation audience. property name type description available version criteria connectapi. the criteria for the custom recommendation audience 36.0 audiencecriteria type. id string 18-character id of the custom recommendation 35.0 audience. 1922apex reference guide connectapi output classes property name type description available version membercount integer 35.0 only important: this property is available only in version 35.0. in version 36.0 and later, this property is available in connectapi.customlistaudiencecriteria. number of members in the custom recommendation audience. members connectapi. 35.0 only important: this property is available only in userreferencepage version 35.0. in version 36.0 and later, this property is available in connectapi.customlistaudiencecriteria. members of the custom recommendation audience. modifiedby connectapi.user user who last modified the custom recommendation 36.0 audience. modifieddate datetime iso 8601 format date string, for example, 36.0 2011-02-25t18:24:31.000z. name string name of the custom recommendation audience. 35.0 url string url to the custom recommendation audience. 35.0 see also: connectapi.recommendationaudiencepage connectapi.recommendationaudiencepage a list of custom recommendation audiences. property name type description available version audiencecount integer the total number of custom recommendation 35.0 audiences. currentpageurl string url to the current page. 35.0 nextpageurl string url to the next page. 35.0 previouspageurl string url to the previous page. 35.0 recommendation list<connectapi. a list of custom recommendation audiences. 35.0 audiences recommendation audience> connectapi.recommendationcollection a list of chatter, custom, and static recommendations. 1923apex reference guide connectapi output classes property name type description available version recommendations list<connectapi. collection of chatter, custom, and static 33.0 abstract recommendations. recommendation> connectapi.recommendationdefinition represents a custom recommendation
definition. property name type description available version actionurl string the url for acting on this custom recommendation. 35.0 actionurlname string the text label for the action url in the user interface. 35.0 explanation string explanation of the custom recommendation 35.0 definition. id string 18-character id of the custom recommendation 35.0 definition. name string name of the custom recommendation definition. 35.0 the name is displayed in setup. photo connectapi.photo photo of the custom recommendation definition. 35.0 title string title of the custom recommendation definition. 35.0 url string url to the connect rest api resource for the custom 35.0 recommendation definition. see also: connectapi.recommendationdefinitionpage connectapi.scheduledrecommendation connectapi.recommendationdefinitionpage a list of custom recommendation definitions. property name type description available version recommendation list<connectapi. a list of custom recommendation definitions. 35.0 definitions recommendation definition> url string url to the connect rest api resource for the 35.0 recommendation definition collection. 1924apex reference guide connectapi output classes connectapi.recommendationexplanation explanation for a chatter recommendation. subclass of connectapi.abstractrecommendationexplanation. property name type description available version detailsurl string url to explanation details or null if the chatter 32.0 recommendation doesn’t have a detailed explanation. see also: connectapi.abstractrecommendation connectapi.recommendationreaction a reaction to a recommendation produced by a recommendation strategy property name type description available version aimodel string reserved for future use. 47.0 contextrecord connectapi.reference reference to the context record. 45.0 createdby connectapi. reference to the reaction creator. 45.0 reference createddate datetime reaction creation date. 45.0 externalid string external target id of the recommendation reacted 46.0 on. this id doesn’t need to be a salesforce 18-character id. for example, it can be a product number from an external system. id string reaction record id. 45.0 onbehalfof connectapi. reference to the user or record that is indirectly 45.0 reference reacting to the recommendation. reactiontype connectapi. type of reaction to a recommendation. values are: 45.0 recommendationreaction • accepted type • rejected recommendation string reserved for future use. 46.0 mode recommendation double reserved for future use. 46.0 score strategy connectapi. strategy that recommended the target record. 45.0 recordsnapshot 1925apex reference guide connectapi output classes property name type description available version targetaction connectapi. target action that is recommended. 45.0 recordsnapshot targetrecord connectapi. reference to the target record. 45.0 reference url string url to the recommendation reaction. 45.0 see also: connectapi.recommendationreactions connectapi.recommendationreactions a list of recommendation reactions. property name type description available version currentpageurl string url to the current page of reactions in the collection. 45.0 nextpageurl string url to the next page of reactions in the collection. 45.0 reactions list<connectapi. collection of recommendation reactions. 45.0 recommendation reaction> connectapi.recommendationscapability if a feed element has this capability, it has a recommendation. subclass of connectapi.feedelementcapability. property name type description available version items list<connectapi. a list of recommendations. 32.0 abstract recommendation> see also: connectapi.feedelementcapabilities connectapi.recommendedobject a recommended object, such as a custom or static recommendation. subclass of connectapi.actor 1926apex reference guide connectapi output classes property name type description available version idorenum string id of a recommendation definition for a custom 34.0 recommendation or the enum value today for static recommendations that don’t have an id (version 35.0 and later). motif connectapi.motif motif of the recommended object. 34.0 connectapi.recordcapability if a comment has this capability, it has a record attachment. subclass of connectapi.feedelementcapability. property name type description available version recordid string id of the record. 42.0 url string url to
the record. 42.0 connectapi.recordfield generic record field containing a label and text value. subclass of connectapi.labeledrecordfield. no additional properties. see also: connectapi.compoundrecordfield connectapi.orderitemsummary connectapi.orderitemsummaryproduct connectapi.orderdeliverygroupsummary connectapi.ordersummaryrepresentation connectapi.recordsnapshot a record snapshot in a recommendation reaction. property name type description available version id string id of the record. 45.0 nameatsnapshot string name of the record when the id was recorded. 45.0 see also: connectapi.recommendationreaction 1927apex reference guide connectapi output classes connectapi.recordsnapshotcapability if a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event. subclass of connectapi.feedelementcapability. property name type description available version recordview connectapi. a record representation that includes metadata and 32.0 recordview data so you can display the record easily. see also: connectapi.feedelementcapabilities connectapi.recordsummary record summary. subclass of connectapi.abstractrecordview. property name type description available version entitylabel connectapi. label of the record’s entity. 40.0 entitylabel see also: connectapi.emailaddress connectapi.emailattachment connectapi.referencerecordfield connectapi.referencewithdaterecordfield connectapi.recordsummarylist summary information about a list of records in the organization including custom objects. name type description available version records list<connectapi.actorwithid> a list of records. 30.0 url string the url to this list of records. 30.0 connectapi.recordview a view of any record in the org, including a custom object record. this object is used if a specialized object, such as user or chattergroup, isn’t available for the record type. subclass of connectapi.abstractrecordview. 1928apex reference guide connectapi output classes name type description available version sections list<connectapi. list of record view sections. 29.0 recordviewsection> see also: connectapi.recordsnapshotcapability connectapi.recordviewsection section of record fields and values on a record detail. name type description available version columncount integer number of columns to use to lay out the fields in a record 29.0 section. columnorder connectapi. order of the fields to use in the fields property to lay out 29.0 recordcolumnorder the fields in a record section. enum • leftright—fields are rendered from left to right. • topdown—fields are rendered from the top down. fields connectapi. fields and values for the record contained in this section. 29.0 abstract recordfield heading string localized label to display when rendering this section of fields. 29.0 iscollapsible boolean indicates whether the section can be collapsed to hide all the 29.0 fields (true) or not (false). see also: connectapi.recordview connectapi.recordsetfiltercriteriacollection list of the recordset filters and records. property name type description available version recordsetfilters list<connectapi. collection of recordset filter criteria ids and filtered 53.0 recordsetfiltercriteria> record ids. connectapi.recordsetfiltercriteria recordset filter criteria and the filtered records. 1929apex reference guide connectapi output classes property name type description available version criteriaid string recordset filter criteria id. 53.0 recordids list<string> list of filtered record ids. 53.0 see also: connectapi.recordsetfiltercriteriacollection connectapi.reference reference to a record. name type description available version id string the id of the record being referenced, which could be an 18-character 28.0 id or some other string identifier. url string the url to the resource endpoint. 28.0 connectapi.referencerecordfield record field with a label and text value. subclass of connectapi.labeledrecordfield. name type description available version reference connectapi. object referenced by the record field. 29.0 recordsummary connectapi.referencedrefundresponse refund comprehensive output. property name type
description available version error connectapi. error response representation for the refund. 50.0 errorresponse gatewayresponse connectapi. gateway response received for the processed refund 50.0 refundgatewayresponse request. paymentgatewaylogs list<connectapi. gateway log collection representation for the refund. 50.0 gatewaylogresponse> paymentgroup connectapi. payment group associated with the refund. 50.0 paymentgroupresponse refund connectapi. refund response representation. 50.0 refundresponse 1930apex reference guide connectapi output classes connectapi.referencewithdaterecordfield record field containing a referenced object that acted at a specific time, for example, “created by...”. subclass of connectapi.labeledrecordfield. name type description available version datevalue datetime time at which the referenced object acted. 29.0 reference connectapi. object referenced by the record field. 29.0 recordsummary connectapi.refundgatewayresponse refund gateway response. subclass of connectapi.abstractgatewayresponse. no additional properties. connectapi.refundresponse refund output. property name type description available version accountid string id of the account related to the refund record. 50.0 amount double total amount of the refund transaction performed in 50.0 the payment request. currencyisocode string three-letter iso 4217 currency code associated with 50.0 the payment group record. effectivedate datetime date that the refund becomes effective. 50.0 id string id of the refund record. 50.0 refundnumber string number of the refund record that was created as a 50.0 result of the request processing. requestdate datetime date when the refund occurred. 50.0 status string indicates the results of processing the refund 50.0 transaction in the gateway. can be draft, processed or cancelled. connectapi.relatedfeedpost this class is abstract. subclass of: connectapi.actorwithid superclass of: connectapi.relatedquestion 1931apex reference guide connectapi output classes property name type description available version score double score of the related feed post that indicates how 37.0 closely related it is to the context feed post. title string title of the related feed post. 37.0 see also: connectapi.relatedfeedposts connectapi.relatedfeedposts a collection of related feed posts. property name type description available version relatedfeedposts list<connectapi. collection of related feed posts. 37.0 relatedfeedpost> connectapi.relatedquestion a related question. subclass of: connectapi.relatedfeedpost property name type description available version hasbestanswer boolean indicates whether the question has a best answer. 37.0 interactions connectapi. the number of individual views, likes, and comments 38.0 interactions on a question. capability connectapi.releaseheldfocapacityoutputrepresentation response to a request to confirm held fulfillment order capacity at one or more locations. can correspond to one action call. subclass of connectapi.baseoutputrepresentation. property name type description available version releaseheldfo list<connectapi. list of responses to the requests to confirm held 55.0 capacityresponses releaseheldfo fulfillment order capacity at one or more locations. capacityresponse outputrepresentation> connectapi.releaseheldfocapacityresponseoutputrepresentation response to a request to release held fulfillment order capacity at one or more locations. 1932
apex reference guide connectapi output classes property name type description available version capacityresponses list<connectapi. list of responses to the requests to release held 55.0 capacityresponse fulfillment order capacity at individual locations. outputrepresentation> connectapi.replyintent reply intent for a social post. property name type description available version managedsocialaccount connectapi. managed social account that replies to the social 45.0 managedsocialaccount post. see also: connectapi.replyintents connectapi.replyintents list of reply intents for a social post. property name type description available version replies list<connectapi. list of reply intents for the social post. 45.0 replyintent> see also: connectapi.socialpostintents connectapi.repositoryfiledetail a detailed description of a repository file. subclass of connectapi.abstractrepositoryfile no additional properties. connectapi.repositoryfilesummary a summary of a repository file. subclass of connectapi.abstractrepositoryfile no additional properties. see also: connectapi.repositoryfolderitem 1933apex reference guide connectapi output classes connectapi.repositoryfolderdetail a detailed description of a repository folder. subclass of connectapi.abstractrepositoryfolder no additional properties. connectapi.repositoryfolderitem a folder item. property name type description available version file connectapi. if the folder item is a file, the file summary. if the folder 39.0 repository item is a folder, null. filesummary folder connectapi. if the folder item is a folder, the folder summary. if 39.0 repository the folder item is a file, null. foldersummary type connectapi. type of item in a folder. values are: 39.0 folderitemtype • file • folder see also: connectapi.repositoryfolderitemscollection connectapi.repositoryfolderitemscollection a collection of repository folder items. property name type description available version currentpageurl string url to the current page of items. 39.0 items list<connectapi. collection of items in a repository folder. 39.0 repository folderitem> nextpageurl string url to the next page of items, or null if there isn’t 39.0 a next page. previouspageurl string url to the previous page of items, or null if there 39.0 isn’t a previous page. connectapi.repositoryfoldersummary a summary of a repository folder. 1934apex reference guide connectapi output classes subclass of connectapi.abstractrepositoryfolder no additional properties. see also: connectapi.repositoryfolderitem connectapi.repositorygroupsummary a group summary. subclass of connectapi.abstractdirectoryentrysummary property name type description available version grouptype connectapi. type of group. values are: 39.0 contenthub • everybody—group is public to everybody. grouptype • everybodyindomain—group is public to everybody in the same domain. • unknown—group type is unknown. name string name of the group. 39.0 see also: connectapi.externalfilepermissioninformation connectapi.repositoryusersummary a user summary. subclass of connectapi.abstractdirectoryentrysummary property name type description available version firstname string first name of the user. 39.0 lastname string last name of the user. 39.0 connectapi.reputation reputation for a user. property name type description available version reputationlevel connectapi. user’s reputation level. 32.0 reputationlevel reputationpoints double user's reputation points, which can be earned by 32.0 performing different activities. 1935apex reference guide connectapi output classes property name type description available version url string connect rest api url to the reputation. 32.0 see also: connectapi.user connectapi.reputationlevel reputation level for a user. property name type description available version levelimageurl string url to the reputation level image. 32.0 levelname string name of the reputation level. 32.0 levelnumber integer reputation level number, which is the numerical rank 32.0 of the level, with the lowest level at 1. administrators define the reputation level point ranges. see also: connectapi
.reputation connectapi.requestheader an http request header name and value pair. property name type description available version name string the name of the request header. 33.0 value string the value of the request header. 33.0 see also: connectapi.actionlinkdefinition connectapi.resourcelinksegment resource link segment. name type description available version url string url to a resource not otherwise identified by an id field, for example, 28.0 a link to a list of users. 1936apex reference guide connectapi output classes connectapi.returnitemsoutputrepresentation output of return items. includes the id of the generated change order for items and delivery charges being returned, as well as the id of the generated change order for any charged return fees. also includes information about any returnorderlineitems that were created to represent remaining return quantities. subclass of connectapi.baseoutputrepresentation. property name type description available version changeorderid string id of the change order created by processing the 52.0 returnorderlineitems representing returned items and delivery charges. use this change order to create a credit memo. feechangeorderid string id of the change order created by processing the 56.0 returnorderlineitems representing return fees. use this change order to create an invoice. returnlineitem list<connectapi. list of properties representing any remaining 52.0 splits returnorderitem quantities from partial returns processed by this call. splitline it includes order items, delivery charges, and return outputrepresentation> fees. each element of the list includes the id of a split returnorderlineitem and the id of the partially processed returnorderlineitem whose remaining quantity it holds. see also: returnitems(returnorderid, returnitemsinput) connectapi.returnorderitemsplitlineoutputrepresentation after a change order is created for a returnorderlineitem, that returnorderlineitem is read-only. if the return items api is used to return a partial quantity, it creates a new “split” returnorderlineitem to hold the remaining quantity to be returned. in that case, it returns this output property, which contains the ids of the original and split returnorderlineitems. subclass of connectapi.baseoutputrepresentation. property name type description available version newreturnorderitemid string id of the new returnorderlineitem that holds the 52.0 remaining return quantity. original string id of the original returnorderlineitem. 52.0 returnorderitemid see also: connectapi.returnitemsoutputrepresentation returnitems(returnorderid, returnitemsinput) 1937apex reference guide connectapi output classes connectapi.returnorderoutputrepresentation id of the created returnorder. subclass of connectapi.baseoutputrepresentation. property name type description available version returnorderid string id of the created returnorder. 50.0 see also: createreturnorder(returnorderinput) connectapi.saleresponse payment sale response. property name type description available version error connectapi. error representation for the payment sale. 54.0 errorresponse gatewayresponse connectapi. information from the payment gateway following 54.0 salegatewayresponse the sale request. payment connectapi. information about the payment used in the sale 54.0 paymentresponse request. paymentgatewaylogs list<connectapi. collection of responses from the gateway following 54.0 gatewaylogresponse> the sale request. paymentgroup connectapi. payment group used in the sale request. 54.0 paymentgroupresponse paymentmethod connectapi. payment method used in the sale request. 54.0 paymentmethodresponse connectapi.salegatewayresponse sale gateway response. subclass of connectapi.abstractgatewayresponse. no additional properties. connectapi.scheduledrecommendation represents a scheduled custom recommendation. 1938apex reference guide connectapi output classes property name type description available version channel connectapi. a way to tie custom recommendations together. for 36.0 recommendation example, display recommendations in specific places channel in the ui or show recommendations based on time of day or geographic locations. values are: • customchannel1—custom recommendation channel. not used by default. work with your community manager to define custom channels. for example, community managers can use experience builder to determine where recommendations appear. • customchannel2—custom recommendation channel. not used by default
. work with your community manager to define custom channels. • customchannel3—custom recommendation channel. not used by default. work with your community manager to define custom channels. • customchannel4—custom recommendation channel. not used by default. work with your community manager to define custom channels. • customchannel5—custom recommendation channel. not used by default. work with your community manager to define custom channels. • defaultchannel—default recommendation channel. recommendations appear by default on the home and question detail pages of customer service and partner central experience builder templates. they also appear in the feed in the salesforce mobile web and anywhere community managers add recommendations using experience builder. enabled boolean indicates whether scheduling is enabled. if true, 35.0 the custom recommendation is enabled and appears in experience cloud sites. if false, custom recommendations in feeds in salesforce mobile web aren’t removed, but no new custom recommendations appear. in customer service and partner central sites, disabled custom recommendations no longer appear. id string 18-character id of the scheduled custom 35.0 recommendation. 1939apex reference guide connectapi output classes property name type description available version rank integer the rank determining the order of this scheduled 35.0 custom recommendation. recommendation string id of the audience for the scheduled custom 35.0 audienceid recommendation. recommendation connectapi. custom recommendation definition that this 35.0 definition recommendation scheduled recommendation schedules. representation definition url string url to the connect rest api resource for the 35.0 scheduled custom recommendation. see also: connectapi.scheduledrecommendationpage connectapi.scheduledrecommendationpage a list of scheduled custom recommendations. property name type description available version scheduled list<connectapi. a list of scheduled custom recommendations. 35.0 recommendations scheduled recommendation> url string url to the connect rest api resource for the 35.0 scheduled custom recommendation collection. connectapi.scope scope information for a target. property name type description available version name string name of the scope for the target. 48.0–49.0 value string value of the scope for the target. 48.0–49.0 see also: connectapi.target connectapi.searchcategory search category. 1940apex reference guide connectapi output classes property name type description available version category connectapi. information about the category. 52.0 productcategorydata children list<connectapi. first-level child categories of the category searched 52.0 searchcategory> with non-empty search results. productcount long number of products in the search results that belong 52.0 to the category. see also: connectapi.productsearchresults connectapi.searchfacet search facet. this class is abstract and is a superclass of connectapi.distinctvaluesearchfacet. property name type description available version attributetype connectapi. search attribute type. values are: 52.0 commercesearch • custom attributetype • productattribute • productcategory • standard displayname string display name of the facet. 52.0 displayrank integer display rank of the facet. valid values are from 1 52.0 through 50. displaytype connectapi. display type of the facet. values are: 52.0 commercesearchfacet • categorytree displaytype • datepicker • multiselect • singleselect facettype connectapi. search facet type. value is: 52.0 commercesearch • distinctvalue facettype nameorid string developer name of the attribute. in version 52.0 and 52.0 later, the id of the attribute isn’t supported. see also: connectapi.productsearchresults 1941apex reference guide connectapi output classes connectapi.searchsuggestion search suggestion. property name type description available version value string search suggestion. 52.0 see also: connectapi.productsearchsuggestionsresults connectapi.serviceappointmentoutput output of the create service appointment request. property name type description available version result connectapi.serviceappointmentresult result of the create or update service appointment 53.0 request. connectapi.serviceappointmentresult contains result of the service appointment. property name type description available version assignedresourceids list<string> the ids
of the assigned resources. 53.0 parentrecordid string the id of the parent record. 53.0 serviceappointmentid string the id of the service appointment record. 53.0 connectapi.shiftsfrompattern shifts created from a pattern. property name type description available version count integer total count of created shifts. 51.0 error connectapi.shifts error details for shifts from a pattern. 53.0 frompatternerror issuccess boolean indicates if the request is successful (true) or not 53.0 (false). recordids list<string> collection of created shift ids. 51.0 1942apex reference guide connectapi output classes connectapi.shiftsfrompatternerror shifts from pattern error response. property name type description available version code string error code. 53.0 invalidservice string id of invalid service resource. 53.0 resourceid message string error message. 53.0 connectapi.sitesearchitem site search result item. property name type description available version contentreference string content reference field, which is the route developer 54.0 name for a site page or a content key for a content detail page. contenttype string developer name of the content type of the site search 54.0 developername result item. highlightedsnippet string text snippet that contains the query term. 54.0 id string id of the site search result item. 54.0 pagetype connectapi. type of site search result item. values are: 54.0 sitespagetype • contentpage • sitepage title string title of the site search result item. 54.0 see also: connectapi.sitesearchresult connectapi.sitesearchresult site search result. property name type description available version currentpagetoken string token for the current page of search results. 54.0 currentpageurl string url to the current page of search results. 54.0 items list<connectapi. collection of search result items. 54.0 sitesearchitem> 1943apex reference guide connectapi output classes property name type description available version language string language of the search results. 54.0 nextpagetoken string token for the next page of search results. 54.0 nextpageurl string url to the next page of search results, or null if 54.0 there isn’t a next page. pagesize integer number of items per page in search results. 54.0 previouspagetoken string token for the previous page of search results. 54.0 previouspageurl string url to the previous page of search results, or null 54.0 if there isn’t a previous page. totalitems integer total number of items in the search results across all 54.0 pages. connectapi.socialaccount a social account on a social network. property name type description available version externalsocial string id of the external social account, if available. 38.0 accountid handle string social handle, screen name, or alias that identifies 36.0 this account. name string name of the account as defined by the account's 36.0 owner. profileurl string url to the account's profile. 36.0 socialpersonaid string id of the social persona account, if the external social 39.0 account id isn’t available. see also: connectapi.socialpostcapability connectapi.socialaccountrelationship follow relationship between a managed social account and a social persona. property name type description available version isfollowed boolean specifies whether the social account is followed by 46.0 the social persona. isfollowing boolean specifies whether the social account is following the 46.0 social persona. 1944apex reference guide connectapi output classes property name type description available version socialaccountid string id of the social account. 46.0 socialpersonaid string id of the social persona. 46.0 connectapi.socialpostcapability if a feed element has this capability, it can interact with a social post on a social network. subclass of connectapi.feedelementcapabilities. property name type description available version author connectapi. social account that authored the social post. 36.0 socialaccount content string content body of the social post. 36.0 deletedby connectapi.user user who deleted the social post. 38.0 summary hiddenby connectapi.user user who hid the social post. 41.0 summary icon connectapi.icon icon of the social network. 36.0 id string id associated with the social
post salesforce record. 36.0 isoutbound boolean if true, the social post originated from the 36.0 salesforce application. likedby string external social account who liked the social post. 40.0 messagetype connectapi. message type of the social post. values are: 38.0 socialpost • comment messagetype • direct • post • privatemessage • reply • retweet • tweet name string title or heading of the social post. 36.0 posturl string external url to the social post on the social network. 36.0 provider connectapi. social network that this social post belongs to. values 36.0 socialnetwork are: provider • facebook • googleplus • instagram 1945apex reference guide connectapi output classes property name type description available version • instagrambusiness • kakaotalk • kik • line • linkedin • messenger • other • pinterest • qq • rypple • sinaweibo • sms • snapchat • telegram • twitter • vkontakte • wechat • whatsapp • youtube recipient connectapi. social account that is the recipient of the social post. 36.0 socialaccount recipientid string id of the recipient of the social post. 38.0 reviewscale double review scale of the social post. 40.0 reviewscore double review score of the social post. 40.0 status connectapi. status of the social post. 36.0 socialpoststatus see also: connectapi.feedelementcapabilities connectapi.socialpostintents intents available for a social post. property name type description available version approvalintent connectapi. approval intent for the social post. 45.0 approvalintent 1946apex reference guide connectapi output classes property name type description available version deleteintent connectapi. delete intents for the social post. 45.0 deleteintents followintent connectapi. follow intents for the social persona. 45.0 followintents hideintent connectapi. hide intent for the social post. 45.0 hidesocial postintent likeintent connectapi. like intents for the social post. 45.0 likeintents replyintent connectapi. reply intents for the social post. 45.0 replyintents connectapi.socialpostmassapprovaloutput approval or rejection of a large number of social posts. property name type description available version isapproved boolean specifies whether the social posts were approved 46.0 (true) or rejected (false) for publishing. connectapi.socialpoststatus the status of a social post. property name type description available version message string status message. 36.0 1947apex reference guide connectapi output classes property name type description available version type connectapi. status type. values are: 36.0 socialpoststatustype • approvalpending • approvalrecalled • approvalrejected • deleted • failed • hidden • pending • sent • unknown see also: connectapi.socialpostcapability connectapi.stamp a user stamp. property name type description available version description string description of the stamp. 39.0–43.0 id string id of the stamp. 39.0–43.0 imageurl string image url of the stamp. 39.0–43.0 label string label of the stamp. 39.0–43.0 see also: connectapi.user connectapi.sortrule sort rule. property name type description available version direction connectapi. direction of the sort rule. values are: 52.0 commercesearch • ascending—sorts in ascending alphanumeric sortruledirection order (a–z, 0–9). • default—when no direction is defined, sorts by relevance. 1948apex reference guide connectapi output classes property name type description available version • descending—sorts in descending alphanumeric order (z–a, 9–0). label string label of the sort rule. 52.0 labelsuffix connectapi. label suffix of the sort rule.values are: 54.0 commercesearch • ascen—label suffix for 'asc' sortrulelabelsuffix • ascending—label suffix for 'ascending' • az—label suffix for 'a-z' • descen
—label suffix for 'desc' • descending—label suffix for 'descending' • fewmany—label suffix for 'few-many' • heavylight—label suffix for 'heavy-light' • highlow—label suffix for 'high-low' • highestlowest—label suffix for 'highest-lowest' • lightheavy—label suffix for 'light-heavy' • lowhigh—label suffix for 'low-high' • lowesthighest—label suffix for 'lowest-highest' • manyfew—label suffix for 'many-few' • newold—label suffix for 'new-old' • newest—label suffix for 'newest' • newestoldest—label suffix for 'newest-oldest' • ninezero—label suffix for '9-0' • oldnew—label suffix for 'old-new' • oldest—label suffix for 'oldest' • oldestnewest—label suffix for 'oldest-newest' • pricedecreasing—label suffix for '$$-$' • priceincreasing—label suffix for '$-$$' • thickthin—label suffix for 'thick-thin' • thinthick—label suffix for 'thin-thick' • za—label suffix for 'z-a' • zeronine—label suffix for '0-9' nameorid string name of the sort rule field or, if the sort rule is based 52.0 on a custom field, id. 1949apex reference guide connectapi output classes property name type description available version sortorder integer sort order for the rule. a lower number has higher 54.0 precedence. the first sort option is called when no other option is selected. sortruleid string id of the sort rule. 52.0 type connectapi. type of sort rule. values are: 52.0 commercesearch • productattributebased—sorts by sortruletype product attribute fields. • productbased—sorts by product field data. • relevancy—sorts by product and catalog term frequency. • sortbypricebook—sorts by product prices defined in the specified pricebook (version 55.0 and later). see also: connectapi.sortrulescollection connectapi.sortrulescollection collection of sort rules. property name type description available version sortrules list<connectapi. collection of sort rules. 52.0 sortrule> connectapi.statuscapability if a feed post or comment has this capability, it has a status that determines its visibility. subclass of connectapi.feedelementcapability. property name type description available version feedentitystatus connectapi. status of the feed post or comment. values are: 37.0 feedentitystatus • draft—the feed post isn’t published but is visible to the author and users with modify all data or view all data permission. comments can’t be drafts. • pendingreview—the feed post or comment isn’t approved yet and therefore isn’t published or visible. 1950apex reference guide connectapi output classes property name type description available version • published—the feed post or comment is approved and visible. isapprovablebyme boolean specifies whether the context user can change the 37.0 status of the feed post or comment. see also: connectapi.commentcapabilities connectapi.feedelementcapabilities connectapi.strategytrace messages and trace nodes for a recommendation strategy execution. property name type description available version messages list<string> messages and errors from the strategy execution. 45.0 nodes list<connectapi. nodes of the strategy execution used for debugging. 45.0 strategytracenode> see also: connectapi.nbarecommendations connectapi.strategytracenode a trace node for a recommendation strategy execution. property name type description available version inputcount integer number of items put into the node. 45.0 messages list<string> messages that occurred during node execution. 45.0 nodename string name of the node. 45.0 nodetime long time spent processing inside the node. 45.0 nodetype string type of node. 45.0 outputcount integer number of items returned from the node. 45.0 outputs list<string> recommendations that are returned from the node. 45.0 1951apex reference guide connectapi output classes
property name type description available version totaltime long total time spent processing. 45.0 see also: connectapi.strategytrace connectapi.submitcanceloutputrepresentation id of the change order created for a cancel action, and a set of its financial values. subclass of connectapi.baseoutputrepresentation. property name type description available version changebalances connectapi. financial values resulting from the cancel. 48.0 changeitem outputrepresentation changeorderid string id of the change order created for the canceled order 48.0 items and shipping charges. use this change order to create a credit memo. feechangeorderid string id of the change order created by canceling order 57.0 items with associated cancel fees. use this change order to create an invoice. connectapi.submitreturnoutputrepresentation id of the change order created for a return action, and a set of its financial values. subclass of connectapi.baseoutputrepresentation. property name type description available version changebalances connectapi. financial values resulting from the return. 48.0 changeitem outputrepresentation changeorderid string id of the change order created for the returned order 48.0 items and shipping charges. use this change order to create a credit memo. feechangeorderid string id of the change order created by returning order 57.0 items with associated return fees. use this change order to create an invoice. connectapi.subscription subscription. 1952apex reference guide connectapi output classes name type description available version community connectapi.reference information about the experience cloud site in 28.0 which the subscription exists. id string subscription’s 18–character id. 28.0 subject connectapi.actor information about the parent, that is, the thing 28.0 or person being followed. subscriber connectapi.actor information about the subscriber, that is, the 28.0 person following this item. url string connect rest api url to this specific 28.0 subscription. see also: connectapi.followerpage connectapi.followingpage connectapi.supportedemojis a collection of supported emojis. property name type description available version supportedemojis connectapi.emojicollection a collection of supported emojis. 39.0 connectapi.surveyinvitationemailoutput survey invitation email. property name type description available version errorcode integer error code for the failed call. 50.0 errormessage string details explaining why the call failed. 50.0 status connectapi. status of a survey invitation email. values are: 50.0 surveyemailstatus • failed—the survey invitation email wasn't enum sent. • queued—the survey invitation email is queued for sending. connectapi.target personalization target information. 1953apex reference guide connectapi output classes property name type description available version audience connectapi. audience assigned to the target. 48.0 audiencetarget formulascope connectapi. formula scope of the target. 50.0 formulascope groupname string group name of the target. groups bundle related 48.0 target and audience pairs. id string id of the target. 48.0 priority integer priority of the target. within a group, priority 48.0 determines which target is returned if the user matches more than one audience. publishstatus connectapi. publish status of the target. values are: 48.0 publishstatus • draft • live scope list<connectapi. list of scopes for the target. 48.0–49.0 scope> in version 50.0 and later, the formulascope property returns this information. targettype string type of target, indicating the nature of the data being 48.0 targeted. targetvalue string value of the target. 48.0 url string url to the target. 48.0 see also: connectapi.targetcollection connectapi.targetcollection list of personalization targets. property name type description available version targets list<connectapi. list of personalization targets. 48.0 target> connectapi.calculatetaxresponse shows the results of a tax calculation request. subclass of connectapi.taxtransactionresponse. 1954apex reference guide connectapi output classes property name type description available version adaptererror connectapi. adapter error. 55.0 errorresponse
status connectapi. status of a tax transaction. values are: 55.0 taxtransaction • committed—tax has been committed to the status transaction. • uncommitted—tax hasn’t been committed to the transaction. taxenginelogs list<connectapi. tax engine logs. 55.0 taxengine logresponse> taxtransactiontype connectapi. type of tax transaction. values are: 55.0 taxtransaction • credit—transaction is a credit transaction. type • debit—transaction is a debit transaction. taxtype connectapi. type of tax calculation. values are: 55.0 calculatetaxtype • actual—calculated tax represents the final taxed amount for the transaction. • estimated—calculated tax represents only an estimated value before the transaction is finalized. connectapi.taxaddressresponse location code of an address. property name type description available version locationcode string location code of an address. 55.0 connectapi.taxaddressesresponse the ship from, ship to, and sold to addresses used during tax calculation. property name type description available version shipfrom connectapi. the ship from address used in tax calculation. 55.0 taxaddress response shipto connectapi. the ship to address used in tax calculation. 55.0 taxaddress response 1955apex reference guide connectapi output classes property name type description available version soldto connectapi. the sold to address used in tax calculation. 55.0 taxaddress response connectapi.taxamountdetailsresponse information about tax amount values on the line item. property name type description available version exemptamount double amount of the line item exempt from tax application. 55.0 taxamount double tax amount for the line item. 55.0 totalamount double total amount of the line item. 55.0 totalamountwithtax double the line item's total amount with tax. 55.0 connectapi.taxdetailsresponse tax details for each line item in a tax line item output. property name type description available version exemptamount double amount of the line item that is exempt from taxation. 55.0 exemptreason string the reason that any tax exemption applied to the 55.0 line item. imposition connectapi. the business justification for applying tax to a line 55.0 taximposition item. response jurisdiction connectapi. business address used to calculate the tax rate for the 55.0 taxjurisdiction line item. response rate double tax rate for the line item. 55.0 tax double total amount of tax on the line item. 55.0 taxid string id for the type of tax applied to the line item. 55.0 taxableamount double amount of line item that can be taxed. 55.0 connectapi.taxaddressresponse address output representation for tax calculation. 1956apex reference guide connectapi output classes property name type description available version locationcode string location code. 55.0 connectapi.taxenginelogresponse shows the results of the tax calculation request to the tax engine. property name type description available version createddate datetime the date that the gateway log was created. 55.0 id string id of the tax engine log record. 55.0 resultcode string result code sent from the external tax engine. review 55.0 the tax engine provider's documentation for more information about the code. connectapi.taximpositionresponse tax imposition output representation. property name type description available version name string name of the tax imposition. 55.0 type string type of the tax imposition. 55.0 connectapi.taxjurisdictionresponse represents the address or jurisdiction of the primary business used for calculating tax. property name type description available version country string country of the tax jurisdiction address. 55.0 id string id of the tax jurisdiction address. 55.0 level string level of the tax jurisdiction address. 55.0 name string name of the tax jurisdiction address. 55.0 region string region of the tax jurisdiction address. 55.0 stateassignedno string state-assigned number of the tax jurisdiction address. 55.0 connectapi.lineitemresponse response class that stores information about a list of one or more line items on which the tax engine has calculated tax. 1957apex reference guide connectapi output classes property name type description available version addresses connectapi. the ship from, ship to, and sold to addresses used 55.0 taxaddresses during tax calculation. response amountdetails connectapi. information
about tax amount values on the line item. 55.0 taxamount detailsresponse effectivedate datetime the date that the tax calculation takes effect. 55.0 linenumber string system-generated number used to identify the tax 55.0 line. productcode string product code for the product related to the taxed 55.0 line item. quantity double quantity of the taxed line item. 55.0 taxcode string tax code for the taxed line item. 55.0 taxes list<connectapi. tax details for each line item in a tax line item output. 55.0 taxdetails response> connectapi.taxtransactionresponse tax transaction output representation this class is abstract. superclass of connectapi.calculatetaxresponse property name type description available version addresses connectapi. the ship from, ship to, and sold to addresses used 55.0 taxaddresses during tax calculation. response amountdetails connectapi. information about tax amount values on the line item. 55.0 taxamount detailsresponse currencyisocode string three-letter iso 4217 currency code associated with 55.0 the payment group record. description string information about whether the tax transaction failed 55.0 or was successful. documentcode string document code. 55.0 effectivedate datetime the date that tax is applied to the taxed entity. 55.0 1958apex reference guide connectapi output classes property name type description available version lineitems list<connectapi. a list of line items on which tax was calculated. 55.0 lineitem response> referencedocumentcode string the original document code. used in case of 55.0 subsequent transactions such as credit tax. referenceentityid string id of the reference entity used during tax calculation. 55.0 taxtransactionid string id of the tax transaction. 55.0 transactiondate datetime the date that the tax transaction occurred. 55.0 connectapi.textsegment text segment. subclass of connectapi.messagesegment. no additional properties. connectapi.timezone user's time zone as selected in the user’s personal settings in salesforce. this value doesn’t reflect a device's current location. name type description available version gmtoffset double signed offset, in hours, from gmt. 30.0 name string display name of this time zone. 30.0 see also: connectapi.usersettings connectapi.topic topic. name type description available version createddate datetime iso 8601 date string, for example, 2011-02-25t18:24:31.000z. 29.0 description string description of the topic. 29.0 id string 18-character id. 29.0 images connectapi. images associated with the topic. 32.0 topicimages 1959apex reference guide connectapi output classes name type description available version isbeingdeleted boolean true if the topic is currently being deleted; false otherwise. 33.0 after the topic is deleted, when attempting to retrieve the topic, the output is not_found. name string name of the topic. 29.0 nonlocalized string non-localized name of the topic. 36.0 name talkingabout integer number of people talking about this topic over the last two months, 29.0 based on factors such as topic additions and comments on posts with the topic. url string url to the topic detail page. 29.0 see also: connectapi.managedtopic connectapi.topicpage connectapi.topicendorsement. connectapi.topicendorsementcollection connectapi.topicsuggestion connectapi.topicscapability connectapi.topicendorsement. represents one user endorsing another user for a single topic. name type description available version endorsee connectapi.user user being endorsed. 30.0 summary endorsementid string 18-character id of the endorsement record. 30.0 endorser connectapi.user user performing the endorsement. 30.0 summary topic connectapi.topic topic the user is being endorsed for. 30.0 url string url to the resource for the endorsement record. 30.0 connectapi.topicendorsementcollection collection of topic endorsement response bodies. 1960apex reference guide connectapi output classes name type description available version currentpageurl string connect rest api url identifying the current page. 30.0 nextpageurl string connect rest api url identifying the next page, or null if 30.0 there isn’t a next page. pre
viouspageurl string connect rest api url identifying the previous page, or null 30.0 if there isn’t a previous page. topicendorsements list<connectapi. list of topic endorsements. 30.0 topic> connectapi.topicendorsementsummary topic endorsement summary. subclass of connectapi.useractivitysummary. property name type description available version endorsementid id id of the topic endorsement. 42.0 connectapi.topicimages. images associated with a topic. property name type description available version coverimageurl string url to a topic’s cover image, which appears on the 32.0 topic page. both topics and managed topics can have cover images. featuredimageurl string url to a managed topic’s featured image, which 32.0 appears wherever you feature it, for example, on your experience cloud site home page. see also: connectapi.topic connectapi.topicpage page of topics. name type description available version currentpageurl string connect rest api url identifying the current page. 29.0 1961apex reference guide connectapi output classes name type description available version nextpageurl string connect rest api url identifying the next page, or null 29.0 if there isn’t a next page. topics list<connectapi. list of topics. 29.0 topic> connectapi.topicscapability if a feed element has this capability, the context user can add topics to it. topics help users organize and discover conversations. subclass of connectapi.feedelementcapability. property name type description available version canassigntopics boolean true if a topic can be assigned to the feed element, 32.0 false otherwise. items list<connectapi. a collection of topics associated with this feed 32.0 topic> element. see also: connectapi.feedelementcapabilities connectapi.topicsuggestion topic suggestion. name type description available version existingtopic connectapi.topic topic that already exists or null for a new topic 29.0 name string topic name 29.0 see also: connectapi.topicsuggestionpage connectapi.topicsuggestionpage page of topic suggestions. name type description available version topicsuggestions list<connectapi. list of topic suggestions. 29.0 topicsuggestion> 1962apex reference guide connectapi output classes connectapi.topicsummary summary of a topic. property name type description available version id string id of the topic. 47.0 name string name of the topic. 47.0 see also: connectapi.managedcontentassociations connectapi.trackedchangebundlecapability if a feed element has this capability, it has a group of other feed elements aggregated into one feed element called a bundle. this type of bundle aggregates feed tracked changes. subclass of connectapi.bundlecapability. property name type description available version changes list<connectapi. collection of feed tracked changes. 31.0 trackedchangeitem> connectapi.trackedchangeitem tracked change item. name type description available version fieldname string the name of the field that was updated. 28.0 newvalue string the new value of the field or null if the field length is long. 28.0 oldvalue string the old value of the field or null if the field length is long. 28.0 see also: connectapi.trackedchangescapability connectapi.trackedchangebundlecapability connectapi.trackedchangescapability if a feed element has this capability, it contains all changes to a record for a single tracked change event. subclass of connectapi.feedelementcapability. 1963apex reference guide connectapi output classes property name type description available version changes list<connectapi. collection of feed tracked changes. 32.0 trackedchangeitem> see also: connectapi.feedelementcapabilities connectapi.unauthenticateduser unauthenticated user. subclass of connectapi.actor. no additional properties. instances of this class are used as the actor for feed items and comments posted by chatter customers. connectapi.unreadconversationcount unread count for a conversation. name type description available version hasmore boolean specifies if there are more than 50 unread 29.0 messages (true) or not (false). unreadcount integer the total number of unread messages
. 29.0 connectapi.updownvotecapability if a feed post or comment has this capability, users can upvote or downvote it. subclass of connectapi.feedelementcapability. property name type description available version downvotecount long number of downvotes. 41.0 myvote connectapi. specifies the context user’s vote. values are: 41.0 updownvotevalue • down • none • up 1964apex reference guide connectapi output classes property name type description available version upvotecount long number of upvotes. 41.0 see also: connectapi.commentcapabilities connectapi.feedelementcapabilities connectapi.upvotesummary summary of an upvote. subclass of connectapi.userfeedentityactivitysummary no additional properties. connectapi.user user. this class is abstract. subclass of connectapi.actionwithid. superclass of: • connectapi.userdetail • connectapi.usersummary name type description available version additional string if one exists, an extra label for the user, for example, 30.0 label “customer,” “partner,” or “acme corporation.” communitynickname string user’s nickname in the site. 32.0 companyname string name of the company. 28.0 if your experience cloud site allows access without logging in, the value is null for guest users. displayname string user’s name that is displayed in the site. if nicknames 32.0 are enabled, the nickname is displayed. if nicknames aren’t enabled, the full name is displayed. firstname string user's first name. in version 39.0 and later, if nicknames 28.0 are enabled, firstname is null. ischatterguest boolean true if user is a chatter customer; false otherwise. 28.0 isinthiscommunity boolean true if user is in the same site as the context user; 28.0 false otherwise. lastname string user's last name. in version 39.0 and later, if nicknames 28.0 are enabled, lastname is null. 1965apex reference guide connectapi output classes name type description available version outofoffice connectapi. if one exists, extra out-of-office message for the user. 40.0 outofoffice photo connectapi.photo information about the user's photos. 28.0 reputation connectapi.reputation reputation of the user. 32.0 stamps list<connectapi.stamp> collection of the user’s stamps. 39.0–43.0 in version 44.0 and later, use soql to get a user’s stamps. title string user’s title. 28.0 if your experience cloud site allows access without logging in, the value is null for guest users. usertype connectapi.usertype type of user. 28.0 enum • chatterguest—user is an external user in a private group. • chatteronly—user is a chatter free customer. • guest—user is unauthenticated. • internal—user is a standard org member. • portal—user is an external user in an experience cloud site. • system—user is chatter expert or a system user. • undefined—user is a user type that is a custom object. see also: connectapi.recommendationaudience connectapi.useractivitiesjob user activities job. property name type description available version jobtoken string token that identifies the user activities job. 42.0 jobtype string type of user activities job. value is export or 42.0 purge. 1966apex reference guide connectapi output classes property name type description available version message string message describing the status and expected outcome 42.0 of the job. when the job completes, you receive an email with information about the salesforce file that contains connectapi.useractivitycollection. connectapi.useractivitycollection user activity collection. property name type description available version activitytype string type of user activity. values are: 42.0 • bookmark—user bookmarked a post. • chatteractivity—total counts of posts and comments made and likes and comments received for a user. • chatterlike—user liked a post or comment. • comment—user commented on a post. • companyverify—user verified comment.
• downvote—user downvoted a post or comment. • feedentityread—user read a post. • feedread—user read a feed. • mute—user muted a post. • post—user made a post. • topicendorsement—user endorsed another user on a topic or received endorsement on a topic. • upvote—user upvoted a post or comment. useractivities list<connectapi. collection of user activities. 42.0 useractivity summary> connectapi.useractivitysummary user activity summary. this class is abstract. superclass of: • connectapi.commentsummary 1967apex reference guide connectapi output classes • connectapi.feedpostsummary • connectapi.feedreadsummary • connectapi.topicendorsementsummary • connectapi.userfeedentityactivitysummary property name type description available version activitydate datetime date of the user activity. 42.0 activitytype string type of user activity. values are: 42.0 • bookmark—user bookmarked a post. • chatteractivity—total counts of posts and comments made and likes and comments received for a user. • chatterlike—user liked a post or comment. • comment—user commented on a post. • companyverify—user verified comment. • downvote—user downvoted a post or comment. • feedentityread—user read a post. • feedread—user read a feed. • mute—user muted a post. • post—user made a post. • topicendorsement—user endorsed another user on a topic or received endorsement on a topic. • upvote—user upvoted a post or comment. activityurl string url to the user activity. 42.0 community connectapi. experience cloud site in which the user performed 42.0 communitysummary the activity. see also: connectapi.useractivitycollection connectapi.usercapabilities capabilities associated with a user profile. name type description available version canchat boolean specifies if the context user can use chatter messenger with the 29.0 subject user (true) or not (false) 1968apex reference guide connectapi output classes name type description available version candirectmessage boolean specifies if the context user can direct message the subject user 29.0 (true) or not (false) canedit boolean specifies if the context user can edit the subject user’s account 29.0 (true) or not (false) canfollow boolean specifies if the context user can follow the subject user’s feed (true) 29.0 or not (false) canviewfeed boolean specifies if the context user can view the feed of the subject user 29.0 (true) or not (false) canviewfullprofile boolean specifies if the context user can view the full profile of the subject 29.0 user (true) or only the limited profile (false) ismoderator boolean specifies if the subject user is a chatter moderator or admin (true) 29.0 or not (false) see also: connectapi.userprofile connectapi.userchattersettings user’s global chatter settings. name type description available version defaultgroup connectapi.groupemail the default frequency with which a user receives email 28.0 emailfrequency frequency enum from a group when they join it. connectapi.userdetail details about a user in an org. subclass of connectapi.user. if the context user doesn’t have permission to see a property, its value is set to null. name type description available version aboutme string text from user's profile. 28.0 address connectapi.address user’s address. 28.0 bannerphoto connectapi. user’s banner photo. 36.0 bannerphoto 1969apex reference guide connectapi output classes name type description available version chatteractivity connectapi.chatter chatter activity statistics. 28.0 activity chatterinfluence connectapi.global user’s influence rank. 28.0 influence email string user's email address. 28.0 followerscount integer number of users following this user. 28.0 followingcounts connectapi.following information about items the user is following. 28.0 counts groupcount integer number of groups user is following. 28.0 haschatter boolean true if user has access to chatter
; false otherwise. 31.0 isactive boolean true if user is active; false otherwise. 28.0 managerid string 18-character id of the user’s manager. 28.0 managername string locale-based concatenation of manager's first and last 28.0 names. phonenumbers list<connectapi.phone collection of user's phone numbers. 28.0 number> thanksreceived integer the number of times the user has been thanked. 29.0 username string username of the user, such as 28.0 [email protected]. see also: connectapi.userpage connectapi.userprofile connectapi.userfeedentityactivitysummary user feed entity activity summary. this class is abstract. subclass of connectapi.useractivitysummary superclass of: • connectapi.bookmarksummary • connectapi.chatteractivitysummary • connectapi.companyverifysummary • connectapi.downvotesummary • connectapi.feedentityreadsummary 1970apex reference guide connectapi output classes • connectapi.likesummary • connectapi.mutesummary • connectapi.upvotesummary property name type description available version feedentityid string id of the feed entity. 42.0 connectapi.usergroupdetailpage a page of groups that a user is a member of. property name type description available version currentpageurl string url to the current page. 45.0 groups list<connectapi. collection of groups that the user is a member of. 45.0 chattergroupdetail> nextpageurl string url to the next page, or null if there is no next 45.0 page. previouspageurl string url to the previous page, or null if there is no 45.0 previous page. total integer total number of groups that the user is a member 45.0 of. connectapi.usergrouppage a paginated list of groups the context user is a member of. name type description available version currentpageurl string connect rest api url identifying the current page. 28.0 groups list<connectapi. list of groups. 28.0 chattergroup summary> nextpageurl string connect rest api url identifying the next page, or null 28.0 if there isn’t a next page. previouspageurl string connect rest api url identifying the previous page, or 28.0 null if there isn’t a previous page. total integer total number of groups across all pages. 28.0 1971apex reference guide connectapi output classes connectapi.usermission mission details for a user. subclass of connectapi.abstractusermissionactivity. property name type description available version missionname string name of the mission. 46.0 missionthreshold integer threshold of the mission. when a user reaches this 46.0 activity count, the mission is achieved. connectapi.usermissionactivitiesjob user mission activities job. property name type description available version jobtoken string token that identifies the mission user activities job. 45.0 jobtype string type of user activities job, either export or 45.0 purge. message string message describing the status and expected outcome 45.0 of the job. when the job completes, you receive an email with information about the salesforce file that contains connectapi.usermissionactivitycollection. connectapi.usermissionactivity user activity associated with missions. subclass of connectapi.abstractusermissionactivity. no additional properties. connectapi.usermissionactivitycollection list of mission activities for a user. property name type description available version community connectapi. experience cloud site in which the user performed 45.0 communitysummary activities. userid string id of the user. 45.0 usermission list<connectapi. list of mission activities performed by the user. 45.0 activities abstractuser missionactivity> 1972apex reference guide connectapi output classes property name type description available version username string name of the user. 45.0 see also: connectapi.usermissionactivitiesjob connectapi.usermissionactivitystatus status of mission activity for a user. property name type description available version message string success or error message. 45.0 status string status of mission activity for a user. 45.0 connectapi.useroauthinfo name type description available version availableexternal connect.oauth the available oauth service provider. 37.0 emailservice providerinfo isauthent
icated boolean specifies whether the user is authenticated (true) or not (false). 37.0 connectapi.userpage page of users. name type description available version currentpagetoken integer token identifying the current page. 28.0 currentpageurl string connect rest api url identifying the current page. 28.0 nextpagetoken integer token identifying the next page, or null if there isn’t a next 28.0 page. nextpageurl string connect rest api url identifying the next page, or null if 28.0 there isn’t a next page. previouspagetoken integer token identifying the previous page, or null if there isn’t 28.0 a previous page. previouspageurl string connect rest api url identifying the previous page, or 28.0 null if there isn’t a previous page. 1973apex reference guide connectapi output classes name type description available version users list<connectapi.user list of user detail information. if the context user doesn’t have 28.0 detail> permission to see a property, the property is set to null. connectapi.userprofile details necessary to render a view of a user profile. name type description available version capabilities connectapi.usercapabilities the context user’s capabilities specific to the 29.0 subject user’s profile. id string the id of the user attached to the profile. 29.0 tabs list<connectapi.userprofiletab> the tabs visible to the context user specific to the 29.0 subject user’s profile. url string the url of the user’s profile. 29.0 userdetail connectapi.userdetail the details about the user attached to the profile. 29.0 connectapi.userprofiletab information about a profile tab. name type descriptio available version id string the tab’s unique identifier or 18–character id 29.0 isdefault boolean specifies if the tab appears first when clicking the 29.0 user profile (true) or not (false) tabtype connectapi.userprofile specifies the type of tab 29.0 tabtype enum • customvisualforce—tab that displays data from a visualforce page. • customweb—tab that displays data from any external web-based application or web page. • element—tab that displays generic content inline. • feed—tab that displays the chatter feed. • overview—tab that displays user details. 1974apex reference guide connectapi output classes name type descriptio available version taburl string the current tab’s content url (for non built-in 29.0 tab types) see also: connectapi.userprofile connectapi.userreferencepage a list of user references. property name type description available version currentpageurl string url to the current page. 35.0 nextpageurl string url to the next page. 35.0 previouspageurl string url to the previous page. 35.0 usercount integer number of users in the collection. 35.0 users list<connectapi. a collection of user references. 35.0 reference> see also: connectapi.customlistaudiencecriteria connectapi.usersettings settings specific to a user. property type description available version approvalposts boolean user can approve workflows from chatter posts. 28.0 canaccess boolean user can access personal stream feeds. 40.0 personalstreams canfollow boolean user can follow users and records. 28.0 canmodify boolean user has modify all data permission. 28.0 alldata canowngroups boolean user can own groups. 28.0 canviewalldata boolean user has view all data permission. 28.0 canviewallgroups boolean user has view all groups permission. 28.0 1975apex reference guide connectapi output classes property type description available version canviewallusers boolean user has view all users permission. 28.0 canviewcommunity boolean user can see the site switcher menu. 34.0 switcher canviewfull boolean user can see other user’s chatter profile. 28.0 userprofile canviewpublicfiles boolean user can see all files that are public. 28.0 currencysymbol string currency symbol to use for displaying currency values. applicable only when 28.0 the connectapi.features.multicurrency property is false. externaluser boolean user is a chatter customer. 28.0 filesynclimit integer maximum number of files user can
sync. 32.0 filesync integer maximum storage for synced files, in megabytes (mb). 29.0 storagelimit foldersync integer maximum number of folders user can sync. 32.0 limit hasaccessto boolean user is a member of the internal org. 28.0 internalorg haschatter boolean user has access to chatter. 31.0 hasfilesync boolean user has sync files permission. 28.0 hasfieldservice boolean user has field service gps tracking enabled. 41.0 locationtracking hasfieldservice boolean user has access to the field service mobile app. 41.0 mobileaccess hasfilesync boolean administrator for the user’s org allows file sync clients to update automatically. 34.0 managedclient autoupdate hasrestdata boolean user has access to rest api. 29.0 apiaccess timezone connectapi. the user's time zone as selected in the user’s personal settings in salesforce. 30.0 timezone this value does not reflect a device's current location. userdefault string the iso code for the default currency. applicable only when the 28.0 currencyisocode connectapi.features.multicurrency property is true. userid string 18-character id of the user. 28.0 1976apex reference guide connectapi output classes property type description available version userlocale string locale of user. 28.0 see also: connectapi.organizationsettings connectapi.usersummary user summary. subclass of connectapi.user. name type description available version isactive boolean true if user is active; false otherwise. 28.0 see also: connectapi.chatterconversation connectapi.chatterconversationsummary connectapi.chattergroup connectapi.chatterlike connectapi.dashboardcomponentsnapshot connectapi.directmessagememberpage connectapi.groupmembershiprequest connectapi.groupmember connectapi.feedfavorite connectapi.origincapability connectapi.platformaction connectapi.directmessagememberpage connectapi.directmessagememberactivity connectapi.chattermessage connectapi.comment connectapi.file connectapi.mentionsegment connectapi.questionandanswerscapability connectapi.socialpostcapability connectapi.topicendorsement. 1977apex reference guide connectapi output classes connectapi.verifiedcapability if a comment has this capability, users with permission can mark it as verified or unverified. subclass of connectapi.feedelementcapability. property name type description available version isverifiablebyme boolean specifies whether the context user has permission 41.0 to mark comments as verified or unverified (true) or not (false). isverified boolean specifies whether the comment is marked as verified 41.0 (true) or not (false). isverifiedby boolean specifies whether the comment is marked as verified 43.0 anonymized by an anonymous user (true) or not (false).if the comment has never been marked as verified or unverified, null.also null if the context user doesn’t have permission to mark comments as verified or unverified. lastverifiedbyuser connectapi.user user who last marked the comment as verified or 41.0 summary unverified, otherwise null. also null if the context user doesn’t have permission to mark comments as verified or unverified. lastverifieddate datetime date when the comment was last marked as verified 41.0 or unverified, otherwise null. also null if the context user doesn’t have permission to mark comments as verified or unverified. see also: connectapi.commentcapabilities connectapi.vote an upvote or downvote on a feed element or comment. property name type description available version type connectapi. type of vote for a feed element or comment. 42.0 updownvotevalue • down • up user connectapi. user who voted on the feed element or comment. 42.0 usersummary 1978apex reference guide connectapi output classes property name type description available version voteditem connectapi. reference to the feed element or comment that was 42.0 reference voted on. see also: connectapi.votepage connectapi.votepage a page of upvotes or downvotes on a feed element or comment. property name type description available version currentpagetoken integer
token identifying the current page. 42.0 currentpageurl string connect rest api url identifying the current page. 42.0 items list<connectapi. collection of users and their upvotes or downvotes. 42.0 vote> upvotes include likes and upvotes. for example, if a post receives five likes and three upvotes, the number of upvotes is eight. for this reason, the collection of users and their upvotes also includes users who liked the post or comment. if a user both liked and upvoted a post, they appear only once in the collection. nextpagetoken integer token identifying the next page, or null if there 42.0 isn’t a next page. nextpageurl string connect rest api url identifying the next page, or 42.0 null if there isn’t a next page. previouspagetoken integer token identifying the previous page, or null if 42.0 there isn’t a previous page. previouspageurl string connect rest api url identifying the previous page, 42.0 or null if there isn’t a previous page. total long total number of upvotes or downvotes for the feed 42.0 element or comment. the number of upvotes includes the number of likes and upvotes. for example, if a post receives five likes and three upvotes, the total number of upvotes is eight. if a user both liked and upvoted a post, we count that as two upvotes. connectapi.wishlist wishlist, including summary and items. 1979apex reference guide connectapi output classes property name type description available version page connectapi. page of wishlist items. 49.0 wishlistitem collection summary connectapi. summary of the wishlist. 49.0 wishlistsummary see also: connectapi.wishlistssummary connectapi.wishlistitem item in a wishlist. property name type description available version currencyisocode string three-letter iso 4217 currency code associated with 49.0 the product. error connectapi. error information. 49.0 errorresponse listprice double list price of the wishlist item. 49.0 productsummary connectapi. product summary for the wishlist item. 49.0 cartitemproduct salesprice double sales price of the wishlist item. 49.0 wishlistitemid string id of the wishlist item. 49.0 see also: connectapi.wishlistitemcollection connectapi.wishlistitemcollection collection of wishlist items. property name type description available version currencyisocode string three-letter iso 4217 currency code associated with 49.0 the product. currentpagetoken string token identifying the current page. 49.0 currentpageurl string connect rest api url identifying the current page. 49.0 haserrors boolean specifies whether at least one of the results contains 49.0 an error (true) or not (false). 1980apex reference guide connectapi output classes property name type description available version items list<connectapi. collection of wishlist items. 49.0 wishlistitem> nextpagetoken string token identifying the next page, or null if there 49.0 isn’t a next page. nextpageurl string connect rest api url identifying the next page, or 49.0 null if there isn’t a next page. previouspagetoken string token identifying the previous page, or null if 49.0 there isn’t a previous page. previouspageurl string connect rest api url identifying the previous page, 49.0 or null if there isn’t a previous page. see also: connectapi.wishlist connectapi.wishlistssummary list of wishlist summaries and the displayed list for the context user. property name type description available version displayedlist connectapi. oldest wishlist displayed for the context user. 49.0 wishlist summaries list<connectapi. summary of wishlists belonging to the context user. 49.0 wishlistsummary> wishlistcount integer total number of wishlists belonging to the context 49.0 user. connectapi.wishlistsummary summary of a wishlist. property name type description available version createddate datetime created date for the wishlist in iso 8601 format, for 49.0 example, 2011-02-25t18:24:31.000z. id string id of the wishlist. 49.0
modifieddate datetime last modified date of the wishlist in iso 8601 format, 49.0 for example, 2011-02-25t18:24:31.000z. name string name of the wishlist. 49.0 1981apex reference guide connectapi output classes property name type description available version wishlistproductcount integer unique product count in the wishlist. 49.0 see also: connectapi.wishlist connectapi.wishlistssummary connectapi.wishlisttocartresult result of adding a wishlist to a cart. property name type description available version cartid string id of the cart to which the products were added. 49.0 failedwishlist list<connectapi. wishlist items that weren’t successfully added to the 49.0 tocartitems cartitemresult> cart. productsfailed integer total number of products that weren’t added to the 49.0 count cart. productsrequested integer total number of products requested to add to the 49.0 count cart. productssucceeded integer total number of products that were successfully 49.0 count added to the cart. succeededwishlist list<connectapi. wishlist items that were successfully added to the 49.0 tocartitems cartitemresult> cart. connectapi.zone information about a chatter answers zone. name type description available version description string the description of the zone. 29.0 id string the zone id. 29.0 isactive boolean indicates whether or not the zone is active. 29.0 ischatteranswers boolean indicates whether or not the zone is available for 29.0 chatter answers. name string name of the zone. 29.0 url string the url of the zone. 30.0 1982
apex reference guide connectapi output classes name type description available version visibility connectapi.zoneshowin zone visibility type. 29.0 • community—available in an experience cloud site. • internal—available internally only. • portal—available in a portal. visibilityid string if the zone is available in a site, this property 29.0 contains the id of the site. if the zone is available to all sites, this property contains the value all. see also: connectapi.zonepage connectapi.zonepage page of zones. name type description available version zones list<connectapi.zone> a list of one or more zones. 29.0 currentpageurl string connect rest api url identifying the current 29.0 page. nextpageurl string connect rest api url identifying the next page, 29.0 or null if there isn’t a next page. connectapi.zonesearchpage page of zone search results. name type description available version currentpagetoken string token identifying the current page. 29.0 currentpageurl string connect rest api url identifying the current 29.0 page. items list<connectapi.zonesearchresult> list of search results. 29.0 nextpagetoken string token identifying the next page, or null if there 29.0 isn’t a next page. nextpageurl string connect rest api url identifying the next page, 29.0 or null if there isn’t a next page. 1983apex reference guide connectapi output classes connectapi.zonesearchresult information about a specific zone search result. name type description available version hasbestanswer boolean indicates if the search result has a best answer. 29.0 id string id of the search result. the search result can be a 29.0 question or an article. title string title of the search result. 29.0 type connectapi.zonesearch specifies the zone search result type. 29.0 resulttype enum • article—search results contain only articles. • question—search results contain only questions. votecount string number of votes given to the search result. 29.0 see also: connectapi.zonesearchpage retired connectapi output classes these connectapi output classes are retired. in this section: connectapi.approvalattachment attach an approval to a feed item. connectapi.basictemplateattachment attachments in feed items with type basictemplate. connectapi.canvastemplateattachment attachments in feed items with type canvaspost. connectapi.casecomment attachments in feed items with type casecommentpost. connectapi.contentattachment attachments in feed items with the type contentpost. connectapi.dashboardcomponentattachment attachments in feed items with type dashboardsnapshot. connectapi.datacloudcompany information about a data.com company. 1984apex reference guide connectapi output classes connectapi.datacloudcompanies lists all companies that were purchased in a specific order, page urls, and the number of companies in the order. connectapi.datacloudcontact information about a data.com contact. connectapi.datacloudcontacts lists all contacts that were purchased in the specific order, page urls, and the number of contacts in the order. connectapi.datacloudorder represents a datacloud order. connectapi.datacloudpurchaseusage information about data.com point usage for monthly and list pool users. connectapi.emailmessage email message from a case. connectapi.feeditemattachment feed item attachment. connectapi.feeditempage a paged collection of connectapi.feeditem objects. connectapi.feeditemtopicpage feed item topic page. connectapi.feedpoll attachment of connectapi.feeditem objects where the type property is pollpost. connectapi.linkattachment link attached to a feed item. connectapi.nonentityrecommendation a recommendation for a non-salesforce entity, such as an application. connectapi.recordsnapshotattachment fields of a record at the point in time when the record was created. connectapi.trackedchangeattachment tracked change attachment to a feed item. connectapi.approvalattachment attach an approval to a feed item. important: this class isn’t available in version 32.0 and
later. in version 32.0 and later, connectapi.approvalcapability is used. subclass of connectapi.feeditemattachment name type description available version id string a work item id. 28.0–31.0 posttemplatefields list collection of approval post template fields 28.0–31.0 <connectapi. approvalpost templatefield> 1985apex reference guide connectapi output classes name type description available version process string an approval step id. 30.0–31.0 instancestepid status connectapi. status of a workflow process. 28.0–31.0 workflowprocess • approved status enum • fault • held • noresponse • pending • reassigned • rejected • removed • started connectapi.basictemplateattachment attachments in feed items with type basictemplate. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.enhancedlinkcapability is used. subclass of connectapi.feeditemattachment property type description available version description string an optional description with a 500 character limit. 28.0–31.0 icon connectapi.icon an optional icon. 28.0–31.0 linkrecordid string if linkurl refers to a salesforce record, linkrecordid 28.0–31.0 contains the id of the record. linkurl string an optional url to a detail page if there is more content that 28.0–31.0 can’t be displayed inline. do not specify linkurl unless you specify a title. title string an optional title to the detail page. if linkurl is specified, the 28.0–31.0 title links to linkurl. connectapi.canvastemplateattachment attachments in feed items with type canvaspost. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.canvascapability is used. subclass of connectapi.feeditemattachment 1986apex reference guide connectapi output classes property type description available version description string optional. description of the canvas app. the maximum length of this 29.0–31.0 field is 500 characters. developername string specifies the developer name (api name) of the canvas app. 29.0–31.0 height string optional. the height of the canvas app in pixels. default height is 200 29.0–31.0 pixels. icon connectapi.icon the canvas app icon. 29.0–31.0 namespaceprefix string optional. the namespace prefix of the developer edition organization 29.0–31.0 in which the canvas app was created. parameters string optional. parameters passed to the canvas app in json format. example: 29.0–31.0 {'isupdated'='true'} thumbnailurl string optional. a url to a thumbnail image for the canvas app. maximum 29.0–31.0 dimensions are 120x120 pixels. title string specifies the title of the link used to call the canvas app. 29.0–31.0 connectapi.casecomment attachments in feed items with type casecommentpost. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.casecommentcapability is used. subclass of connectapi.feeditemattachment name type description available version actortype connectapi. type of user who made the comment. 28.0–31.0 caseactortype • customer—if a chatter customer made the comment enum • customerservice—if a service representative made the comment createdby connectapi. comment’s creator 28.0–31.0 user summary createddate datetime iso 8601 date string, for example, 2011-02-25t18:24:31.000z 28.0–31.0 id string comment’s 18–character id 28.0–31.0 published boolean specifies whether the comment has been published 28.0–31.0 text string comment’s text 28.0–31.0 1987apex reference guide connectapi output classes connectapi.contentattachment attachments in feed items with the type contentpost. important: this class isn’t available in version 32.0 and later. in version 32.
0 and later, connectapi.contentcapability is used. subclass of connectapi.feeditemattachment name type description available version checksum string md5 checksum for the file. 28.0–31.0 contenturl string url for link files and google docs; otherwise the value is null. 31.0–31.0 description string description of the attachment. 28.0–31.0 downloadurl string file’s url. this value is null if the content is a link or a google doc. 28.0–31.0 fileextension string file’s extension. 28.0–31.0 filesize string size of the file in bytes. if size cannot be determined, returns 28.0–31.0 unknown. filetype string type of file. 28.0–31.0 hasimagepreview boolean true if the file has a preview image available, otherwise ,false. 28.0–29.0 haspdfpreview boolean true if the file has a pdf preview available, otherwise, false. 28.0–31.0 id string content’s 18-character id. 28.0–31.0 isinmyfilesync boolean true if the file is synced with salesforce files sync; false otherwise. 28.0–31.0 note: salesforce files sync was retired on may 25, 2018. mimetype string file’s mime type. 28.0–31.0 renditionurl string url to the file’s rendition resource. 28.0–31.0 renditionurl string url to the 240 x 180 rendition resource for the file.for shared files, 30.0–31.0 240by180 renditions process asynchronously after upload. for private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. renditionurl string url to the 720 x 480 rendition resource for the file.for shared files, 30.0–31.0 720by480 renditions process asynchronously after upload. for private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. textpreview string text preview of the file if available; null otherwise. 30.0–31.0 thumb120by90 string specifies the rendering status of the 120 x 90 preview image of the 30.0–31.0 renditionstatus file. one of these values: • processing—image is being rendered. • failed—rendering process failed. • success—rendering process was successful. 1988apex reference guide connectapi output classes name type description available version • na—rendering is not available for this image. thumb240by180 string specifies the rendering status of the 240 x 180 preview image of the 30.0–31.0 renditionstatus file. one of these values: • processing—image is being rendered. • failed—rendering process failed. • success—rendering process was successful. • na—rendering is not available for this image. thumb720by480 string specifies the rendering status of the 720 x 480 preview image of the 30.0–31.0 renditionstatus file. one of these values: • processing—image is being rendered. • failed—rendering process failed. • success—rendering process was successful. • na—rendering is not available for this image. title string title of the file. 28.0–31.0 versionid string 18-character id for this version of the content. 28.0–31.0 connectapi.dashboardcomponentattachment attachments in feed items with type dashboardsnapshot. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.dashboardcomponent snapshotcapability is used. subclass of connectapi.feeditemattachment name type description available version componentid string component’s 18–character id. 28.0–31.0 componentname string name of the component. if no name is saved with the component, 28.0–31.0 returns the localized string, “untitled component.”. dashboardbodytext string text displayed next to the actor in the body of a feed item. this is used 28.0–31.0 instead of the default body text. if no text is specified, and there is no default body text, returns null. dashboardid string dashboard’s
18–character id. 28.0–31.0 dashboardname string name of the dashboard. 28.0–31.0 fullsizeimageurl string url of the full-sized dashboard image. 28.0–31.0 lastrefreshdate datetime iso8601 date string, for example, 2011-02-25t18:24:31.000z, 28.0–31.0 specifying when this dashboard was last refreshed. 1989apex reference guide connectapi output classes name type description available version lastrefreshdate string the text of the last refresh date to be displayed, such as, “last refreshed 28.0–31.0 displaytext on october 31, 2011.” runninguser connectapi. the user running the dashboard. 28.0–31.0 user summary thumbnailurl string url of the thumbnail-sized dashboard image. 28.0–31.0 connectapi.datacloudcompany information about a data.com company. all company information is visible for companies that you purchased and own. if you haven’t purchased a company, some of the fields are hidden. hidden fields are fully or partially hidden by asterisks “***.” property name type description available version activecontacts integer the number of active data.com contacts who 32.0 work in the company. address connectapi.address the postal address for the company. this is 32.0 typically a physical address that can include the city, state, street, and postal code. annualrevenue double the amount of money that the company makes 32.0 in one year. annual revenue is measured in us dollars. companyid string a unique numerical identifier for the company. 32.0 this is the data.com identifier for a company. description string a brief synopsis of the company that provides 32.0 a general overview of the company and what it does. dunsnumber string a randomly generated nine-digit number that’s 32.0 assigned by dun & bradstreet (d&b) to identify unique business establishments. industry string a description of the type of industry such as 32.0 “telecommunications,” “agriculture,” or “electronics.” isinactive boolean indicates whether this company is active (true) 32.0 or not (false). inactive companies have out-of-date information in data.com. isowned boolean 32.0 • true: you or your organization owns this company. 1990apex reference guide connectapi output classes property name type description available version • false: neither you nor your organization owns this company. naicscode string north american industry classification system 32.0 (naics) codes were created to provide more details about a business’s service orientation. the code descriptions are focused on what a business does. naicsdescription string a description of the naics classification. 32.0 name string the name of the company. 32.0 numberof integer the number of employees who are working for 32.0 employees the company. ownership string 32.0 the type of ownership of the company: • public • private • government • other phonenumbers connectapi.phonenumber 32.0 the list of telephone numbers for the company, including the type. here are some possible types of telephone numbers. • mobile • work • fax sic string standard industrial codes (sic) is a numbering 32.0 convention that indicates what type of service a business provides. it’s a four-digit value. sicdescription string a description of the sic classification. 32.0 site string company’s site. for example, hq, single 32.0 location, or branch. an organization status of the company. • branch: a secondary location to a headquarter location. • headquarter: the parent company has branches or subsidiaries. • single location: a single business with no subsidiaries or branches. 1991apex reference guide connectapi output classes property name type description available version tickersymbol string the symbol that uniquely identifies companies 32.0 that are traded on public stock exchanges. tradestyle string a legal name under which a company conducts 32.0 business. updateddate datetime the date of the most recent change to this 32.0 company’s information. website string the standard url for the company’s home page. 32.0 yearstarted string the year when the company was founded. 32.0
connectapi.datacloudcompanies lists all companies that were purchased in a specific order, page urls, and the number of companies in the order. property name type description available version companies connectapi.datacloudcompany a detailed list of companies that were 32.0 part of a single order. currentpageurl string the url for the current page of a list of 32.0 companies. nextpageurl string connect rest api url identifying the 32.0 next page, or null if there isn’t a next page. previouspageurl string the url to the previous page of 32.0 companies that were viewed before the current page. if this value is null, there’s no previous page. total integer the number of companies in the order. 32.0 you can calculate the number of pages to display by dividing this number by your page size. the default page size is 25. connectapi.datacloudcontact information about a data.com contact. all contact information is visible for contacts that you purchased. if you have not purchased a contact, some of the fields will be hidden. hidden fields are fully or partially hidden by asterisks “***.” property name type description available version address connectapi.address the contact’s business address. 32.0 1992apex reference guide connectapi output classes property name type description available version companyid string a unique numerical identifier for the company where 32.0 the contact works. this is the data.com identifier for a company. companyname string the company name where the contact works. 32.0 contactid string a unique numerical identifier for the contact. this is 32.0 the data.com identifier for a contact. department string the department in the company where the contact 32.0 works. here are some possible departments. • engineering • it • marketing • sales email string the most current business email address for the 32.0 contact. firstname string the first name of the contact. 32.0 isinactive boolean whether this contact is active (true) or not (false). 32.0 inactive contacts have out-of-date information in data.com. isowned boolean whether this contact is owned (true) or not (false). 32.0 lastname string the last name of the contact. 32.0 level string a human resource label that designates a person’s 32.0 level in the company. here are some possible levels. • c-level • director • manager • staff phonenumbers connectapi.phonenumber telephone numbers for the contact, which can 32.0 include direct-dial business telephone numbers, mobile telephone numbers, and business headquarters telephone numbers. the type of telephone number is also indicated. title string the title of the contact, such as ceo or vice president. 32.0 updateddate datetime the date of the most recent change to this contact’s 32.0 information. see also: connectapi.datacloudcontacts 1993apex reference guide connectapi output classes connectapi.datacloudcontacts lists all contacts that were purchased in the specific order, page urls, and the number of contacts in the order. property name type description available version contacts a detailed list of purchased contacts. 32.0 list<connectapi. datacloudcontact> currentpageurl string url to the current page of contacts. 32.0 nextpageurl string connect rest api url identifying the next page, or 32.0 null if there isn’t a next page. previouspageurl string url to the previous page of contacts. this value is 32.0 null if there is no previous page. total integer number of contacts that are associated with this 32.0 order. can be greater than the number of contacts that are shown on a single page. connectapi.datacloudorder represents a datacloud order. property name type description available version entityurl string url to a list of contacts or companies that were 32.0 purchased with this order. id string unique number that’s used to track your order 32.0 information. purchasecount integer number of contacts or companies that were 32.0 purchased for this order. purchasedate datetime purchase date for this order. 32.0 url string get request url for this order. 32.0 connectapi.datacloudpurchaseusage information about data.com point usage for monthly and list pool users. property name type description available version
listpoolcreditsavailable integer the points or credits that are available in a 32.0 pool of credits for your organization. this pool of credits can be used by any list pool user in your organization. 1994apex reference guide connectapi output classes property name type description available version listpoolcreditsused integer the points or credits that have been used 32.0 from a pool of credits that are used by list pool users to purchase records. monthlycreditsavailable integer the total credits that are assigned to a 32.0 monthly user. unused credits expire at the end of each month. monthlycreditsused integer the credits that are used by a monthly user 32.0 for the current month. connectapi.emailmessage email message from a case. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.emailmessagecapability is used. subclass of connectapi.feeditemattachment name type description available version direction connectapi.email the direction of the email message. 29.0–31.0 messagedirection • inbound—an inbound message (sent by a customer). enum • outbound—an outbound message (sent to a customer by a support agent). emailmessageid string the id of the email message. 29.0–31.0 subject string the subject of the email message. 29.0–31.0 textbody string the body of the email message. 29.0–31.0 toaddresses list<connectapi.emailaddress> a list of email addresses to send the message to. 29.0–31.0 connectapi.feeditemattachment feed item attachment. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.feedelementcapability is used. this class is abstract. subclasses: • connectapi.approvalattachment • connectapi.basictemplateattachment • connectapi.canvastemplateattachment • connectapi.emailmessage • connectapi.casecomment 1995apex reference guide connectapi output classes • connectapi.contentattachment • connectapi.dashboardcomponentattachment • connectapi.feedpoll • connectapi.linkattachment • connectapi.recordsnapshotattachment • connectapi.trackedchangeattachment message segments in a feed item are typed as connectapi.messagesegment. feed item capabilities are typed as connectapi.feeditemcapability. record fields are typed as connectapi.abstractrecordfield. these classes are all abstract and have several concrete subclasses. at runtime you can use instanceof to check the concrete types of these objects and then safely proceed with the corresponding downcast. when you downcast, you must have a default case that handles unknown subclasses. important: the composition of a feed can change between releases. write your code to handle instances of unknown subclasses. connectapi.feeditempage a paged collection of connectapi.feeditem objects. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.feedelementpage is used. name type description available version currentpagetoken string token identifying the current page. 28.0–31.0 currentpageurl string connect rest api url identifying the current page. 28.0–31.0 ismodifiedtoken string opaque polling token to use in the since parameter of the 28.0–31.0 chatterfeeds.ismodified method. the token describes when the feed was last modified. important: this feature is available through a feed polling pilot program. this pilot program is closed and not accepting new participants. ismodifiedurl string connect rest api url with a since request parameter 28.0–31.0 that contains an opaque token that describes when the feed was last modified. returns null if the feed isn’t a news feed. use this url to poll a news feed for updates. important: this feature is available through a feed polling pilot program. this pilot program is closed and not accepting new participants. items list<connectapi.feeditem> list of feed items 28.0–31.0 nextpagetoken string token identifying the next page, or null if there isn’t a next 28.0–31.0 page. nextpageurl string connect rest api url identifying the next page, or null
28.0–31.0 if there isn’t a next page. 1996apex reference guide connectapi output classes name type description available version updatestoken string token to use in an updatedsince parameter, or null 30.0–31.0 if not available. updatesurl string a connect rest api resource with a query string containing 30.0–31.0 the value of the updatestoken property. the resource returns the feed items that have been updated since the last request. use the url as it is—do not modify it. property is null if not available. connectapi.feeditemtopicpage feed item topic page. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.topicscapability is used. name type description available version canassigntopics boolean true if a topic can be assigned to the feed item, false 28.0–31.0 otherwise. topics list<connectapi. list of topics. 28.0–31.0 topic> connectapi.feedpoll attachment of connectapi.feeditem objects where the type property is pollpost. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.pollcapability is used. subclass of connectapi.feeditemattachment. name type description available version choices list<connectapi. list of choices for poll. 28.0–31.0 feedpoll choice> mychoiceid string id of the poll choice that the context user has voted for in this poll. 28.0–31.0 returns null if the context user hasn’t voted. totalvotecount integer total number of votes cast on the feed poll item. 28.0–31.0 connectapi.linkattachment link attached to a feed item. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.linkcapability is used. 1997apex reference guide connectapi output classes subclass of connectapi.feeditemattachment. name type description available version title string title given to the link if available, otherwise, null. 28.0–31.0 url string the link url. 28.0–31.0 connectapi.nonentityrecommendation a recommendation for a non-salesforce entity, such as an application. subclass of connectapi.abstractrecommendation. important: connectapi.nonentityrecommendation isn’t used in version 34.0 and later. in version 34.0 and later, connectapi.entityrecommendation is used for all recommendations. property name type description available version displaylabel string localized label of the non-entity object. 32.0 motif connectapi.motif motif for the non-entity object. 32.0 connectapi.recordsnapshotattachment fields of a record at the point in time when the record was created. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.recordsnapshotcapability is used. subclass of connectapi.feeditemattachment. name type description available version recordview connectapi. the representation of the record. 29.0–31.0 recordview connectapi.trackedchangeattachment tracked change attachment to a feed item. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, connectapi.trackedchangescapability is used. name type description available version changes list<connectapi. a list of tracked changes. 28.0–31.0 trackedchangeitem> 1998apex reference guide connectapi enums connectapi enums enums specific to the connectapi namespace. connectapi enums inherit all properties and methods of apex enums. enums are not versioned. enum values are returned in all api versions. clients should handle values they don't understand gracefully. enum description connectapi.actionlink number of times an action link can be executed. executionsallowed • once—an action link can be executed only once across all users. • onceperuser—an action link can be executed only once for each user. • unlimited—an action link can be executed an unlimited number of times by each user.
if the action link’s actiontype is api or apiasync, you can’t use this value. connectapi. type of action link. actionlinktype • api—the action link calls a synchronous api at the action url. salesforce sets the status to successfulstatus or failedstatus based on the http status code returned by your server. • apiasync—the action link calls an asynchronous api at the action url. the action remains in a pendingstatus state until a third party makes a request to /connect/action-links/actionlinkid to set the status to successfulstatus or failedstatus when the asynchronous operation is complete. • download—the action link downloads a file from the action url. • ui—the action link takes the user to a web page at the action url. connectapi. type of sharing operation. activitysharingtypeenum • everyone—the activity is shared with everyone. • mygroups—the activity is shared only with a selection of the context user’s groups. • onlyme—the activity is private. connectapi. scope of the price adjustment amount. adjustmentamountscope • total—the adjustment scope is the total price. • unit—the adjustment scope is the unit price. • unproratedtotal—the adjustment scope is the unprorated total price. connectapi. how the price adjustment amount is calculated. adjustmenttype • adjustmentamount—the adjustment is a fixed amount. • adjustmentpercentage—the adjustment is a percentage. connectapi. type of operation to perform on articles and topics. articletopicjobtype • assigntopicstoarticle—assign topics to articles in a data category. • unassigntopicsfromarticle—unassign topics from articles in a data category. 1999apex reference guide connectapi enums enum description connectapi. operator used in the personalization audience criterion. audiencecriteriaoperator • contains • equal • greaterthan • greaterthanorequal • includes • lessthan • lessthanorequal • notequal • notincludes • startswith connectapi. type of personalization audience criterion. audiencecriteriatype • audience—criterion based on audience. • default—audience has no criteria. • domain—criterion based on domain. • fieldbased—criterion based on object fields. • geolocation—criterion based on location. • permission—criterion based on standard or custom permissions. • profile—criterion based on profile. connectapi.bannerstyle decorates a feed item with a color and set of icons. • announcement—an announcement displays in a designated location in the salesforce ui until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement. connectapi.botversion activation status of the bot version. activationstatus • active • inactive connectapi.bundletype type of bundle. • genericbundle—a bundle that contains no additional information and is just a collection of feed elements. • trackedchanges—a bundle that represents a collection of feed tracked changes. the bundle includes summary information about the feed tracked changes that make up the bundle. connectapi. definition type of the calculated insight. calculatedinsight • calculatedmetric definitiontypeenum • externalmetric • streamingmetric 2000apex reference guide connectapi enums enum description connectapi. type of tax calculation. calculatetaxtype • actual—calculated tax represents the final taxed amount for the transaction. • estimated—calculated tax represents only an estimated value before the transaction is finalized. connectapi.cardcategory indicates a credit card or debit card. • creditcard • debitcard connectapi.cardtype credit card issuer. • americanexpress • dinersclub • jcb • maestro • mastercard • visa connectapi. sort order for items in a cart. cartitemsortorder • createddateasc—sorts by oldest creation date. • createddatedesc—sorts by most recent creation date. • nameasc—sorts by name in ascending alphabetical order (a–z). • namedesc—sorts by name in descending alphabetical order (z–a). • salespriceasc—sorts from lowest to highest negotiated price. • salespricedesc
—sorts from highest to lowest negotiated price. connectapi.cartitemtype type of item in a cart. • deliverycharge • product connectapi. severity of cart message. cartmessageseverity • error • info • warning connectapi. level of the promotion target. cartpromotiontype • cart—the target is cart-level. • item—the target is item-level. connectapi.cartstatus status of the cart. • active—cart is active. • checkout—cart is in checkout. 2001apex reference guide connectapi enums enum description • closed—cart is closed. • pendingdelete—cart is pending delete, for example, a user deleted the cart but the job hasn’t completed yet. • processing—cart is processing. connectapi.carttaxtype tax type of the cart. • gross—gross taxation policy. • net—net taxation policy. connectapi.carttype type of cart. • cart connectapi. type of user who made the comment. caseactortype • customer—if a chatter customer made the comment • customerservice—if a service representative made the comment connectapi.casecomment event type of a comment in case feed. eventtype • newinternal—a case comment that has newly been marked internal only. • newpublished—a newly published case comment. • newpublishedbycustomer—a case comment by a customer that was newly published. • publishexisting—an existing case comment that was republished. • publishexistingbycustomer—an existing case comment by a customer that was republished. • unpublishexistingbycustomer—an existing case comment by a customer that was unpublished. • unpublishexsiting—an existing case comment that was unpublished. note: unfortunately, this typo is in the code, not the documentation. use this spelling in your code. connectapi. source object for an identity resolution ruleset. cdpidentityresolution • account configurationtype • individual connectapi. match method for a match rule criterion. cdpidentityresolution • exact—exact match. matchmethodtype • exactnormalized—exact normalized match. • fuzzy—fuzzy match with medium precision. • fuzzyhigh—fuzzy match with high precision. • fuzzylow—fuzzy match with low precision. 2002apex reference guide connectapi enums enum description connectapi. default reconciliation rule applied to fields in the object the reconciliation rule applies to. cdpidentityresolution • lastupdated reconciliationruletype • mostfrequent • sourcesequence connectapi. result of an identity resolution ruleset job run. cdpidentityresolution • exceededmaximumnumberofsuccessfulrunsallowedin24hours runnowresultcode • identityresolutionjobisalreadyrunning • nopendingchangesjobrunskipped • successfullysubmittedidentityresolutionjobrunrequest connectapi.commenttype type of comment. • contentcomment—comment holds a content capability. • textcomment—comment contains only text. connectapi. sort order for commerce addresses. commerceaddresssort • createddateasc—sort in ascending order of created date. • createddatedesc—sort in descending order of created date. • nameasc—sort in ascending order of name. • namedesc—sort in descending order of name. connectapi. search attribute type. commercesearch • custom attributetype • productattribute • productcategory • standard connectapi. display type of the facet. commercesearchfacet • categorytree displaytype • datepicker • multiselect • singleselect connectapi. search facet type. commercesearchfacettype • distinctvalue connectapi. grouping option for search results. commercesearch • nogrouping—search results aren’t grouped. groupingoption • variationparent—search results are grouped by the variation parent. 2003apex reference guide connectapi enums enum description connectapi. build type of the index. commercesearch • full indexbuildtype • incremental connectapi. creation type of the index. commercesearch • manual indexcreationtype • scheduled connectapi. status of the index. commercesearch • completed indexstatus • failed • inprogress
connectapi. usage of the index. commercesearch • live indexusage • outofuse connectapi. direction of the sort rule. commercesearch • ascending—sorts in ascending alphanumeric order (a–z, 0–9). sortruledirection • default—when no direction is defined, sorts by relevance. • descending—sorts in descending alphanumeric order (z–a, 9–0). connectapi. label suffix of the sort rule. commercesearchsortrule • ascen—label suffix for 'asc' labelsuffix • ascending—label suffix for 'ascending' • az—label suffix for 'a-z' • descen—label suffix for 'desc' • descending—label suffix for 'descending' • fewmany—label suffix for 'few-many' • heavylight—label suffix for 'heavy-light' • highlow—label suffix for 'high-low' • highestlowest—label suffix for 'highest-lowest' • lightheavy—label suffix for 'light-heavy' • lowhigh—label suffix for 'low-high' • lowesthighest—label suffix for 'lowest-highest' • manyfew—label suffix for 'many-few' • newold—label suffix for 'new-old' • newest—label suffix for 'newest' • newestoldest—label suffix for 'newest-oldest' • ninezero—label suffix for '9-0' 2004apex reference guide connectapi enums enum description • oldnew—label suffix for 'old-new' • oldest—label suffix for 'oldest' • oldestnewest—label suffix for 'oldest-newest' • pricedecreasing—label suffix for '$$-$' • priceincreasing—label suffix for '$-$$' • thickthin—label suffix for 'thick-thin' • thinthick—label suffix for 'thin-thick' • za—label suffix for 'z-a' • zeronine—label suffix for '0-9' connectapi. type of sort rule. commercesearch • productattributebased—sorts by product attribute fields. sortruletype • productbased—sorts by product field data. • relevancy—sorts by product and catalog term frequency. • sortbypricebook—sorts by product prices defined in the specified pricebook (version 55.0 and later). connectapi. type of the top product to return for each product group in search results. commercesearchtop • variationparent producttype connectapi.communityflag reason a post, comment, or file is flagged. reasontype • flaggedbyrule—moderation rule flagged the item. • flaggedbysystem—einstein flagged the item. • flaggedbyuserasinappropriate—user flagged the item as inappropriate. • flaggedbyuserasspam—user flagged the item as spam. connectapi. type of moderation flag. communityflagtype • flagasinappropriate—flag for inappropriate content. • flagasspam—flag for spam. connectapi. visibility behavior of a flag for various user types. communityflagvisibility • moderatorsonly—the flag is visible only to users with moderation permissions on the flagged element or item. • selfandmoderators—the flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item. connectapi. status of the experience cloud site. communitystatus • live • inactive • underconstruction 2005apex reference guide connectapi enums enum description connectapi.activitytype type of activity. • all • event • task connectapi.contenthub authentication protocol used for the repository. authenticationprotocol • noauthentication—repository doesn’t require authentication. • oauth—repository uses oauth authentication protocol. • password—repository uses user name and password authentication protocol. connectapi.contenthub type of directory entry. directoryentrytype • groupentry • userentry connectapi.contenthub sharing status for the external file. externalitemsharingtype • domainsharing—file is shared with the domain. • privatesharing—file is private or shared only with individuals. • publicsharing—file is publicly shared. connectapi.contenthub type of group. group
type • everybody—group is public to everybody. • everybodyindomain—group is public to everybody in the same domain. • unknown—group type is unknown. connectapi.contenthub item types. itemtype • any—includes files and folders. • filesonly—includes files only. • foldersonly—includes folders only. connectapi.contenthub support for content streaming. streamsupport • contentstreamallowed • contentstreamnotallowed • contentstreamrequired connectapi.contenthub data type of the value of the field. variabletype • booleantype • datetimetype • decimaltype • htmltype • idtype • integertype 2006apex reference guide connectapi enums enum description • stringtype • uritype • xmltype connectapi.conversation conversation application integration types. application • api integrationtype • slack connectapi. action to take when creating the credential. createcredentialaction • refresh connectapi. authentication protocol of the external credential. credentialauthentication • awssv4 protocol • custom • noauth • oauth connectapi. authentication protocol variant of the external credential. credentialauthentication • awssv4_sts—aws signature version 4 with security token service. protocolvariant • jwtbearer—oauth 2.0 json web token bearer flow. • rolesanywhere—aws signature version 4 with identity and access management (iam) roles anywhere. connectapi. status of the credential authentication. credentialauthentication • configured—credential has all required credentials for at least one principal. status • notconfigured—credential isn’t configured. • unknown—credential status can’t be determined because the authentication protocol is custom. connectapi. type of credential principal. credentialprincipaltype • awsstsprincipal • namedprincipal • peruserprincipal connectapi. type of user. datacloudusertype • monthly—a user type that’s assigned monthly point limits for purchasing data.com records. only the assigned user can use monthly points. points expire at the end of the month. monthly is the default setting for datacloudusertype. • listpool—a user type that allows users to draw from a pool of points to purchase data.com records. 2007apex reference guide connectapi enums enum description connectapi. status of the import. datacloudimport • success—indicates that selected records were added to the org’s crm. statustypeenum • duplicate—marks a record that is already in the org’s crm. the api determines whether an org allows the addition of duplicate records in its crm. • error—indicates that the selected records weren’t added to the org’s crm. connectapi.digestperiod time period that’s included in a chatter email digest. • dailydigest—the email includes up to the 50 latest posts from the previous day. • weeklydigest—the email includes up to the 50 latest posts from the previous week. connectapi.emailmessage direction of an email message on a case. direction • inbound—an inbound message (sent by a customer). • outbound—an outbound message (sent to a customer by a support agent). connectapi.emailmessage status of an email message on a case. status • draftstatus • forwardedstatus • newstatus • readstatus • repliedstatus • sentstatus connectapi. information type of the extension. extensioninformationtype • lightning connectapi. parameter type of the external credential. externalcredential • authparameter parametertype • authprovider • authproviderurl • authproviderurlqueryparameter • jwtbodyclaim • jwtheaderclaim • signingcertificate connectapi. access type of the external credential principal. externalcredential • permissionset principalaccesstype • permissionsetgroup • profile 2008apex reference guide connectapi enums enum description connectapi. order of comments. feedcommentsortorder • createddatelatestasc—sorts by most recently created comments in ascending order. • createddateoldestasc—sorts by oldest comments in
ascending order. • relevance—sorts by most relevant content. connectapi.feeddensity density of the feed. • allupdates—displays all updates from people and records the user follows and groups the user is a member of. also displays custom recommendations. • fewerupdates—displays all updates from people and records the user follows and groups the user is a member of. also displays custom recommendations, but hides some system-generated updates from records. connectapi. capabilities of a feed element in api versions 31.0 and later. if a capability exists on a feed element, feedelementcapability the capability is available, even if the value doesn’t exist or is null. if the capability doesn’t type exist, it isn’t available. • associatedactions—the feed element includes information about actions associated with it. • approval—the feed element includes information about an approval. • banner—the body of the feed element has an icon and border. • bookmarks—the context user can bookmark the feed element. bookmarked feed elements are visible in the bookmarks feed. • bundle—the feed element has a group of other feed elements that display as a bundle in the feed. the bundle type determines the additional data associated with the bundle. • callcollaboration—the feed element has a recording comment. • canvas—the feed element renders a canvas app. • casecomment—the feed element has a case comment in the case feed. • chatterlikes—the context user can like the feed element. • close—the feed element can’t be edited, commented on, or deleted. if the feed element is a poll, it can’t be voted on. • comments—the context user can add comments to the feed element. • content—the feed element has a file. • dashboardcomponentsnapshot—the feed element has a dashboard component snapshot. • directmessage—the feed element is a direct message. • edit—users who have permission can edit the feed element. • emailmessage—the feed element has an email message from a case. • enhancedlink—the feed element has a link that can contain supplemental information like an icon, a title, and a description. • extensions—the feed element has one or more extension attachments. • feedentityshare—the feed element has a feed entity shared with it. 2009apex reference guide connectapi enums enum description • files—the feed element has one or more file attachments. • interactions—the feed element has information about user interactions. • link—the feed element has a url. • mediareferences—the feed element has one or more media references. • moderation—users in an experience cloud site can flag the feed element for moderation. • mute—the context user can mute the feed element. • origin—a feed action created the feed element. • pin—users who have permission can pin the feed element. • poll—the feed element has poll voting. • questionandanswers—the feed element has a question, and users can add answers to the feed element instead of comments. users can also select the best answer. • readby—the context user can mark the feed element as read. • recommendations—the feed element has a recommendation. • record—the comment has a record attachment. • recordsnapshot—the feed element has all the snapshot fields of a record for a single create record event. • socialpost—the feed element can interact with a social post on a social network. • status—the feed element has a status that determines its visibility. • topics—the context user can add topics to the feed element. • trackedchanges—the feed element has all changes to a record for a single tracked change event. • updownvote—users can upvote or downvote the feed element. • verified—users who have permission can mark a comment as verified or unverified. connectapi.feedelement feed elements are the top-level objects that a feed contains. the feed element type describes type the characteristics of that feed element. • bundle—a container of feed elements. a bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. • feeditem—a feed item has a single parent and is scoped to oneexperience cloud site or across all experience cloud sites. a feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. feed items have a body made up of message segments that can always be gracefully degraded to text-only
values. • recommendation—a recommendation is a feed element with a recommendations capability. a recommendation suggests records to follow, groups to join, or applications that are helpful to the context user. connectapi.feedentity status of the feed post or comment. status • draft—the feed post isn’t published but is visible to the author and users with modify all data or view all data permission. comments can’t be drafts. • pendingreview—the feed post or comment isn’t approved yet and therefore isn’t published or visible. 2010apex reference guide connectapi enums enum description • published—the feed post or comment is approved and visible. connectapi.feedfavorite origin of the feed favorite. type • listview • search • topic connectapi.feedfilter filter value for a feed. • allquestions—feed elements that are questions. • authoredby—feed elements authored by the user profile owner. this value is valid only for the userprofile feed. • communityscoped—feed elements that are scoped to experience cloud sites. currently, these feed elements have a user or a group parent record. however, other parent record types could be scoped to sites in the future. feed elements that are always visible in all sites are filtered out. this value is valid only for the userprofile feed. • questionswithcandidateanswers—feed elements that are questions that have candidate answers associated with them.this value is valid only for users with the access einstein-generated answers permission. • questionswithcandidateanswersreviewedpublished—feed elements that are questions that have candidate answers that have been reviewed or published. this value is valid only for users with the access einstein-generated answers permission. • read—feed elements that are older than 30 days or are marked as read for the context user. includes existing feed elements when the context user joined the group. this value is valid only for the record feed of a group. • solvedquestions—feed elements that are questions and that have a best answer. • unansweredquestions—feed elements that are questions and that don’t have any answers. • unansweredquestionswithcandidateanswers—feed elements that are questions that don’t have answers but have candidate answers associated with them. this value is valid only for users with the access einstein-generated answers permission. • unread—feed elements that are created in the past 30 days and aren’t marked as read for the context user. this value is valid only for the record feed of a group. • unsolvedquestions—feed elements that are questions and that don’t have a best answer. connectapi.feeditem attachment type for feed item output objects. attachmenttype • approval—a feed item requiring approval. • basictemplate—a feed item with a generic rendering of an image, link, and title. • canvas—a feed item that contains the metadata to render a link to a canvas app. • casecomment—a feed item created from a comment to a case record. • casecomment—a feed item created from a comment to a case record. • content—a feed item with a file attached. 2011apex reference guide connectapi enums enum description • dashboardcomponent—a feed item with a dashboard attached. • emailmessage—an email attached to a case record in case feed. • link—a feed item with a url attached. • poll—a feed item with a poll attached. • question—a feed item with a question attached. • recordsnapshot—the feed item attachment contains a view of a record at a single connectapi.feeditemtype.createrecordevent. • trackedchange—all changes to a record for a single connectapi.feeditemtype.trackedchange event. connectapi.feeditemtype type of feed item. • activityevent—feed item generated in case feed when an event or task associated with a parent record with a feed enabled is created or updated. • advancedtextpost—a feed item with advanced text formatting, such as a group announcement post. • approvalpost—feed item with an approval capability. approvers can act on the feed item parent. • attacharticleevent—feed item generated when an article is attached to a case in case feed. • basictemplatefeeditem—feed item with an enhanced link capability. • calllogpost—feed item generated when a call log is saved to a case in case feed. • canvaspost—feed item generated
by a canvas app in the publisher or from connect rest api or connect in apex. the post itself is a link to a canvas app. • casecommentpost—feed item generated when a case comment is saved in case feed. • changestatuspost—feed item generated when the status of a case is changed in case feed. • chattranscriptionpost—feed item generated in case feed when a live agent chat transcript is saved to a case. • collaborationgroupcreated—feed item generated when a new public group is created. contains a link to the new group. • collaborationgroupunarchived—deprecated. feed item generated when an archived group is activated. • contentpost—feed item with a content capability. • createrecordevent—feed item that describes a record created in the publisher. • dashboardcomponentalert—feed item with a dashboard alert. • dashboardcomponentsnapshot—feed item with a dashboard component snapshot capability. • emailmessageevent—feed item generated when an email is sent from a case in case feed. • facebookpost—deprecated. feed item generated when a facebook post is created from a case in case feed. 2012apex reference guide connectapi enums enum description • linkpost—feed item with a link capability. • milestoneevent—feed item generated when a case milestone is either completed or reaches a violation status. contains a link to the case milestone. • pollpost—feed item with a poll capability. viewers of the feed item are allowed to vote on the options in the poll. • profileskillpost—feed item generated when a skill is added to a user’s profile. • questionpost—feed item generated when a question is asked. as of api version 33.0, a feed item of this type can have a content capability and a link capability. • replypost—feed item generated by a chatter answers reply. • rypplepost—feed item generated when a user posts thanks. • socialpost—feed item generated when a social post is created from a case in case feed. • textpost—feed item containing text only. • trackedchange—feed item created when one or more fields on a record have been changed. • userstatus—deprecated. a user's post to their own profile. connectapi.feeditem type of users who can see a feed item. visibilitytype • allusers—visibility is not limited to internal users. • internalusers—visibility is limited to internal users. connectapi. order of feed items in the feed. feedsortorder • createddateasc—sorts by oldest creation date. this sort order is available only for directmessagemoderation, draft, moderation, and pendingreview feeds. • createddatedesc—sorts by most recent creation date. • lastmodifieddatedesc—sorts by most recent activity. • mostviewed—sorts by most viewed content. this sort order is available only for home feeds when the connectapi.feedfilter is unansweredquestions. • relevance—sorts by most relevant content. this sort order is available only for company, home, and topics feeds. connectapi.feedtype type of feed. • bookmarks—contains all feed items saved as bookmarks by the context user. • company—contains all feed items except feed items of type trackedchange. to see the feed item, the user must have sharing access to its parent. • directmessagemoderation—contains all direct messages that are flagged for moderation. the direct message moderation feed is available only to users with moderate experiences chatter messages permissions. • directmessages—contains all feed items of the context user’s direct messages. 2013apex reference guide connectapi enums enum description • draft—contains all the feed items that the context user drafted. • files—contains all feed items that contain files posted by people or groups that the context user follows. • filter—contains the news feed filtered to contain feed items whose parent is a specified object type. • groups—contains all feed items from all groups the context user either owns or is a member of. • home—contains all feed items associated with any managed topic in an experience cloud site. • landing—contains all feed items that best drive user engagement when the feed is requested. allows clients to avoid an empty feed when there aren’t many personalized feed items. • moderation—contains all feed items that are flagged for moderation, except direct
messages. the moderation feed is available only to users with moderate experiences feeds permissions. • mute—contains all feed items that the context user muted. • news—contains all updates for people the context user follows, groups the user is a member of, and files and records the user is following. contains all updates for records whose parent is the context user. • pendingreview—contains all feed items and comments that are pending review. • people—contains all feed items posted by all people the context user follows. • record—contains all feed items whose parent is a specified record, which could be a group, user, object, file, or any other standard or custom object. when the record is a group, the feed also contains feed items that mention the group. when the record is a user, the feed contains only feed items on that user. you can get another user’s record feed. • streams—contains all feed items for any combination of up to 25 feed-enabled entities that the context user subscribes to in a stream. examples of feed-enabled entities include people, groups, and records, • to—contains all feed items with mentions of the context user. contains feed items the context user commented on and feed items created by the context user that are commented on. • topics—contains all feed items that include the specified topic. • userprofile—contains feed items created when a user changes records that can be tracked in a feed. contains feed items whose parent is the user and feed items that @mention the user. this feed is different than the news feed, which returns more feed items, including group updates. you can get another user’s user profile feed. connectapi.fieldchange value type of a field change. valuetype • newvalue—a new value • oldvalue—an old value connectapi. format of the file preview. filepreviewformat • jpg—preview format is jpg. 2014apex reference guide connectapi enums enum description • pdf—preview format is pdf. • svg—preview format is compressed svg. • thumbnail—preview format is 240 x 180 png. • thumbnailbig—preview format is 720 x 480 png. • thumbnailtiny—preview format is 120 x 90 png. connectapi. availability status of the file preview. filepreviewstatus • available—preview is available. • inprogress—preview is being processed. • notavailable—preview is unavailable. • notscheduled—generation of the preview isn’t scheduled yet. connectapi. publish status of the file. filepublishstatus • pendingaccess—file is pending publishing. • privateaccess—file is private. • publicaccess—file is public. connectapi. sharing option of the file. filesharingoption • allowed—resharing of the file is allowed. • restricted—resharing of the file is restricted. connectapi. sharing privacy of a file. filesharingprivacy • none—file is visible to anyone with record access. • privateonrecords—file is private on records. connectapi. sharing role of the file. filesharingtype • admin—owner permission, but doesn’t own the file. • collaborator—viewer permission, and can edit, change permissions, and upload a new version of a file. • owner—collaborator permission, and can make a file private, and delete a file. • viewer—can view, download, and share a file. • workspacemanaged—permission controlled by the library. connectapi.folderitem type of item in a folder. type • file • folder connectapi.formfieldtype type of marketing integration form field. • boolean • date • emailaddress 2015apex reference guide connectapi enums enum description • number • text connectapi. formula filter type for the personalization audience. formulafiltertype • allcriteriamatch—all audience criteria are true (and operation). • anycriterionmatches—any audience criterion is true (or operation). • customlogicmatches—audience criteria match the custom formula (for example, (1 and 2) or 3). connectapi.grouparchive archive status of groups. status • all—all groups, including groups that are archived and groups that aren’t archived. • archived—groups that are archived. • notarchived—groups
that aren’t archived. connectapi.groupemail frequency with which a user receives email. frequency • eachpost • dailydigest • weeklydigest • never • usedefault connectapi. type of membership the user has with the group. groupmembershiptype • groupowner • groupmanager • notamember • notamemberprivaterequested • standardmember connectapi. status of a request to join a private group. groupmembership • accepted requeststatus • declined • pending connectapi.groupviral status of an invitation to join a group. invitationsstatus • acteduponuser—the user was added to the group. an email was sent asking the user to visit the group. • invited—an email was sent asking the user to sign up for the org. • maxedoutusers—the group has the maximum allowed members. • multipleerror—the user wasn’t invited due to multiple errors. • noactionneededuser—the user is already a member of the group. 2016apex reference guide connectapi enums enum description • notvisibletoexternalinviter—the user is not accessible to the user sending the invitation. • unhandled—the user couldn’t be added to the group for an unknown reason. connectapi. group visibility type. groupvisibilitytype • privateaccess—only members of the group can see posts to this group. • publicaccess—all users within the experience cloud site can see posts to this group. • unlisted—reserved for future use. connectapi.httprequest http method. method • httpdelete—returns http 204 on success. response body or output class is empty. • httpget—returns http 200 on success. • httphead—returns http 200 on success. response body or output class is empty. • httppatch—returns http 200 on success or http 204 if the response body or output class is empty. • httppost—returns http 201 on success or http 204 if the response body or output class is empty. exceptions are the batch posting resources and methods, which return http 200 on success. • httpput—return http 200 on success or http 204 if the response body or output class is empty. connectapi. source of the link metadata. linkmetadatasource • none—link metadata wasn’t retrieved. • sfdc—salesforce is the source. connectapi. type of link that the metadata represents. linkmetadatatype • error—link metadata couldn’t be retrieved. • link—represents a link. • none—link metadata wasn’t retrieved because the link isn’t an allowed domain. • photo—represents a photo. • rich—represents rich content, typically html content. • unknown—link metadata was retrieved, but the type is unknown. • video—represents a video. connectapi. type of maintenance. maintenancetype • downtime—downtime maintenance. • generallyavailable—maintenance with generally available mode. • maintenancewithdowntime—scheduled maintenance with downtime. • readonly—maintenance with read-only mode. 2017apex reference guide connectapi enums enum description connectapi. type of managed content channel. managedcontent • cloudtocloud channeltype • community • connectedapp • publicunauthenticated connectapi. type of managed content media. managedcontentmediatype • document • image connectapi. type of managed content node. managedcontentnodetype • date • datetime • media • mediasource • multilinetext • namefield • richtext • text • url connectapi.managedtopic type of managed topic. type • content—topics that are associated with native content. • featured—topics that are featured, for example, on the experience cloud site home page, but don’t provide overall navigation. • navigational—topics that display in a navigational menu in the experience cloud site. connectapi.markuptype type of rich text markup. • bold—bold tag. • code—code tag. • hyperlink—hyperlink anchor tag. • italic—italic tag. • listitem—list item tag. • orderedlist—ordered list tag. • paragraph—paragraph tag. • strikethrough—strik
ethrough tag. • underline—underline tag. • unorderedlist—unordered list tag. 2018apex reference guide connectapi enums enum description connectapi. type of mention completion. mentioncompletiontype • all—all mention completions, regardless of the type of record to which the mention refers. • group—mention completions for groups. • user—mention completions for users. connectapi. type of validation error for a proposed mention, if any. mentionvalidationstatus • disallowed—the proposed mention is invalid and is rejected because the context user is trying to mention something that is not allowed. for example, a user who is not a member of a private group is trying to mention the private group. • inaccessible—the proposed mention is allowed, but the user or record being mentioned isn’t notified. they don't have access to the parent record that’s being discussed. • ok—there is no validation error for this proposed mention. connectapi. type of message segment, such as text, link, field change name, or field change value. messagesegmenttype • entitylink • fieldchange • fieldchangename • fieldchangevalue • hashtag • inlineimage • link • markupbegin • markupend • mention • morechanges • resourcelink • text connectapi. type of named credential parameter. namedcredential • allowedmanagedpackagenamespaces parametertype • clientcertificate connectapi. type of named credential. namedcredentialtype • privateendpoint • securedendpoint connectapi. event, url type, or modal navigation menu item. navigationmenuitem • event—event-based navigation. actiontype note: event is internal only and can’t be used in custom components. 2019apex reference guide connectapi enums enum description • externallink—url outside of your experience cloud site. • internallink—relative url inside your experience cloud site. • modal—modal, such as account switcher. connectapi. target for the navigation menu item. navigationmenuitem • currentwindow—navigation menu item opens in the current window. opentarget • newwindow—navigation menu item opens in a new window. connectapi. type of navigation menu item. navigationmenuitemtype • datasourcedriven—menu items dynamically added from a data source. • event—event, such as logging in, logging out, or switching accounts. • externallink—url outside of your site. • globalaction—lets users create records that aren’t related to other records. • internallink—relative url inside your site. • menulabel—menu label. • modal—modal, such as account switcher. • navigationaltopic—dropdown list with links to the navigational topics in your site. • salesforceobject—objects such as accounts, cases, contacts, and custom objects. • systemlink—system link, such as a link to builder, workspaces, or setup. connectapi. type of action. nbaactiontype • flow—automated process tool with multiple subtypes. connectapi.nbaflowtype type of recommended flow. • autolaunchedflow—autolaunched flow that runs in the background. • flow—screen flow that accepts user inputs. connectapi. type of target. nbatargettype • recommendation connectapi. operation to carry out on the file. operationtype • add—adds the file to the feed element. • remove—removes the file from the feed element. connectapi. status of the orchestration instance. orchestrationinstancestatus • completed • inprogress • notstarted connectapi. type of orchestration step. orchestrationsteptype • asynchronousbackgroundstep 2020apex reference guide connectapi enums enum description • backgroundstep • interactivestep • managedcontentroleinteractivestep • managedcontentvariantsetlockbackgroundstep • managedcontentvariantsetreadybackgroundstep connectapi. status of the orchestration work item. orchestrationworkitemstatus • assigned • completed connectapi. sort order for order delivery group summaries. orderdeliverygroup • idasc—sorts by id in ascending alphanumeric order (a–z, 0–9). summarysort • iddesc
—sorts by id in descending alphanumeric order (z–a, 9–0). connectapi. sort order for order item summaries. orderitemsummarysort • idasc—sorts by id in ascending alphanumeric order (a–z, 0–9). • iddesc—sorts by id in descending alphanumeric order (z–a, 9–0). connectapi. sort order for order shipment items. ordershipmentitemsort • idasc—sorts by id in ascending alphanumeric order (a–z, 0–9). • iddesc—sorts by id in descending alphanumeric order (z–a, 9–0). connectapi. sort order for order shipments. ordershipmentsort • expecteddeliverydateasc—sorts by the oldest expected delivery date. • expecteddeliverydatedesc—sorts by the most recent expected delivery date. • shipmentnumberasc—sorts by shipment number in ascending order (0–9). • shipmentnumberdesc—sorts by shipment number in descending order (9–0). connectapi.ordersummary order summary adjustment aggregate job status. adjustmentaggregates • failed—the adjustment aggregate data job for the order summary failed. status • inprogress—the adjustment aggregate data job for the order summary is in progress. • notinitiated—the adjustment aggregate data job for the order summary is not initiated. • submitted—the adjustment aggregate data job for the order summary is submitted. connectapi.ordersummary type of price adjustment in promotions. adjustmenttargettype • splitline—price adjustment on an order item. • header—price adjustment on the entire order. connectapi.ordersummary sort order for order summaries. sortorder • createddateasc—sorts by the oldest created date. 2021apex reference guide connectapi enums enum description • createddatedesc—sorts by the most recent created date. • ordereddateasc—sorts by the oldest ordered date. • ordereddatedesc—sorts by the most recent ordered date. connectapi.periodtype time period used for forecasting. • month • quarter • week • year connectapi. location of an action link group on an associated feed element. platformaction • primary—the action link group is displayed in the body of the feed element. groupcategory • overflow—the action link group is displayed in the overflow menu of the feed element. connectapi. status of the action. platformactionstatus • failedstatus—the action link execution failed. • newstatus—the action link is ready to be executed. available for download and ui action links only. • pendingstatus—the action link is executing. choosing this value triggers the api call for api and apiasync action links. • successfulstatus—the action link executed successfully. connectapi. type of platform action. platformactiontype • actionlink—an indicator on a feed element that targets an api, a web page, or a file, represented by a button in the salesforce ui. • custombutton—when clicked, opens a url or a visualforce page in a window or executes javascript. • productivityaction—productivity actions are predefined and attached to a limited set of objects. productivity actions include send email, call, map, view website, and read news. except for the call action, you can’t edit productivity actions. • quickaction—a global or object-specific action. • standardbutton—a predefined salesforce button such as new, edit, or delete. connectapi. type of price adjustment for the tier. priceadjustmenttiertype • amountbasedadjustment—price is adjusted by a specified amount. • percentagebasedadjustment—price is adjusted by a specified percentage. connectapi. unit of time used to define a pricing term. pricingtermunit • months—product is priced on a monthly basis. • annual—product is priced on an annual basis. 2022apex reference guide connectapi enums enum description connectapi.productclass class of product. • simple • variation • variationparent connectapi. type of product media. productmediatype • document • image • video connectapi. usage type of a product media item within a media group. productmediausagetype • attachment—product media group with product documents as attachments. • banner—product category media group with banner images of
the product. • listing—product media group with listing images of the product. • standard—product media group with standard images and videos of the product. • tile—product category media group with tile images of the product. connectapi. publish refresh schedule. publishschedule • twelve—refreshes every twelve hours. • twentyfour—refreshes every twenty-four hours. connectapi. publish status of a personalization audience, target, or navigation menu item. publishstatus • draft • live connectapi. action to take on a recommendation. recommendationactiontype • follow—follow a file, record, topic, or user. • join—join a group. • view—view a file, group, article, record, user, custom, or static recommendation. connectapi. custom recommendation audience criteria type. recommendationaudience • customlist—a custom list of users makes up the audience. criteriatype • maxdaysincommunity—new members make up the audience. connectapi. operation to carry out on the custom recommendation audience members. recommendationaudience • add—adds specified members to the audience. memberoperationtype • remove—removes specified members from the audience. 2023apex reference guide connectapi enums enum description connectapi. a way to tie custom recommendations together. for example, display recommendations in recommendationchannel specific places in the ui or show recommendations based on time of day or geographic locations. • customchannel1—custom recommendation channel. not used by default. work with your community manager to define custom channels. for example, community managers can use experience builder to determine where recommendations appear. • customchannel2—custom recommendation channel. not used by default. work with your community manager to define custom channels. • customchannel3—custom recommendation channel. not used by default. work with your community manager to define custom channels. • customchannel4—custom recommendation channel. not used by default. work with your community manager to define custom channels. • customchannel5—custom recommendation channel. not used by default. work with your community manager to define custom channels. • defaultchannel—default recommendation channel. recommendations appear by default on the home and question detail pages of customer service and partner central experience builder templates. they also appear in the feed in the salesforce mobile web and anywhere community managers add recommendations using experience builder. connectapi. reason for a chatter recommendation. recommendationexplanationtype • articlehasrelatedcontent—articles with related content to a context article. • articleviewedtogether—articles often viewed together with the article that the context user just viewed. • articleviewedtogetherwithviewers—articles often viewed together with other records that the context user views. • custom—custom recommendations. • filepopular—files with many followers or views. • fileviewedtogether—files often viewed at the same time as other files that the context user views. • followedtogetherwithfollowees—users often followed together with other records that the context user follows. • groupmembersfollowed—groups with members that the context user follows. • groupnew—recently created groups. • grouppopular—groups with many active members. • itemviewedtogether—records often viewed at the same time as other records that the context user views. • popularapp—applications that are popular. • recordowned—records that the context user owns. • recordparentoffollowed—parent records of records that the context user follows. • recordviewed—records that the context user recently viewed. • topicfollowedtogether—topics often followed together with the record that the context user just followed. 2024apex reference guide connectapi enums enum description • topicfollowedtogetherwithfollowees—topics often followed together with other records that the context user follows. • topicpopularfollowed—topics with many followers. • topicpopularliked—topics on posts that have many likes. • userdirectreport—users who report to the context user. • userfollowedtogether—users often followed together with the record that the context user just followed. • userfollowssameusers—users who follow the same users as the context user. • usermanager—the context user’s manager. • usernew—recently created users. • userpeer—users who report to the same manager as the context user. • userpopular—users with many followers. • userviewingsamerecords—users who view the same records as the
context user. connectapi. type of reaction to a recommendation. recommendationreactiontype • accepted • rejected connectapi. type of record being recommended. recommendationtype • apps • articles • files • groups • records • topics • users connectapi. type of object being recommended. recommendedobjecttype • today—static recommendations that don’t have an id, for example, the today app recommendation. connectapi. order in which fields are rendered in a grid. recordcolumnorder • leftright—fields are rendered from left to right. • topdown—fields are rendered from the top down. connectapi. data type of a record field. recordfieldtype • address • blank • boolean • compound 2025apex reference guide connectapi enums enum description • createdby • date • datetime • email • lastmodifiedby • location • name • number • percent • phone • picklist • reference • text • time connectapi. type of related feed post. relatedfeedposttype • answered—related questions that have at least one answer. • bestanswer—related questions that have a best answer. • generic—all types of related questions, including answered, with a best answer, and unanswered. • unanswered—related questions that don’t have answers. connectapi.segmenttype type of segment. • dbt—data build tool connectapi. type of product selling model. sellingmodeltype • evergreen—a subscription without an end date. an evergreen subscription continues until the shopper affirmatively cancels it. • onetime—a product that isn’t sold as a subscription. • termdefined—a subscription with a defined end date. the subscription continues for a specified time period. when the term ends, the subscription ends. connectapi. type of site search result item. sitespagetype • contentpage • sitepage connectapi. social network provider. socialnetworkprovider • facebook • googleplus • instagram 2026apex reference guide connectapi enums enum description • instagrambusiness • kakaotalk • kik • line • linkedin • messenger • other • pinterest • qq • rypple • sinaweibo • sms • snapchat • telegram • twitter • vkontakte • wechat • whatsapp • youtube connectapi.socialpost message type of the social post. messagetype • comment • direct • post • privatemessage • reply • retweet • tweet connectapi. state of the social post. socialpoststatustype • approvalpending • approvalrecalled • approvalrejected • deleted • failed • hidden • pending • sent • unknown 2027apex reference guide connectapi enums enum description connectapi.sortorder order for sorting. • ascending—items are in ascending alphabetical order (a-z). • descending—items are in descending alphabetical order (z-a). • mostrecentlyviewed—items are in descending chronological order by view. this sort order is valid only for chatter feed streams. connectapi. status of a survey invitation email. surveyemailstatusenum • failed—the survey invitation email wasn't sent. • queued—the survey invitation email is queued for sending. connectapi. status of a tax transaction. taxtransactionstatus • committed—tax has been committed to the transaction. • uncommitted—tax hasn’t been committed to the transaction. connectapi. type of tax transaction. taxtransactiontype • credit—transaction is a credit transaction. • debit—transaction is a debit transaction. connectapi.topicsort order returned by the sort. • populardesc—sorts topics by popularity with the most popular first. this value is the default. • alphaasc—sorts topics alphabetically. connectapi. type of vote for a feed element or comment. updownvotevalue • down • none • up connectapi.useractivitytype type of user activity. • bookmark—user bookmarked a post. • chatteractivity—total counts of posts and comments made and likes and comments received for a user. • chatterlike—user liked a post or comment. • comment
—user commented on a post. • companyverify—user verified comment. • downvote—user downvoted a post or comment. • feedentityread—user read a post. • feedread—user read a feed. • mute—user muted a post. • post—user made a post. 2028apex reference guide connectapi enums enum description • topicendorsement—user endorsed another user on a topic or received endorsement on a topic. • upvote—user upvoted a post or comment. connectapi.usermission type of mission activity for a user. activitytype • feeditemansweraquestion—user answered a question. • feeditemlikesomething—user liked a post or comment. • feeditemmarkanswerasbest—user marked an answer as the best answer. • feeditempostquestion—user posted a question. • feeditemreceiveacomment—user received a comment on a post. • feeditemreceivealike—user received a like on a post or comment. • feeditemreceiveananswer—user received an answer to a question. • feeditemwriteacomment—user commented on a post. • feeditemwriteapost—user made a post. • feeditemyouranswermarkedbest—user’s answer was marked as the best answer. connectapi.userprofile type of user profile tab. tabtype • customvisualforce—tab that displays data from a visualforce page. • customweb—tab that displays data from any external web-based application or web page. • element—tab that displays generic content inline. • feed—tab that displays the chatter feed. • overview—tab that displays user details. connectapi.usertype type of user. • chatterguest—user is an external user in a private group. • chatteronly—user is a chatter free customer. • guest—user is unauthenticated. • internal—user is a standard org member. • portal—user is an external user in an experience cloud site. • system—user is chatter expert or a system user. • undefined—user is a user type that is a custom object. connectapi.wishlistitem sort order for wishlist items. sortorder • createddateasc—sorts by oldest creation date. • createddatedesc—sorts by most recent creation date. connectapi. status of a workflow process. workflowprocessstatus • approved • fault 2029apex reference guide connectapi exceptions enum description • held • noresponse • pending • reassigned • rejected • removed • started connectapi.zonesearch zone search result type. resulttype • article—search results contain only articles. • question—search results contain only questions. connectapi.zoneshowin zone search result location. • community—available in an experience cloud site. • internal—available internally only. • portal—available in a portal. connectapi exceptions the connectapi namespace contains exception classes. all exceptions classes support built-in methods for returning the error message and exception type. see exception class and built-in exceptions on page 3021. the connectapi namespace contains these exceptions: exception description connectapi.connectapiexception any logic error in the way your application is utilizing connectapi code. this is equivalent to receiving a 400 error from connect rest api. connectapi.notfoundexception any issues with the specified resource being found. this is equivalent to receiving a 404 error from connect rest api. connectapi.ratelimitexception when you exceed the rate limit. this is equivalent to receiving a 503 service unavailable error from connect rest api. connectapi utilities the connectapi namespace contains a utility class. utility description connectapi.connectutilities.unwrapapexwrapper() reserved for internal use. 2030apex reference guide connectapi release notes connectapi release notes use the salesforce release notes to learn about the most recent updates and changes to the connectapi namespace in apex. for updates and changes that impact apex, including connectapi, see the apex release notes. for new and changed connectapi classes and enums, see connectapi (connect in apex): new and changed classes and enums in the salesforce release notes. database namespace the database namespace provides classes used with dml operations. the following are the classes in the database namespace. in this section: batch
able interface the class that implements this interface can be executed as a batch apex job. batchablecontext interface represents the parameter type of a batch job method and contains the batch job id. this interface is implemented internally by apex. deletedrecord class contains information about a deleted record. deleteresult class represents the result of a delete dml operation returned by the database.delete method. dmloptions class enables you to set options related to dml operations. dmloptions.assignmentruleheader class enables setting assignment rule options. dmloptions.duplicateruleheader class determines options for using duplicate rules to detect duplicate records. duplicate rules are part of the duplicate management feature. dmloptions.emailheader class enables setting email options. duplicateerror class contains information about an error that occurred when an attempt was made to save a duplicate record. use if your organization has set up duplicate rules, which are part of the duplicate management feature. emptyrecyclebinresult class the result of the emptyrecyclebin dml operation returned by the database.emptyrecyclebin method. error class represents information about an error that occurred during a dml operation when using a database method. getdeletedresult class contains the deleted records retrieved for a specific sobject type and time window. 2031apex reference guide batchable interface getupdatedresult class contains the result for the database.getupdated method call. leadconvert class contains information used for lead conversion. leadconvertresult class the result of a lead conversion. mergeresult class contains the result of a merge database method operation. querylocator class represents the record set returned by database.getquerylocator and used with batch apex. querylocatoriterator class represents an iterator over a query locator record set. saveresult class the result of an insert or update dml operation returned by a database method. undeleteresult class the result of an undelete dml operation returned by the database.undelete method. upsertresult class the result of an upsert dml operation returned by the database.upsert method. batchable interface the class that implements this interface can be executed as a batch apex job. namespace database see also: apex developer guide: using batch batchable methods the following are methods for batchable. in this section: execute(jobid, recordlist) gets invoked when the batch job executes and operates on one batch of records. contains or calls the main execution logic for the batch job. finish(jobid) gets invoked when the batch job finishes. place any clean up code in this method. start(jobid) gets invoked when the batch job starts. returns the record set as an iterable that will be batched for execution. 2032
apex reference guide batchable interface start(jobid) gets invoked when the batch job starts. returns the record set as a querylocator object that will be batched for execution. execute(jobid, recordlist) gets invoked when the batch job executes and operates on one batch of records. contains or calls the main execution logic for the batch job. signature public void execute(database.batchablecontext jobid, list<sobject> recordlist) parameters jobid type: database.batchablecontext contains the job id. recordlist type: list<sobject> contains the batch of records to process. return value type: void finish(jobid) gets invoked when the batch job finishes. place any clean up code in this method. signature public void finish(database.batchablecontext jobid) parameters jobid type: database.batchablecontext contains the job id. return value type: void start(jobid) gets invoked when the batch job starts. returns the record set as an iterable that will be batched for execution. 2033apex reference guide batchablecontext interface signature public system.iterable start(database.batchablecontext jobid) parameters jobid type: database.batchablecontext contains the job id. return value type: system.iterable start(jobid) gets invoked when the batch job starts. returns the record set as a querylocator object that will be batched for execution. signature public database.querylocator start(database.batchablecontext jobid) parameters jobid type: database.batchablecontext contains the job id. return value type: database.querylocator batchablecontext interface represents the parameter type of a batch job method and contains the batch job id. this interface is implemented internally by apex. namespace database see also: batchable interface batchablecontext methods the following are methods for batchablecontext. 2034apex reference guide deletedrecord class in this section: getchildjobid() returns the id of the current batch job chunk that is being processed. getjobid() returns the batch job id. getchildjobid() returns the id of the current batch job chunk that is being processed. signature public id getchildjobid() return value type: id getjobid() returns the batch job id. signature public id getjobid() return value type: id deletedrecord class contains information about a deleted record. namespace database usage the getdeletedrecords method of the database.getdeletedresult class returns a list of database.deletedrecord objects. use the methods in the database.deletedrecord class to retrieve details about each deleted record. deletedrecord methods the following are methods for deletedrecord. all are instance methods. 2035apex reference guide deleteresult class in this section: getdeleteddate() returns the deleted date of this record. getid() returns the id of a record deleted within the time window specified in the database.getdeleted method. getdeleteddate() returns the deleted date of this record. signature public date getdeleteddate() return value type: date getid() returns the id of a record deleted within the time window specified in the database.getdeleted method. signature public id getid() return value type: id deleteresult class represents the result of a delete dml operation returned by the database.delete method. namespace database usage an array of database.deleteresult objects is returned with the delete database method. each element in the deleteresult array corresponds to the sobject array passed as the sobject[] parameter in the delete database method; that is, the first element in the deleteresult array matches the first element passed in the sobject array, the second element corresponds with the second element, and so on. if only one sobject is passed in, the deleteresult array contains a single element. 2036apex reference guide deleteresult class example the following example shows how to obtain and iterate through the returned database.deleteresult objects. it deletes some queried accounts using database.delete with a false second parameter to allow partial processing of records on failure. next, it iterates through the results to determine whether the operation was successful or not for each record. it writes the id of every
record that was processed successfully to the debug log, or error messages and fields of the failed records. // query the accounts to delete account[] accts = [select id from account where name like 'acme%']; // delete the accounts database.deleteresult[] drlist = database.delete(accts, false); // iterate through each returned result for(database.deleteresult dr : drlist) { if (dr.issuccess()) { // operation was successful, so get the id of the record that was processed system.debug('successfully deleted account with id: ' + dr.getid()); } else { // operation failed, so get all errors for(database.error err : dr.geterrors()) { system.debug('the following error has occurred.'); system.debug(err.getstatuscode() + ': ' + err.getmessage()); system.debug('account fields that affected this error: ' + err.getfields()); } } } deleteresult methods the following are methods for deleteresult. all are instance methods. in this section: geterrors() if an error occurred, returns an array of one or more database error objects providing the error code and description. if no error occurred, returns an empty set. getid() returns the id of the sobject you were trying to delete. issuccess() a boolean value that is set to true if the dml operation was successful for this object, false otherwise. geterrors() if an error occurred, returns an array of one or more database error objects providing the error code and description. if no error occurred, returns an empty set. signature public database.error[] geterrors() 2037apex reference guide dmloptions class return value type: database.error[] getid() returns the id of the sobject you were trying to delete. signature public id getid() return value type: id issuccess() a boolean value that is set to true if the dml operation was successful for this object, false otherwise. signature public boolean issuccess() return value type: boolean dmloptions class enables you to set options related to dml operations. namespace database usage database.dmloptions is only available for apex saved against api versions 15.0 and higher. dmloptions settings take effect only for record operations performed using apex dml and not through the salesforce user interface. the dmloptions class has three child options. dml child options dmloptions.assignmentruleheader—enables setting assignment rule options. dmloptions.duplicateruleheader—determines options for using duplicate rules to detect duplicate records. duplicate rules are part of the duplicate management feature. dmloptions.emailheader—enables setting email options. 2038apex reference guide dmloptions class dmloptions properties the following are properties for dmloptions. in this section: allowfieldtruncation specifies the truncation behavior of large strings. assignmentruleheader specifies the assignment rule to be used when creating a case or lead. emailheader specifies additional information regarding the automatic email that gets sent when an events occurs. localeoptions specifies the language of any labels that are returned by apex. optallornone specifies whether the operation allows for partial success. allowfieldtruncation specifies the truncation behavior of large strings. signature public boolean allowfieldtruncation {get; set;} property value type: boolean usage in apex saved against api versions previous to 15.0, if you specify a value for a string and that value is too large, the value is truncated. for api version 15.0 and later, if a value is specified that is too large, the operation fails and an error message is returned. the allowfieldtruncation property allows you to specify that the previous behavior, truncation, be used instead of the new behavior in apex saved against api versions 15.0 and later. assignmentruleheader specifies the assignment rule to be used when creating a case or lead. signature public database.dmloptions.assignmentruleheader assignmentruleheader {get; set;} property value type: database.dmloptions.assignmentruleheader 2039apex reference guide dmloptions class usage note: the database.dmloptions object supports assignment rules for cases and leads, but not for accounts. emailheader specifies additional information regarding the automatic email that gets sent when an events
occurs. signature public database.dmloptions.emailheader emailheader {get; set;} property value type: database.dmloptions.emailheader usage the salesforce user interface allows you to specify whether or not to send an email when the following events occur. • creation of a new case or task • conversion of a case email to a contact • new user email notification • lead queue email notification • password reset in apex saved against api version 15.0 or later, the database.dmloptions emailheader property enables you to specify additional information regarding the email that gets sent when one of the events occurs because of the code's execution. localeoptions specifies the language of any labels that are returned by apex. signature public database.dmloptions.localeoptions localeoptions {get; set;} property value type: database.dmloptions.localeoptions usage the value must be a valid user locale (language and country), such as de_de or en_gb. the value is a string, 2-5 characters long. the first two characters are always an iso language code, for example 'fr' or 'en.' if the value is further qualified by a country, then the string also has an underscore (_) and another iso country code, for example 'us' or 'uk'. for example, the string for the united states is 'en_us', and the string for french canadian is 'fr_ca'. optallornone specifies whether the operation allows for partial success. 2040apex reference guide dmloptions.assignmentruleheader class signature public boolean optallornone {get; set;} property value type: boolean usage if optallornone is set to true, all changes are rolled back if any record causes errors. the default for this property is false and successfully processed records are committed while records with errors aren't. this property is available in apex saved against salesforce api version 20.0 and later. dmloptions.assignmentruleheader class enables setting assignment rule options. namespace database example the following example uses the usedefaultrule option: database.dmloptions dmo = new database.dmloptions(); dmo.assignmentruleheader.usedefaultrule= true; lead l = new lead(company='abc', lastname='smith'); l.setoptions(dmo); insert l; the following example uses the assignmentruleid option: database.dmloptions dmo = new database.dmloptions(); dmo.assignmentruleheader.assignmentruleid= '01qd0000000eqan'; lead l = new lead(company='abc', lastname='smith'); l.setoptions(dmo); insert l; dmloptions.assignmentruleheader properties the following are properties for dmloptions.assignmentruleheader. in this section: assignmentruleid specifies the id of a specific assignment rule to run for the case or lead. the assignment rule can be active or inactive. 2041apex reference guide dmloptions.duplicateruleheader class usedefaultrule if specified as true for a case or lead, the system uses the default (active) assignment rule for the case or lead. if specified, do not specify an assignmentruleid. assignmentruleid specifies the id of a specific assignment rule to run for the case or lead. the assignment rule can be active or inactive. signature public id assignmentruleid {get; set;} property value type: id usage the id can be retrieved by querying the assignmentrule sobject. if specified, do not specify usedefaultrule. if the value is not in the correct id format (15-character or 18-character salesforce id), the call fails and an exception is returned. usedefaultrule if specified as true for a case or lead, the system uses the default (active) assignment rule for the case or lead. if specified, do not specify an assignmentruleid. signature public boolean usedefaultrule {get; set;} property value type: boolean usage if there are no assignment rules in the organization, in api version 29.0 and earlier, creating a case or lead with usedefaultrule set to true results in the case or lead being assigned to the predefined default owner. in api version 30.0 and later, the case or lead is unassigned and doesn't get assigned to the default owner. dmloptions.duplicateruleheader class determines options for using duplicate rules to detect duplicate records. duplicate rules are part of the duplicate
management feature. namespace database 2042apex reference guide dmloptions.duplicateruleheader class example the following example shows how to save an account record that’s been identified as a duplicate. to learn how to iterate through duplicate errors, see duplicateerror class database.dmloptions dml = new database.dmloptions(); dml.duplicateruleheader.allowsave = true; dml.duplicateruleheader.runascurrentuser = true; account duplicateaccount = new account(name='dupe'); database.saveresult sr = database.insert(duplicateaccount, dml); if (sr.issuccess()) { system.debug('duplicate account has been inserted in salesforce!'); } in this section: dmloptions.duplicateruleheader properties dmloptions.duplicateruleheader properties the following are properties for dmloptions.duplicateruleheader. in this section: allowsave for a duplicate rule, when the alert option is enabled, bypass alerts and save duplicate records by setting this property to true. prevent duplicate records from being saved by setting this property to false. runascurrentuser make sure that sharing rules for the current user are enforced when duplicate rules run by setting this property to true. use the sharing rules specified in the class for the request by setting this property to false. if no sharing rules are specified, apex code runs in system context and sharing rules for the current user are not enforced. allowsave for a duplicate rule, when the alert option is enabled, bypass alerts and save duplicate records by setting this property to true. prevent duplicate records from being saved by setting this property to false. signature public boolean allowsave {get; set;} property value type: boolean 2043apex reference guide dmloptions.emailheader class example this example shows how to save an account record that’s been identified as a duplicate. dml.duplicateruleheader.allowsave = true means the user should be allowed to save the duplicate. to learn how to iterate through duplicate errors, see duplicateerror class. database.dmloptions dml = new database.dmloptions(); dml.duplicateruleheader.allowsave = true; dml.duplicateruleheader.runascurrentuser = true; account duplicateaccount = new account(name='dupe'); database.saveresult sr = database.insert(duplicateaccount, dml); if (sr.issuccess()) { system.debug('duplicate account has been inserted in salesforce!'); } runascurrentuser make sure that sharing rules for the current user are enforced when duplicate rules run by setting this property to true. use the sharing rules specified in the class for the request by setting this property to false. if no sharing rules are specified, apex code runs in system context and sharing rules for the current user are not enforced. signature public boolean runascurrentuser {get; set;} property value type: boolean usage if specified as true, duplicate rules run for the current user, which ensures users can’t view duplicate records that aren’t available to them. use runascurrentuser = true to detect duplicates when converting leads to contacts. typically, lead conversion apex code runs in a system context and does not enforce sharing rules for the current user. example this example shows how to set options so that duplicate rules run for the current user when saving a new account. database.dmloptions dml = new database.dmloptions(); dml.duplicateruleheader.allowsave = true; dml.duplicateruleheader.runascurrentuser = true; account duplicateaccount = new account(name='dupe'); database.saveresult sr = database.insert(duplicateaccount, dml); if (sr.issuccess()) { system.debug('duplicate account has been inserted in salesforce!'); } dmloptions.emailheader class enables setting email options. 2044apex reference guide dmloptions.emailheader class namespace database usage even though auto-sent emails can be triggered by actions in the salesforce user interface, the dmloptions settings for emailheader take effect only for dml operations carried out in apex code. example in the following example, the triggerautoresponseemail option is specified: account a = new account(name='acme plumbing'); insert a; contact c = new contact(email='[email protected]',
firstname='joe',lastname='plumber', accountid=a.id); insert c; database.dmloptions dlo = new database.dmloptions(); dlo.emailheader.triggerautoresponseemail = true; case ca = new case(subject='plumbing problems', contactid=c.id); database.insert(ca, dlo); suppose that you use an after-insert or after-update trigger to change ownership of leads, contacts, or opportunities. if you use the api to change record ownership, or if a lightning experience user changes a record’s owner, no email notification is sent. to send email notifications to a record’s new owner, set the triggeruseremail property to true. dmloptions.emailheader properties the following are properties for dmloptions.emailheader. in this section: triggerautoresponseemail indicates whether to trigger auto-response rules (true) or not (false), for leads and cases. triggerotheremail indicates whether to trigger email outside the organization (true) or not (false). triggeruseremail indicates whether to trigger email that is sent to users in the organization (true) or not (false). triggerautoresponseemail indicates whether to trigger auto-response rules (true) or not (false), for leads and cases. 2045apex reference guide dmloptions.emailheader class signature public boolean triggerautoresponseemail {get; set;} property value type: boolean usage this email can be automatically triggered by a number of events, for example creating a case or resetting a user password. if this value is set to true, when a case is created, if there is an email address for the contact specified in contactid, the email is sent to that address. if not, the email is sent to the address specified in suppliedemail triggerotheremail indicates whether to trigger email outside the organization (true) or not (false). signature public boolean triggerotheremail {get; set;} property value type: boolean usage this email can be automatically triggered by creating, editing, or deleting a contact for a case. note: email sent through apex because of a group event includes additional behaviors. a group event is an event for which isgroupevent is true. the eventattendee object tracks the users, leads, or contacts that are invited to a group event. note the following behaviors for group event email sent through apex: • sending a group event invitation to a lead or contact respects the triggerotheremail option • email sent when updating or deleting a group event also respects the triggeruseremail and triggerotheremail options, as appropriate triggeruseremail indicates whether to trigger email that is sent to users in the organization (true) or not (false). signature public boolean triggeruseremail {get; set;} property value type: boolean 2046apex reference guide duplicateerror class usage this email can be automatically triggered by a number of events; resetting a password, creating a new user, or creating or modifying a task. note: adding comments to a case in apex doesn’t trigger email to users in the organization even if triggeruseremail is set to true. note: email sent through apex because of a group event includes additional behaviors. a group event is an event for which isgroupevent is true. the eventattendee object tracks the users, leads, or contacts that are invited to a group event. note the following behaviors for group event email sent through apex: • sending a group event invitation to a user respects the triggeruseremail option • email sent when updating or deleting a group event also respects the triggeruseremail and triggerotheremail options, as appropriate duplicateerror class contains information about an error that occurred when an attempt was made to save a duplicate record. use if your organization has set up duplicate rules, which are part of the duplicate management feature. namespace database example when you try to save a record that’s identified as a duplicate record by a duplicate rule, you’ll receive a duplicate error. if the duplicate rule contains the allow action, an attempt will be made to bypass the error. // try to save a duplicate account account duplicateaccount = new account(name='acme', billingcity='san francisco'); database.saveresult sr = database.insert(duplicateaccount, false); if (!sr.issuccess()) { // insertion failed due to duplicate detected for(database.error duplicateerror : sr.geterrors()){ datacloud.duplicateresult duplicateresult = ((database.dupl
icateerror)duplicateerror).getduplicateresult(); system.debug('duplicate records have been detected by ' + duplicateresult.getduplicaterule()); system.debug(duplicateresult.geterrormessage()); } // if the duplicate rule is an alert rule, we can try to bypass it database.dmloptions dml = new database.dmloptions(); dml.duplicateruleheader.allowsave = true; database.saveresult sr2 = database.insert(duplicateaccount, dml); if (sr2.issuccess()) { system.debug('duplicate account has been inserted in salesforce!'); } } 2047apex reference guide duplicateerror class in this section: duplicateerror methods see also: saveresult class duplicateresult class error class duplicateerror methods the following are methods for duplicateerror. in this section: getduplicateresult() returns the details of a duplicate rule and duplicate records found by the duplicate rule. getfields() returns an array of one or more field names. identifies which fields in the object, if any, affected the error condition. getmessage() returns the error message text. getstatuscode() returns a code that characterizes the error. getduplicateresult() returns the details of a duplicate rule and duplicate records found by the duplicate rule. signature public datacloud.duplicateresult getduplicateresult() return value type: datacloud.duplicateresult example this example shows the code used to get the possible duplicates and related match information after saving a new contact. this code is part of a custom application that implements duplicate management when users add a contact. see duplicateresult class on page 2079 to check out the entire sample applicaton. datacloud.duplicateresult duplicateresult = duplicateerror.getduplicateresult(); getfields() returns an array of one or more field names. identifies which fields in the object, if any, affected the error condition. 2048apex reference guide emptyrecyclebinresult class signature public list<string> getfields() return value type: list<string> getmessage() returns the error message text. signature public string getmessage() return value type: string getstatuscode() returns a code that characterizes the error. signature public statuscode getstatuscode() return value type: statuscode emptyrecyclebinresult class the result of the emptyrecyclebin dml operation returned by the database.emptyrecyclebin method. namespace database usage a list of database.emptyrecyclebinresult objects is returned by the database.emptyrecyclebin method. each object in the list corresponds to either a record id or an sobject passed as the parameter in the database.emptyrecyclebin method. the first index in the emptyrecyclebinresult list matches the first record or sobject specified in the list, the second with the second, and so on. emptyrecyclebinresult methods the following are methods for emptyrecyclebinresult. all are instance methods. 2049apex reference guide error class in this section: geterrors() if an error occurred during the delete for this record or sobject, returns a list of one or more database.error objects. if no errors occurred, the returned list is empty. getid() returns the id of the record or sobject you attempted to delete. issuccess() returns true if the record or sobject was successfully removed from the recycle bin; otherwise false. geterrors() if an error occurred during the delete for this record or sobject, returns a list of one or more database.error objects. if no errors occurred, the returned list is empty. signature public database.errors[] geterrors() return value type: database.errors [] getid() returns the id of the record or sobject you attempted to delete. signature public id getid() return value type: id issuccess() returns true if the record or sobject was successfully removed from the recycle bin; otherwise false. signature public boolean issuccess() return value type: boolean error class represents information about an error that occurred during a dml operation when using a database method. 2050apex reference guide error class namespace database usage error class is part of
saveresult, which is generated when a user attempts to save a salesforce record. see also: saveresult class duplicateerror class error methods the following are methods for error. all are instance methods. in this section: getfields() returns an array of one or more field names. identifies which fields in the object, if any, affected the error condition. getmessage() returns the error message text. getstatuscode() returns a code that characterizes the error. getfields() returns an array of one or more field names. identifies which fields in the object, if any, affected the error condition. signature public string[] getfields() return value type: string[] getmessage() returns the error message text. signature public string getmessage() return value type: string 2051apex reference guide getdeletedresult class getstatuscode() returns a code that characterizes the error. signature public statuscode getstatuscode() return value type: statuscode usage the full list of status codes is available in the wsdl file for your organization (see downloading salesforce wsdls and client authentication certificates in the salesforce online help.) getdeletedresult class contains the deleted records retrieved for a specific sobject type and time window. namespace database usage the database.getdeleted method returns the deleted record information as a database.getdeletedresult object. getdeletedresult methods the following are methods for getdeletedresult. all are instance methods. in this section: getdeletedrecords() returns a list of deleted records for the time window specified in the database.getdeleted method call. getearliestdateavailable() returns the date in coordinated universal time (utc) of the earliest physically deleted object for the sobject type specified in database.getdeleted. getlatestdatecovered() returns the date in coordinated universal time (utc) of the last date covered in the database.getdeleted call. getdeletedrecords() returns a list of deleted records for the time window specified in the database.getdeleted method call. 2052apex reference guide getupdatedresult class signature public list<database.deletedrecord> getdeletedrecords() return value type: list<database.deletedrecord> getearliestdateavailable() returns the date in coordinated universal time (utc) of the earliest physically deleted object for the sobject type specified in database.getdeleted. signature public date getearliestdateavailable() return value type: date getlatestdatecovered() returns the date in coordinated universal time (utc) of the last date covered in the database.getdeleted call. signature public date getlatestdatecovered() return value type: date usage if there is a value, it is less than or equal to the enddate argument of database.getdeleted. a value here indicates that, for safety, you should use this value for the startdate of your next call to capture the changes that started after this date but didn’t complete before enddate and were, therefore, not returned in the previous call. getupdatedresult class contains the result for the database.getupdated method call. namespace database 2053apex reference guide leadconvert class usage use the methods in this class to obtain detailed information about the updated records returned by database.getupdated for a specific time window. getupdatedresult methods the following are methods for getupdatedresult. all are instance methods. in this section: getids() returns the ids of records updated within the time window specified in the database.getupdated method. getlatestdatecovered() returns the date in coordinated universal time (utc) of the last date covered in the database.getupdated call. getids() returns the ids of records updated within the time window specified in the database.getupdated method. signature public list<id> getids() return value type: list<id> getlatestdatecovered() returns the date in coordinated universal time (utc) of the last date covered in the database.getupdated call. signature public date getlatestdatecovered() return value type: date leadconvert class contains information used for lead conversion. namespace database 2054apex reference guide leadconvert class usage the convertlead database method converts a lead into an account and contact or an account and person account, as well
as (optionally) an opportunity. the convertlead takes an instance of the database.leadconvert class as a parameter. create an instance of this class and set the information required for conversion, such as setting the lead, and destination account and contact. note: the database.convertlead() method can take one leadconvert object or a list of leadconvert objects. example this example shows how to use the database.convertlead method to convert a lead. it inserts a new lead, creates a leadconvert object, sets its status to converted, then passes it to the database.convertlead method. finally, it verifies that the conversion was successful. lead mylead = new lead(lastname = 'fry', company='fry and sons'); insert mylead; database.leadconvert lc = new database.leadconvert(); lc.setleadid(mylead.id); leadstatus convertstatus = [select id, masterlabel from leadstatus where isconverted=true limit 1]; lc.setconvertedstatus(convertstatus.masterlabel); database.leadconvertresult lcr = database.convertlead(lc); system.assert(lcr.issuccess()); in this section: leadconvert constructors leadconvert methods leadconvert constructors the following are constructors for leadconvert. in this section: leadconvert() creates a new instance of the database.leadconvert class. leadconvert() creates a new instance of the database.leadconvert class. signature public leadconvert() 2055apex reference guide leadconvert class leadconvert methods the following are methods for leadconvert. all are instance methods. in this section: getaccountid() gets the id of the account into which the lead will be merged. getcontactid() gets the id of the contact into which the lead will be merged. getconvertedstatus() gets the lead status value for a converted lead. getleadid() gets the id of the lead to convert. getopportunityid() gets the id of the existing opportunity that will be related to the resulting contact. getopportunityname() gets the name of the opportunity to create. getownerid() gets the id of the person to own any newly created account, contact, and opportunity. getrelatedpersonaccountid() gets the id of the existing person account into which the lead will be converted. getrelatedpersonaccountrecord() gets the entity record of the new person account into which the lead will be converted. isdonotcreateopportunity() indicates whether an opportunity is created during lead conversion (false, the default) or not (true). isoverwriteleadsource() indicates whether the leadsource field on the target contact object is overwritten with the contents of the leadsource field in the source lead object (true), or not (false, the default). issendnotificationemail() indicates whether a notification email is sent to the owner specified by setownerid (true) or not (false, the default). setaccountid(accountid) sets the id of the account into which the lead is merged. this value is required only when updating an existing account, including person accounts. setcontactid(contactid) sets the id of the contact into which the lead will be merged (this contact must be associated with the account specified with setaccountid, and setaccountid must be specified). this value is required only when updating an existing contact. setconvertedstatus(status) sets the lead status value for a converted lead. this field is required. setdonotcreateopportunity(createopportunity) specifies whether to create an opportunity during lead conversion. the default value is false: opportunities are created by default. set this flag to true only if you do not want to create an opportunity from the lead. 2056apex reference guide leadconvert class setleadid(leadid) sets the id of the lead to convert. this field is required. setopportunityid(opportunityid) sets the id of the opportunity into which the lead is merged. this value is required only when updating an existing opportunity. setopportunityname(opportunityname) sets the name of the opportunity to create. if no name is specified, this value defaults to the company name of the lead. setoverwriteleadsource(overwriteleadsource) specifies whether to overwrite the leadsource field on the target contact object
with the contents of the leadsource field in the source lead object. the default value is false, to not overwrite the field. if you specify this as true, you must also specify setcontactid for the target contact. setownerid(ownerid) specifies the id of the person to own any newly created account, contact, and opportunity. if the application does not specify this value, the owner of the new object will be the owner of the lead. setrelatedpersonaccountid(relatedpersonaccountid) sets the id of the existing person account into which to convert the lead. this value is required only when updating an existing person account. setrelatedpersonaccountrecord(entity relatedpersonaccountrecord) sets the entity record of the new person account into which to convert the lead. setsendnotificationemail(sendemail) specifies whether to send a notification email to the owner specified by setownerid. the default value is false, that is, to not send email. getaccountid() gets the id of the account into which the lead will be merged. signature public id getaccountid() return value type: id getcontactid() gets the id of the contact into which the lead will be merged. signature public id getcontactid() return value type: id 2057apex reference guide leadconvert class getconvertedstatus() gets the lead status value for a converted lead. signature public string getconvertedstatus() return value type: string getleadid() gets the id of the lead to convert. signature public id getleadid() return value type: id getopportunityid() gets the id of the existing opportunity that will be related to the resulting contact. signature public id getopportunityid() return value type: id getopportunityname() gets the name of the opportunity to create. signature public string getopportunityname() return value type: string getownerid() gets the id of the person to own any newly created account, contact, and opportunity. 2058apex reference guide leadconvert class signature public id getownerid() return value type: id getrelatedpersonaccountid() gets the id of the existing person account into which the lead will be converted. signature public id getrelatedpersonaccountid() return value type: id getrelatedpersonaccountrecord() gets the entity record of the new person account into which the lead will be converted. signature public id getrelatedpersonaccountrecord() return value type: id isdonotcreateopportunity() indicates whether an opportunity is created during lead conversion (false, the default) or not (true). signature public boolean isdonotcreateopportunity() return value type: boolean isoverwriteleadsource() indicates whether the leadsource field on the target contact object is overwritten with the contents of the leadsource field in the source lead object (true), or not (false, the default). 2059apex reference guide leadconvert class signature public boolean isoverwriteleadsource() return value type: boolean issendnotificationemail() indicates whether a notification email is sent to the owner specified by setownerid (true) or not (false, the default). signature public boolean issendnotificationemail() return value type: boolean setaccountid(accountid) sets the id of the account into which the lead is merged. this value is required only when updating an existing account, including person accounts. signature public void setaccountid(id accountid) parameters accountid type: id return value type: void setcontactid(contactid) sets the id of the contact into which the lead will be merged (this contact must be associated with the account specified with setaccountid, and setaccountid must be specified). this value is required only when updating an existing contact. signature public void setcontactid(id contactid) parameters contactid type: id 2060apex reference guide leadconvert class return value type: void usage if setcontactid is specified, then the application creates a new contact that is implicitly associated with the account. the contact name and other existing data are not overwritten (unless setoverwriteleadsource is set to true, in which case only the leadsource field is overwritten). important: if you are converting a lead into a person account,
do not specify setcontactid or an error will result. specify only setaccountid of the person account. setconvertedstatus(status) sets the lead status value for a converted lead. this field is required. signature public void setconvertedstatus(string status) parameters status type: string return value type: void setdonotcreateopportunity(createopportunity) specifies whether to create an opportunity during lead conversion. the default value is false: opportunities are created by default. set this flag to true only if you do not want to create an opportunity from the lead. signature public void setdonotcreateopportunity(boolean createopportunity) parameters createopportunity type: boolean return value type: void setleadid(leadid) sets the id of the lead to convert. this field is required. 2061apex reference guide leadconvert class signature public void setleadid(id leadid) parameters leadid type: id return value type: void setopportunityid(opportunityid) sets the id of the opportunity into which the lead is merged. this value is required only when updating an existing opportunity. signature public void setopportunityid(id opportunityid) parameters opportunityid type: id return value type: void setopportunityname(opportunityname) sets the name of the opportunity to create. if no name is specified, this value defaults to the company name of the lead. signature public void setopportunityname(string opportunityname) parameters opportunityname type: string return value type: void usage the maximum length of this field is 80 characters. 2062apex reference guide leadconvert class if setdonotcreateopportunity is true, no opportunity is created and this field must be left blank; otherwise, an error is returned. setoverwriteleadsource(overwriteleadsource) specifies whether to overwrite the leadsource field on the target contact object with the contents of the leadsource field in the source lead object. the default value is false, to not overwrite the field. if you specify this as true, you must also specify setcontactid for the target contact. signature public void setoverwriteleadsource(boolean overwriteleadsource) parameters overwriteleadsource type: boolean return value type: void setownerid(ownerid) specifies the id of the person to own any newly created account, contact, and opportunity. if the application does not specify this value, the owner of the new object will be the owner of the lead. signature public void setownerid(id ownerid) parameters ownerid type: id return value type: void usage this method is not applicable when merging with existing objects—if setownerid is specified, the ownerid field is not overwritten in an existing account or contact. setrelatedpersonaccountid(relatedpersonaccountid) sets the id of the existing person account into which to convert the lead. this value is required only when updating an existing person account. 2063apex reference guide leadconvertresult class signature public void setrelatedpersonaccountid(id relatedpersonaccountid) parameters relatedpersonaccountid type: id return value type: void setrelatedpersonaccountrecord(entity relatedpersonaccountrecord) sets the entity record of the new person account into which to convert the lead. signature public void setrelatedpersonaccountrecord(entity relatedpersonaccountrecord) parameters relatedpersonaccountrecord type: id return value type: void setsendnotificationemail(sendemail) specifies whether to send a notification email to the owner specified by setownerid. the default value is false, that is, to not send email. signature public void setsendnotificationemail(boolean sendemail) parameters sendemail type: boolean return value type: void leadconvertresult class the result of a lead conversion. 2064apex reference guide leadconvertresult class namespace database usage an array of leadconvertresult objects is returned with the convertlead database method. each element in the leadconvertresult array corresponds to the sobject array passed as the sobject[] parameter in the convertlead database method, that is, the first element in the leadconvertresult array matches the first element passed in the sobject array, the second element corresponds to the second element, and so on
. if only one sobject is passed in, the leadconvertresult array contains a single element. leadconvertresult methods the following are methods for leadconvertresult. all are instance methods. in this section: getaccountid() the id of the new account (if a new account was specified) or the id of the account specified when convertlead was invoked. getcontactid() the id of the new contact (if a new contact was specified) or the id of the contact specified when convertlead was invoked. geterrors() if an error occurred, an array of one or more database error objects providing the error code and description. getleadid() the id of the converted lead. getopportunityid() the id of the new opportunity, if one was created when convertlead was invoked. getrelatedpersonaccountid() the id of the new or existing person account specified when convertlead was invoked. issuccess() a boolean value that is set to true if the dml operation was successful for this object, false otherwise getaccountid() the id of the new account (if a new account was specified) or the id of the account specified when convertlead was invoked. signature public id getaccountid() return value type: id getcontactid() the id of the new contact (if a new contact was specified) or the id of the contact specified when convertlead was invoked. 2065apex reference guide leadconvertresult class signature public id getcontactid() return value type: id geterrors() if an error occurred, an array of one or more database error objects providing the error code and description. signature public database.error[] geterrors() return value type: database.error[] getleadid() the id of the converted lead. signature public id getleadid() return value type: id getopportunityid() the id of the new opportunity, if one was created when convertlead was invoked. signature public id getopportunityid() return value type: id getrelatedpersonaccountid() the id of the new or existing person account specified when convertlead was invoked. signature public id getrelatedpersonaccountid() 2066apex reference guide mergeresult class return value type: id issuccess() a boolean value that is set to true if the dml operation was successful for this object, false otherwise signature public boolean issuccess() return value type: boolean mergeresult class contains the result of a merge database method operation. namespace database usage the database.merge method returns a database.mergeresult object for each merged record. mergeresult methods the following are methods for mergeresult. all are instance methods. in this section: geterrors() returns a list of database.error objects representing the errors encountered, if any, during a merge operation using the database.merge method. if no error occurred, returns null. getid() returns the id of the master record into which other records were merged. getmergedrecordids() returns the ids of the records merged into the master record. getupdatedrelatedids() returns the ids of all related records that were reparented as a result of the merge that are viewable by the user sending the merge call. issuccess() indicates whether the merge was successful (true) or not (false). 2067apex reference guide mergeresult class geterrors() returns a list of database.error objects representing the errors encountered, if any, during a merge operation using the database.merge method. if no error occurred, returns null. signature public list<database.error> geterrors() return value type: list<database.error> getid() returns the id of the master record into which other records were merged. signature public id getid() return value type: id getmergedrecordids() returns the ids of the records merged into the master record. signature public list<string> getmergedrecordids() return value type: list<string> getupdatedrelatedids() returns the ids of all related records that were reparented as a result of the merge that are viewable by the user sending the merge call. signature public list<string> getupdatedrelatedids() return value type: list<string> 2068apex reference guide querylocator class issuccess() indicates whether the merge was successful (true) or not (
false). signature public boolean issuccess() return value type: boolean querylocator class represents the record set returned by database.getquerylocator and used with batch apex. namespace database querylocator methods the following are methods for querylocator. all are instance methods. in this section: getquery() returns the query used to instantiate the database.querylocator object. this is useful when testing the start method. iterator() returns a new instance of a query locator iterator. getquery() returns the query used to instantiate the database.querylocator object. this is useful when testing the start method. signature public string getquery() return value type: string usage you can’t use the for update keywords with a getquerylocator query to lock a set of records. the set of records in the batch is determined when the start method is run. 2069apex reference guide querylocatoriterator class example system.assertequals(qlreturnedfromstart. getquery(), database.getquerylocator([select id from account]).getquery() ); iterator() returns a new instance of a query locator iterator. signature public database.querylocatoriterator iterator() return value type: database.querylocatoriterator usage warning: to iterate over a query locator, save the iterator instance that this method returns in a variable and then use this variable to iterate over the collection. calling iterator every time you want to perform an iteration can result in incorrect behavior because each call returns a new iterator instance. for an example, see querylocatoriterator class. querylocatoriterator class represents an iterator over a query locator record set. namespace database example this sample shows how to obtain an iterator for a query locator, which contains five accounts. this sample calls hasnext and next to get each record in the collection. // get a query locator database.querylocator q = database.getquerylocator( [select name from account limit 5]); // get an iterator database.querylocatoriterator it = q.iterator(); // iterate over the records while (it.hasnext()) { account a = (account)it.next(); 2070apex reference guide querylocatoriterator class system.debug(a); } querylocatoriterator methods the following are methods for querylocatoriterator. all are instance methods. in this section: hasnext() returns true if there are one or more records remaining in the collection; otherwise, returns false. next() advances the iterator to the next sobject record and returns the sobject. hasnext() returns true if there are one or more records remaining in the collection; otherwise, returns false. signature public boolean hasnext() return value type: boolean next() advances the iterator to the next sobject record and returns the sobject. signature public sobject next() return value type: sobject usage because the return value is the generic sobject type, you must cast it if using a more specific type. for example: account a = (account)myiterator.next(); example account a = (account)myiterator.next(); 2071apex reference guide saveresult class saveresult class the result of an insert or update dml operation returned by a database method. namespace database usage an array of saveresult objects is returned with the insert and update database methods. each element in the saveresult array corresponds to the sobject array passed as the sobject[] parameter in the database method, that is, the first element in the saveresult array matches the first element passed in the sobject array, the second element corresponds with the second element, and so on. if only one sobject is passed in, the saveresult array contains a single element. a saveresult object is generated when a new or existing salesforce record is saved. example the following example shows how to obtain and iterate through the returned database.saveresult objects. it inserts two accounts using database.insert with a false second parameter to allow partial processing of records on failure. one of the accounts is missing the name required field, which causes a failure. next, it iterates through the results to determine whether the operation was successful or not for each record. it writes the id of every record that was processed successfully to the debug log, or error messages and fields of the failed records. this example generates one successful operation and one failure. // create two accounts, one
of which is missing a required field account[] accts = new list<account>{ new account(name='account1'), new account()}; database.saveresult[] srlist = database.insert(accts, false); // iterate through each returned result for (database.saveresult sr : srlist) { if (sr.issuccess()) { // operation was successful, so get the id of the record that was processed system.debug('successfully inserted account. account id: ' + sr.getid()); } else { // operation failed, so get all errors for(database.error err : sr.geterrors()) { system.debug('the following error has occurred.'); system.debug(err.getstatuscode() + ': ' + err.getmessage()); system.debug('account fields that affected this error: ' + err.getfields()); } } } see also: error class duplicateerror class 2072apex reference guide saveresult class saveresult methods the following are methods for saveresult. all are instance methods. in this section: geterrors() if an error occurred, returns an array of one or more database error objects providing the error code and description. if no error occurred, returns an empty set. getid() returns the id of the sobject you were trying to insert or update. issuccess() returns a boolean that is set to true if the dml operation was successful for this object, false otherwise. geterrors() if an error occurred, returns an array of one or more database error objects providing the error code and description. if no error occurred, returns an empty set. signature public database.error[] geterrors() return value type: database.error[] getid() returns the id of the sobject you were trying to insert or update. signature public id getid() return value type: id versioned behavior changes prior to api version 53.0, the method returned a null value if the record wasn’t updated successfully. in api version 53.0 and later, the method returns the sobject id, regardless of whether the update operation is successful or not. issuccess() returns a boolean that is set to true if the dml operation was successful for this object, false otherwise. 2073apex reference guide undeleteresult class signature public boolean issuccess() return value type: boolean example this example shows the code used to process duplicate records, which are detected when there is an unsuccessful save due to an error. this code is part of a custom application that implements duplicate management when users add a contact. see duplicateresult class on page 2079 to check out the entire sample applicaton. if (!saveresult.issuccess()) { ... } undeleteresult class the result of an undelete dml operation returned by the database.undelete method. namespace database usage an array of database.undeleteresult objects is returned with the undelete database method. each element in the undeleteresult array corresponds to the sobject array passed as the sobject[] parameter in the undelete database method; that is, the first element in the undeleteresult array matches the first element passed in the sobject array, the second element corresponds with the second element, and so on. if only one sobject is passed in, the undeleteresults array contains a single element. undeleteresult methods the following are methods for undeleteresult. all are instance methods. in this section: geterrors() if an error occurred, returns an array of one or more database error objects providing the error code and description. if no error occurred, returns null. getid() returns the id of the sobject you were trying to undelete. issuccess() returns a boolean value that is set to true if the dml operation was successful for this object, false otherwise. geterrors() if an error occurred, returns an array of one or more database error objects providing the error code and description. if no error occurred, returns null. 2074apex reference guide upsertresult class signature public database.error[] geterrors() return value type: database.error[] getid() returns the id of the sobject you were trying to undelete. signature public id getid() return value type: id usage if this field contains a value, the object was successfully undeleted. if this field is empty, the operation was not successful for that object
. issuccess() returns a boolean value that is set to true if the dml operation was successful for this object, false otherwise. signature public boolean issuccess() return value type: boolean upsertresult class the result of an upsert dml operation returned by the database.upsert method. namespace database usage an array of database.upsertresult objects is returned with the upsert database method. each element in the upsertresult array corresponds to the sobject array passed as the sobject[] parameter in the upsert database method; that is, the first element in the upsertresult array matches the first element passed in the sobject array, the second element corresponds with the second element, and so on. if only one sobject is passed in, the upsertresults array contains a single element. 2075apex reference guide upsertresult class upsertresult methods the following are methods for upsertresult. all are instance methods. in this section: geterrors() if an error occurred, returns an array of one or more database error objects providing the error code and description. if no error occurred, returns an empty set. getid() returns the id of the sobject you were trying to update or insert. iscreated() a boolean value that is set to true if the record was created, false if the record was updated. issuccess() returns a boolean value that is set to true if the dml operation was successful for this object, false otherwise. geterrors() if an error occurred, returns an array of one or more database error objects providing the error code and description. if no error occurred, returns an empty set. signature public database.error[] geterrors() return value type: database.error [] getid() returns the id of the sobject you were trying to update or insert. signature public id getid() return value type: id versioned behavior changes prior to api version 53.0, the method returned a null value if the record wasn’t upserted successfully. in api version 53.0 and later, the method returns the sobject id regardless of whether the update operation is successful. iscreated() a boolean value that is set to true if the record was created, false if the record was updated. 2076apex reference guide datacloud namespace signature public boolean iscreated() return value type: boolean issuccess() returns a boolean value that is set to true if the dml operation was successful for this object, false otherwise. signature public boolean issuccess() return value type: boolean datacloud namespace the datacloud namespace provides classes and methods for retrieving information about duplicate rules. duplicate rules let you control whether and when users can save duplicate records within salesforce. the following are the classes in the datacloud namespace. in this section: additionalinformationmap class represents other information, if any, about matched records. duplicateresult class represents the details of a duplicate rule that detected duplicate records and information about those duplicate records. fielddiff class represents the name of a matching rule field and how the values of the field compare for the duplicate and its matching record. findduplicates class performs rule-based searches for duplicate records. the input is an array of sobjects. each sobject represents a record you want to find duplicates of. the output identifies the detected duplicates for each input sobject based on active duplicate rules for the given object. findduplicatesbyids class performs rule-based searches for duplicate records. the input is an array of ids. each id specifies records to search for duplicates among. the duplicates are detected based on the active duplicate rules applicable to the object type corresponding to the input ids. findduplicatesresult class output for rule-based searches for duplicate records. findduplicatesresult contains results of detecting duplicates using instances of findduplicates or findduplicatesbyids classes. matchrecord class represents a duplicate record detected by a matching rule. 2077apex reference guide additionalinformationmap class matchresult class represents the duplicate results for a matching rule. additionalinformationmap class represents other information, if any, about matched records. namespace datacloud in this section: additionalinformationmap methods additionalinformationmap methods the following are methods for additionalinformationmap. in this section: getname() returns the element name. getvalue() returns the value of the element. getname() returns
the element name. signature public string getname() return value type: string getvalue() returns the value of the element. signature public string getvalue() return value type: string 2078apex reference guide duplicateresult class duplicateresult class represents the details of a duplicate rule that detected duplicate records and information about those duplicate records. namespace datacloud usage the duplicateresult class and its methods are available to organizations that use duplicate rules. duplicateresult is contained within duplicateerror, which is part of saveresult. saveresult is generated when a user attempts to save a record in salesforce. example this example shows a custom application that lets users add a contact. when a contact is saved, an alert displays if there are duplicate records. the sample application consists of a visualforce page and an apex controller. the visualforce page is listed first so that you can see how the page makes use of the apex controller. save the apex class first before saving the visualforce page. <apex:page controller="contactdedupecontroller"> <apex:form > <apex:pageblock title="duplicate records" rendered="{!hasduplicateresult}"> <apex:pagemessages /> <apex:pageblocktable value="{!duplicaterecords}" var="item"> <apex:column > <apex:facet name="header">name</apex:facet> <apex:outputlink value="/{!item['id']}">{!item['name']}</apex:outputlink> </apex:column> <apex:column > <apex:facet name="header">owner</apex:facet> <apex:outputfield value="{!item['ownerid']}"/> </apex:column> <apex:column > <apex:facet name="header">last modified date</apex:facet> <apex:outputfield value="{!item['lastmodifieddate']}"/> </apex:column> </apex:pageblocktable> </apex:pageblock> <apex:pageblock title="contact" mode="edit"> <apex:pageblockbuttons > <apex:commandbutton value="save" action="{!save}"/> </apex:pageblockbuttons> <apex:pageblocksection > <apex:inputfield value="{!contact.firstname}"/> <apex:inputfield value="{!contact.lastname}"/> <apex:inputfield value="{!contact.email}"/> <apex:inputfield value="{!contact.phone}"/> 2079apex reference guide duplicateresult class <apex:inputfield value="{!contact.accountid}"/> </apex:pageblocksection> </apex:pageblock> </apex:form> </apex:page> this sample is the apex controller for the page. this controller contains the action method for the save button. the save method inserts the new contact. if errors are returned, this method iterates through each error, checks if it’s a duplicate error, adds the error message to the page, and returns information about the duplicate records to be displayed on the page. public class contactdedupecontroller { // initialize a variable to hold the contact record you're processing private final contact contact; // initialize a list to hold any duplicate records private list<sobject> duplicaterecords; // define variable that’s true if there are duplicate records public boolean hasduplicateresult{get;set;} // define the constructor public contactdedupecontroller() { // define the values for the contact you’re processing based on its id id id = apexpages.currentpage().getparameters().get('id'); this.contact = (id == null) ? new contact() : [select id, firstname, lastname, email, phone, accountid from contact where id = :id]; // initialize empty list of potential duplicate records this.duplicaterecords = new list<sobject>(); this.hasduplicateresult = false; } // return contact and its values to the visualforce page for display public contact getcontact() { return this.contact; } // return duplicate records to the visualforce page for display public list<sobject> getduplicaterecords
() { return this.duplicaterecords; } // process the saved record and handle any duplicates public pagereference save() { // optionally, set dml options here, use “dml” instead of “false” // in the insert() // database.dmloptions dml = new database.dmloptions(); // dml.duplicateruleheader.allowsave = true; // dml.duplicateruleheader.runascurrentuser = true; database.saveresult saveresult = database.insert(contact, false); 2080apex reference guide duplicateresult class if (!saveresult.issuccess()) { for (database.error error : saveresult.geterrors()) { // if there are duplicates, an error occurs // process only duplicates and not other errors // (e.g., validation errors) if (error instanceof database.duplicateerror) { // handle the duplicate error by first casting it as a // duplicateerror class // this lets you use methods of that class // (e.g., getduplicateresult()) database.duplicateerror duplicateerror = (database.duplicateerror)error; datacloud.duplicateresult duplicateresult = duplicateerror.getduplicateresult(); // display duplicate error message as defined in the duplicate rule apexpages.message errormessage = new apexpages.message( apexpages.severity.error, 'duplicate error: ' + duplicateresult.geterrormessage()); apexpages.addmessage(errormessage); // get duplicate records this.duplicaterecords = new list<sobject>(); // return only match results of matching rules that // find duplicate records datacloud.matchresult[] matchresults = duplicateresult.getmatchresults(); // just grab first match result (which contains the // duplicate record found and other match info) datacloud.matchresult matchresult = matchresults[0]; datacloud.matchrecord[] matchrecords = matchresult.getmatchrecords(); // add matched record to the duplicate records variable for (datacloud.matchrecord matchrecord : matchrecords) { system.debug('matchrecord: ' + matchrecord.getrecord()); this.duplicaterecords.add(matchrecord.getrecord()); } this.hasduplicateresult = !this.duplicaterecords.isempty(); } } //if there’s a duplicate record, stay on the page return null; } // after save, navigate to the view page: return (new apexpages.standardcontroller(contact)).view(); } } 2081apex reference guide duplicateresult class in this section: duplicateresult methods see also: saveresult class duplicateerror class duplicateresult methods the following are methods for duplicateresult. in this section: getduplicaterule() returns the developer name of the executed duplicate rule that returned duplicate records. geterrormessage() returns the error message configured by the administrator to warn users they may be creating duplicate records. this message is associated with a duplicate rule. getmatchresults() returns the duplicate records and match information. isallowsave() indicates whether the duplicate rule will allow a record that’s identified as a duplicate to be saved. set to true if duplicate rule should allow save; otherwise, false. getduplicaterule() returns the developer name of the executed duplicate rule that returned duplicate records. signature public string getduplicaterule() return value type: string geterrormessage() returns the error message configured by the administrator to warn users they may be creating duplicate records. this message is associated with a duplicate rule. signature public string geterrormessage() 2082
apex reference guide duplicateresult class return value type: string example this example shows the code used to display the error message when duplicates are found while saving a new contact. this code is part of a custom application that lets users add a contact. when a contact is saved, an alert displays if there are duplicate records. review duplicateresult class on page 2079 to check out the entire sample applicaton. apexpages.message errormessage = new apexpages.message( apexpages.severity.error, 'duplicate error: ' + duplicateresult.geterrormessage()); apexpages.addmessage(errormessage); getmatchresults() returns the duplicate records and match information. signature public list<datacloud.matchresult> getmatchresults() return value type: list<datacloud.matchresult> example this example shows the code used to return duplicate record and match information and assign it to the matchresults variable. this code is part of a custom application that implements duplicate management when users add a contact. see duplicateresult class on page 2079 to check out the entire sample applicaton. datacloud.matchresult[] matchresults = duplicateresult.getmatchresults(); isallowsave() indicates whether the duplicate rule will allow a record that’s identified as a duplicate to be saved. set to true if duplicate rule should allow save; otherwise, false. signature public boolean isallowsave() return value type: boolean 2083apex reference guide fielddiff class fielddiff class represents the name of a matching rule field and how the values of the field compare for the duplicate and its matching record. namespace datacloud in this section: fielddiff methods fielddiff methods the following are methods for fielddiff. in this section: getdifference() returns how the field values compare for the duplicate and its matching record. getname() returns the name of a field on a matching rule that detected duplicates. getdifference() returns how the field values compare for the duplicate and its matching record. signature public string getdifference() return value type: string possible values include: • same: indicates the field values match exactly. • different: indicates that the field values do not match. • null: indicates that the field values are a match because both values are blank. getname() returns the name of a field on a matching rule that detected duplicates. signature public string getname() 2084apex reference guide findduplicates class return value type: string findduplicates class performs rule-based searches for duplicate records. the input is an array of sobjects. each sobject represents a record you want to find duplicates of. the output identifies the detected duplicates for each input sobject based on active duplicate rules for the given object. namespace datacloud in this section: findduplicates methods findduplicates methods the following are methods for findduplicates. in this section: findduplicates(sobjects) identifies duplicates for sobjects provided and returns a list of findduplicatesresult objects. findduplicates(sobjects) identifies duplicates for sobjects provided and returns a list of findduplicatesresult objects. usage use findduplicates to apply active duplicate rules associated with an object to records represented by input sobjects. findduplicates uses the duplicate rules for the object that has the same type as the input sobjects. input • all sobjects in the input array must be of the same object type, and that type must correspond to an object type that supports duplicate rules. • the input array is limited to 50 elements. if you exceed this limit, an exception is thrown with the following message: configuration error: the number of records to check is greater than the permitted batch size. output • the output of findduplicates is an array of objects with the same number of elements as the input array, and in the same order. the output objects encapsulate record ids for duplicate records. the output objects also contain values from the duplicate records. • each element contains an array of duplicateresult objects. if findduplicates doesn’t find any duplicates, the duplicaterule field in duplicateresult contains the name of the duplicate rule that findduplicates applied, but the matchresults array is empty. 2085apex reference guide findduplicatesbyids
class example account acct = new account(); acct.name = 'acme'; acct.billingstreet = '123 fake st'; acct.billingcity = 'springfield'; acct.billingstate = 'vt'; acct.billingcountry = 'us'; list<account> acctlist = new list<account>(); acctlist.add(acct); if (datacloud.findduplicates.findduplicates(acctlist).size() == 0) { // if the new account doesn't have duplicates, insert it. insert(acct); } signature public static list<datacloud.findduplicatesresult> findduplicates(list<sobject> sobjects) parameters sobjects type: list<sobject> an array of sobjects for which you want to find duplicates. return value type: list<findduplicatesresult> findduplicatesbyids class performs rule-based searches for duplicate records. the input is an array of ids. each id specifies records to search for duplicates among. the duplicates are detected based on the active duplicate rules applicable to the object type corresponding to the input ids. namespace datacloud in this section: findduplicatesbyids methods findduplicatesbyids methods the following are methods for findduplicatesbyids. 2086apex reference guide findduplicatesbyids class in this section: findduplicatesbyids(ids) identifies duplicates of sobjects provided and returns a list of findduplicatesresult objects. findduplicatesbyids(ids) identifies duplicates of sobjects provided and returns a list of findduplicatesresult objects. usage use findduplicatesbyids to apply active duplicate rules associated with an object to records represented by the record ids. findduplicatesbyids uses the duplicate rules for the object that has the same type as the input record ids. for example, if the record id represents an account, findduplicatesbyids uses the duplicate rules associated with the account object. input • all record ids in the input array must be of the same object type, and that type must correspond to an object type that supports duplicate rules. • the input array is limited to 50 elements. if you exceed this limit, an exception is thrown with the following message: configuration error: the number of records to check is greater than the permitted batch size. output • the output of findduplicatesbyids is an array of objects with the same number of elements as the input array, and in the same order. the output objects encapsulate record ids for duplicate records. the output objects also contain values from the duplicate records. • each element contains an array of duplicateresult objects. if findduplicatesbyids doesn’t find any duplicates, the duplicaterule field in duplicateresult contains the name of the duplicate rule that findduplicatesbyids applied, but the matchresults array is empty. example account acct = new account(name='salesforce'); insert acct; list<id> idlist = new list<id>(); idlist.add(acct.id); if (datacloud.findduplicatesbyids.findduplicatesbyids(idlist).size() > 0) { system.debug('found duplicates'); } signature public static list<datacloud.findduplicatesresult> findduplicatesbyids(list<id> ids) parameters ids type: listid> 2087apex reference guide findduplicatesresult class a list of ids for which you want to find duplicates. return value type: list<findduplicatesresult> findduplicatesresult class output for rule-based searches for duplicate records. findduplicatesresult contains results of detecting duplicates using instances of findduplicates or findduplicatesbyids classes. namespace datacloud in this section: findduplicatesresult properties findduplicatesresult methods findduplicatesresult properties the following are properties for findduplicatesresult. in this section: duplicateresults a list of duplicateresult objects representing the results of calling findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids). elements in the list correspond to sobjects or ids in the input list. errors a
list of database.error objects holding errors resulting from calling findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids). success boolean signifying whether the call to findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids) was successful. duplicateresults a list of duplicateresult objects representing the results of calling findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids). elements in the list correspond to sobjects or ids in the input list. signature public list<datacloud.duplicateresult> duplicateresults 2088apex reference guide findduplicatesresult class property value type: list<duplicateresult> errors a list of database.error objects holding errors resulting from calling findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids). signature public list<database.error> errors {get; set;} property value type: list<database.error> success boolean signifying whether the call to findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids) was successful. signature public boolean success {get; set;} property value type: boolean findduplicatesresult methods the following are methods for findduplicatesresult. in this section: getduplicateresults() returns a list of duplicateresult objects representing the results of calling findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids). elements in the list correspond to sobjects or ids in the input list. geterrors() returns a list of databaseerror objects containing errors resulting from calling findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids), if errors were encountered. issuccess() returns a boolean signifying whether the call to findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids) was successful. 2089apex reference guide findduplicatesresult class getduplicateresults() returns a list of duplicateresult objects representing the results of calling findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids). elements in the list correspond to sobjects or ids in the input list. example account acct = new account(name='salesforce'); list<account> acctlist = new list<account>(); acctlist.add(acct); datacloud.findduplicatesresult[] results = datacloud.findduplicates.findduplicates(acctlist); for (datacloud.findduplicatesresult findduperesult : results) { for (datacloud.duplicateresult duperesult : findduperesult.getduplicateresults()) { for (datacloud.matchresult matchresult : duperesult.getmatchresults()) { for (datacloud.matchrecord matchrecord : matchresult.getmatchrecords()) { system.debug('duplicate record: ' + matchrecord.getrecord()); } } } } signature public list<datacloud.duplicateresult> getduplicateresults() return value type: list<duplicateresult> geterrors() returns a list of databaseerror objects containing errors resulting from calling findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids), if errors were encountered. signature public list<database.error> geterrors() return value type: list<database.error> issuccess() returns a boolean signifying whether the call to findduplicates.findduplicates(sobjects) or findduplicatesbyids.findduplicatesbyids(ids) was successful. 2090apex reference guide matchrecord class signature public boolean issuccess() return value type: boolean matchrecord class represents a duplicate record detected by a matching rule. namespace
datacloud in this section: matchrecord methods matchrecord methods the following are methods for matchrecord. in this section: getadditionalinformation() returns other information about a matched record. for example, a matchgrade represents the quality of the data for the d&b fields in the matched record. getfielddiffs() returns all matching rule fields and how each field value compares for the duplicate and its matching record. getmatchconfidence() returns the ranking of how similar a matched record’s data is to the data in your request. must be equal to or greater than the value of the minmatchconfidence specified in your request. returns -1 if unused. getrecord() returns the fields and field values for the duplicate. getadditionalinformation() returns other information about a matched record. for example, a matchgrade represents the quality of the data for the d&b fields in the matched record. signature public list<datacloud.additionalinformationmap> getadditionalinformation() return value type: list<datacloud.additionalinformationmap> 2091apex reference guide matchresult class getfielddiffs() returns all matching rule fields and how each field value compares for the duplicate and its matching record. signature public list<datacloud.fielddiff> getfielddiffs() return value type: list<datacloud.fielddiff> getmatchconfidence() returns the ranking of how similar a matched record’s data is to the data in your request. must be equal to or greater than the value of the minmatchconfidence specified in your request. returns -1 if unused. signature public double getmatchconfidence() return value type: double getrecord() returns the fields and field values for the duplicate. signature public sobject getrecord() return value type: sobject matchresult class represents the duplicate results for a matching rule. namespace datacloud in this section: matchresult methods 2092apex reference guide matchresult class matchresult methods the following are methods for matchresult. in this section: getentitytype() returns the entity type of the matching rule. geterrors() returns errors that occurred during matching for the matching rule. getmatchengine() returns the match engine for the matching rule. getmatchrecords() returns information about the duplicates for the matching rule. getrule() returns the developer name of the matching rule. getsize() returns the number of duplicates detected by the matching rule. issuccess() returns false if there’s an error with the matching rule, and true if the matching rule successfully ran. getentitytype() returns the entity type of the matching rule. signature public string getentitytype() return value type: string geterrors() returns errors that occurred during matching for the matching rule. signature public list<database.error> geterrors() return value type: list<database.error> getmatchengine() returns the match engine for the matching rule. 2093apex reference guide matchresult class signature public string getmatchengine() return value type: string getmatchrecords() returns information about the duplicates for the matching rule. signature public list<datacloud.matchrecord> getmatchrecords() return value type: list<datacloud.matchrecord> getrule() returns the developer name of the matching rule. signature public string getrule() return value type: string getsize() returns the number of duplicates detected by the matching rule. signature public integer getsize() return value type: integer issuccess() returns false if there’s an error with the matching rule, and true if the matching rule successfully ran. signature public boolean issuccess() 2094apex reference guide datasource namespace return value type: boolean datasource namespace the datasource namespace provides the classes for the apex connector framework. use the apex connector framework to develop a custom adapter for salesforce connect. then connect your salesforce organization to any data anywhere via the salesforce connect custom adapter. the following are the classes in the datasource namespace. in this section: asyncdeletecallback class a callback class that the database.deleteasync method references. salesforce calls this class after the remote deleteasync operation is completed. this class provides the compensating transaction in the completion context of the delete operation. extend this class to define the actions to execute after the remote delete operation finishes execution.
asyncsavecallback class a callback class that the database.insertasync or database.updateasync method references. salesforce calls this class after the remote operation is completed. this class provides the compensating transaction in the completion context of the insert or update operation. extend this class to define the actions to execute after the remote insert or update operation finishes execution. authenticationcapability enum specifies the types of authentication that can be used to access the external system. authenticationprotocol enum determines what type of credentials are used to authenticate to the external system. capability enum declares which functional operations the external system supports. also specifies required endpoint settings for the external data source definition. column class describes a column on a datasource.table. this class extends the datasourceutil class and inherits its methods. columnselection class identifies the list of columns to return during a query or search. connection class extend this class to enable your salesforce org to sync the external system’s schema and to handle queries, searches, and write operations (upsert and delete) of the external data. this class extends the datasourceutil class and inherits its methods. connectionparams class contains the credentials for authenticating to the external system. datasourceutil class parent class for the datasource.provider, datasource.connection, datasource.table, and datasource.column classes. datatype enum specifies the data types that are supported by the apex connector framework. 2095apex reference guide datasource namespace deletecontext class an instance of deletecontext is passed to the deleterows() method on your database.connection class. the class provides context information about the delete request to the implementor of deleterows(). deleteresult class represents the result of a delete operation on an sobject record. the result is returned by the datasource.deleterows method of the datasource.connection class. filter class represents a where clause in a sosl or soql query. filtertype enum referenced by the type property on a datasource.filter. identitytype enum determines which set of credentials is used to authenticate to the external system. order class contains details about how to sort the rows in the result set. equivalent to an order by statement in a soql query. orderdirection enum specifies the direction for sorting rows based on column values. provider class extend this base class to create a custom adapter for salesforce connect. the class informs salesforce of the functional and authentication capabilities that are supported by or required to connect to the external system. this class extends the datasourceutil class and inherits its methods. queryaggregation enum specifies how to aggregate a column in a query. querycontext class an instance of querycontext is provided to the query method on your datasource.connection class. the instance corresponds to a soql request. queryutils class contains helper methods to locally filter, sort, and apply limit and offset clauses to data rows. this helper class is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. readcontext class abstract base class for the querycontext and searchcontext classes. searchcontext class an instance of searchcontext is provided to the search method on your datasource.connection class. the instance corresponds to a search or sosl request. searchutils class helper class for implementing search on a custom adapter for salesforce connect. table class describes a table on an external system that the salesforce connect custom adapter connects to. this class extends the datasourceutil class and inherits its methods. tableresult class contains the results of a search or query. 2096apex reference guide asyncdeletecallback class tableselection class contains a breakdown of the soql or sosl query. its properties represent the from, order by, select, and where clauses in the query. upsertcontext class an instance of upsertcontext is passed to the upsertrows() method on your datasource.connection class. this class provides context information about the upsert request to the implementor of upsertrows(). upsertresult class represents the result of an upsert operation on an external object record. the result is returned by the upsertrows method of the datasource.connection class. datasource exceptions the datasource namespace contains exception classes. asyncdeletecallback class a callback class that the database.deleteasync method references. sales
force calls this class after the remote deleteasync operation is completed. this class provides the compensating transaction in the completion context of the delete operation. extend this class to define the actions to execute after the remote delete operation finishes execution. namespace datasource in this section: asyncdeletecallback methods asyncdeletecallback methods the following are methods for asyncdeletecallback. in this section: processdelete(deleteresult) override this method to define actions that salesforce executes after a remote database.deleteasync operation is completed. for example, based on the results of the remote operation, you can update custom object data or other data that's stored in the salesforce org.. processdelete(deleteresult) override this method to define actions that salesforce executes after a remote database.deleteasync operation is completed. for example, based on the results of the remote operation, you can update custom object data or other data that's stored in the salesforce org.. signature public void processdelete(database.deleteresult deleteresult) 2097apex reference guide asyncsavecallback class parameters deleteresult type: database.deleteresult the result of the asynchronous delete operation. return value type: void asyncsavecallback class a callback class that the database.insertasync or database.updateasync method references. salesforce calls this class after the remote operation is completed. this class provides the compensating transaction in the completion context of the insert or update operation. extend this class to define the actions to execute after the remote insert or update operation finishes execution. namespace datasource in this section: asyncsavecallback methods asyncsavecallback methods the following are methods for asyncsavecallback. in this section: processsave(saveresult) override this method to define actions that salesforce executes after the remote database.insertasync or database.updateasync operation is completed. for example, based on the results of the remote operation, you can update custom object data or other data that's stored in the salesforce org. processsave(saveresult) override this method to define actions that salesforce executes after the remote database.insertasync or database.updateasync operation is completed. for example, based on the results of the remote operation, you can update custom object data or other data that's stored in the salesforce org. signature public void processsave(database.saveresult saveresult) parameters saveresult type: database.saveresult 2098apex reference guide authenticationcapability enum the result of the asynchronous insert or update operation. return value type: void authenticationcapability enum specifies the types of authentication that can be used to access the external system. usage the datasource.provider class returns datasource.authenticationcapability enum values. the returned values determine which authentication settings are available on the external data source definition in salesforce. if you set up callouts in your datasource.connection class, you can specify the callout endpoints as named credentials instead of urls. if you do so for all callouts, return anonymous as the sole entry in the list of data source authentication capabilities. that way, the external data source definition doesn’t require authentication settings. salesforce manages all authentication for apex callouts that specify a named credential as the callout endpoint so that your code doesn’t have to. enum values the following are the values of the datasource.authenticationcapability enum. value description anonymous no credentials are required to authenticate to the external system. basic a username and password can be used to authenticate to the external system. certificate a security certificate can be supplied when establishing each connection to the external system. oauth oauth can be used to authenticate to the external system. authenticationprotocol enum determines what type of credentials are used to authenticate to the external system. enum values the following are the values of the datasource.authenticationprotocol enum. value description none no credentials are used to authenticate to the external system. oauth oauth 2.0 is used to authenticate to the external system. password a username and password are used to authenticate to the external system. 2099apex reference guide capability enum capability enum declares which functional operations the external system supports. also specifies required endpoint settings for the external data source definition. usage the datasource.provider class returns datasource.capability enum values, which: • specify the functional capabilities of the external system. • determine which endpoint settings are available on the external data source definition in salesforce.
enum values the following are the values of the datasource.capability enum. value description query_pagination_server_driven with server-driven paging, the external system determines the page sizes and batch boundaries. the external system’s paging settings can optimize the external system’s performance and improve the load times for external objects in your org. also, the external data set can change while your users or the lightning platform are paging through the result set. typically, server-driven paging adjusts batch boundaries to accommodate changing data sets more effectively than client-driven paging. if you enable server-driven paging on an external data source, salesforce ignores the requested page sizes, including the default querymore() batch size of 500 rows. the pages returned by the external system determine the batches, but each page can’t exceed 2,000 rows. also, the apex code must generate a query token and use it to determine and fetch the next batch of results. query_total_size the external system can provide the total number of rows that meet the query criteria, even when requested to return a smaller batch size. this capability enables you to simplify how you paginate results by using querymore(). require_endpoint requires the administrator to specify the endpoint in the url field in the external data source definition. require_https requires the endpoint url to use secure http. if require_endpoint isn’t declared, require_https is ignored. row_create allows creating of external data. row_delete allows deleting external data. row_query allows api and soql queries of the external data. also allows reports on the external objects. row_update allows updating external data. search allows sosl and salesforce searches of the external data. when the custom adapter declares the search capability, you can control which external objects are searchable by selecting or deselecting allow search on each 2100apex reference guide column class value description external object. however, syncing always overwrites the external object’s search status to match the search status of the external data source. only text, text area, and long text area fields on external objects can be searched. if an external object has no searchable fields, searches on that object return no records. see also: salesforce help: validate and sync an external data source column class describes a column on a datasource.table. this class extends the datasourceutil class and inherits its methods. namespace datasource usage a list of column metadata is provided by the datasource.connection class when the sync() method is invoked. each column can become a field on an external object. the metadata is stored in salesforce. updating the apex code to return new or updated values for the column metadata doesn’t automatically update the stored metadata in salesforce. in this section: column properties column methods column properties the following are properties for column. in this section: decimalplaces if the data type is numeric, the number of decimal places to the right of the decimal point. description description of what the column represents. filterable whether a result set can be filtered based on the values of the column. label user-friendly name for the column that appears in the salesforce user interface. 2101apex reference guide column class length if the column is a string data type, the number of characters in the column. if the column is a numeric data type, the total number of digits on both sides of the decimal point, but excluding the decimal point. name name of the column in the external system. referencetargetfield api name of the custom field on the parent object whose values are compared against this column’s values. matching values identify related records in an indirect lookup relationship. applies only when the column’s data type is indirect_lookup_type. for other data types, this value is ignored. referenceto api name of the parent object in the relationship that’s represented by this column. applies only when the column’s data type is lookup_type, external_lookup_type, or indirect_lookup_type. for other data types, this value is ignored. sortable whether a result set can be sorted based on the values of the column via an order by clause. type data type of the column. decimalplaces if the data type is
numeric, the number of decimal places to the right of the decimal point. signature public integer decimalplaces {get; set;} property value type: integer description description of what the column represents. signature public string description {get; set;} property value type: string filterable whether a result set can be filtered based on the values of the column. signature public boolean filterable {get; set;} 2102apex reference guide column class property value type: boolean label user-friendly name for the column that appears in the salesforce user interface. signature public string label {get; set;} property value type: string length if the column is a string data type, the number of characters in the column. if the column is a numeric data type, the total number of digits on both sides of the decimal point, but excluding the decimal point. signature public integer length {get; set;} property value type: integer name name of the column in the external system. signature public string name {get; set;} property value type: string referencetargetfield api name of the custom field on the parent object whose values are compared against this column’s values. matching values identify related records in an indirect lookup relationship. applies only when the column’s data type is indirect_lookup_type. for other data types, this value is ignored. signature public string referencetargetfield {get; set;} 2103apex reference guide column class property value type: string referenceto api name of the parent object in the relationship that’s represented by this column. applies only when the column’s data type is lookup_type, external_lookup_type, or indirect_lookup_type. for other data types, this value is ignored. signature public string referenceto {get; set;} property value type: string sortable whether a result set can be sorted based on the values of the column via an order by clause. signature public boolean sortable {get; set;} property value type: boolean type data type of the column. signature public datasource.datatype type {get; set;} property value type: datasource.datatype column methods the following are methods for column. in this section: boolean(name) returns a new column of data type boolean_type. externallookup(name, domain) returns a new column of data type external_lookup_type. 2104apex reference guide column class get(name, label, description, issortable, isfilterable, type, length, decimalplaces, referenceto, referencetargetfield) returns a new column with the ten specified column property values. get(name, label, description, issortable, isfilterable, type, length, decimalplaces) returns a new column with the eight specified column property values. get(name, label, description, issortable, isfilterable, type, length) returns a new column with the seven specified column property values. indirectlookup(name, domain, targetfield) returns a new column of data type indirect_lookup_type. integer(name, length) returns a new numeric column with no decimal places using the specified name and length. lookup(name, domain) returns a new column of data type lookup_type. number(name, length, decimalplaces) returns a new column of data type number_type. text(name, label, length) returns a new column of data type string_short_type or string_long_type, with the specified name, label, and length. text(name, length) returns a new column of data type string_short_type or string_long_type, with the specified name and length. text(name) returns a new column of data type string_short_type with the specified name and the length of 255 characters. textarea(name) returns a new column of data type string_long_type with the specified name and the length of 32,000 characters. url(name, length) returns a new column of data type url_type with the specified name and length. url(name) returns a new column of data type url_type with the specified name and the length of 1,000 characters. boolean(name)
returns a new column of data type boolean_type. signature public static datasource.column boolean(string name) parameters name type: string name of the column. 2105apex reference guide column class return value type: datasource.column externallookup(name, domain) returns a new column of data type external_lookup_type. signature public static datasource.column externallookup(string name, string domain) parameters name type: string name of the column. domain type: string api name of the parent object in the external lookup relationship. return value type: datasource.column the returned column has these property values. property value name name label name description name issortable true isfilterable true type datasource.datatype.external_lookup_type length 255 decimalplaces 0 referenceto domain referencetargetfield null get(name, label, description, issortable, isfilterable, type, length, decimalplaces, referenceto, referencetargetfield) returns a new column with the ten specified column property values. 2106apex reference guide column class signature public static datasource.column get(string name, string label, string description, boolean issortable, boolean isfilterable, datasource.datatype type, integer length, integer decimalplaces, string referenceto, string referencetargetfield) parameters see column properties on page 2101 for information about each parameter. name type: string label type: string description type: string issortable type: boolean isfilterable type: boolean type type: datasource.datatype length type: integer decimalplaces type: integer referenceto type: string referencetargetfield type: string return value type: datasource.column get(name, label, description, issortable, isfilterable, type, length, decimalplaces) returns a new column with the eight specified column property values. signature public static datasource.column get(string name, string label, string description, boolean issortable, boolean isfilterable, datasource.datatype type, integer length, integer decimalplaces) 2107apex reference guide column class parameters see column properties on page 2101 for information about each parameter. name type: string label type: string description type: string issortable type: boolean isfilterable type: boolean type type: datasource.datatype length type: integer decimalplaces type: integer return value type: datasource.column get(name, label, description, issortable, isfilterable, type, length) returns a new column with the seven specified column property values. signature public static datasource.column get(string name, string label, string description, boolean issortable, boolean isfilterable, datasource.datatype type, integer length) parameters see column properties on page 2101 for information about each parameter. name type: string label type: string description type: string issortable type: boolean isfilterable type: boolean 2108apex reference guide column class type type: datasource.datatype length type: integer return value type: datasource.column indirectlookup(name, domain, targetfield) returns a new column of data type indirect_lookup_type. signature public static datasource.column indirectlookup(string name, string domain, string targetfield) parameters name type: string name of the column. domain type: string api name of the parent object in the indirect lookup relationship. targetfield type: string api name of the custom field on the parent object whose values are compared against this column’s values. matching values identify related records in an indirect lookup relationship. return value type: datasource.column the returned column has these property values. property value name name label name description name issortable true isfilterable true type datasource.datatype.indirect_lookup_type 2109apex reference guide column class property value length 255 decimalplaces 0 referenceto domain referencetargetfield targetfield integer(name, length) returns a new numeric column with no decimal places using the specified name and length. sign
ature public static datasource.column integer(string name, integer length) parameters name type: string the column name. length type: integer the column length. return value type: datasource.column lookup(name, domain) returns a new column of data type lookup_type. signature public static datasource.column lookup(string name, string domain) parameters name type: string name of the column. domain type: string api name of the parent object in the lookup relationship. 2110apex reference guide column class return value type: datasource.column the returned column has these property values. property value name name label name description name issortable true isfilterable true type datasource.datatype.lookup_type length 255 decimalplaces 0 referenceto domain referencetargetfield null number(name, length, decimalplaces) returns a new column of data type number_type. signature public static datasource.column number(string name, integer length, integer decimalplaces) parameters see column properties on page 2101 for information about each parameter. name type: string length type: integer decimalplaces type: integer return value type: datasource.column the returned column has these property values. 2111apex reference guide column class property value name name label name description name issortable true isfilterable true type datasource.datatype.number_type length length decimalplaces decimalplaces text(name, label, length) returns a new column of data type string_short_type or string_long_type, with the specified name, label, and length. signature public static datasource.column text(string name, string label, integer length) parameters name type: string name of the column. label type: string user-friendly name for the column that appears in the salesforce user interface. length type: integer number of characters allowed in the column. return value type: datasource.column the returned column has these property values. property value name name label label description label issortable true 2112apex reference guide column class property value isfilterable true type datasource.datatype.string_short_type if length is 255 or less datasource.datatype.string_long_type if length is greater than 255 length length decimalplaces 0 text(name, length) returns a new column of data type string_short_type or string_long_type, with the specified name and length. signature public static datasource.column text(string name, integer length) parameters name type: string name of the column. length type: integer number of characters allowed in the column. return value type: datasource.column the returned column has these property values. property value name name label name description name issortable true isfilterable true type datasource.datatype.string_short_type if length is 255 or less datasource.datatype.string_long_type if length is greater than 255 length length 2113apex reference guide column class property value decimalplaces 0 text(name) returns a new column of data type string_short_type with the specified name and the length of 255 characters. signature public static datasource.column text(string name) parameters name type: string name of the column. return value type: datasource.column the returned column has these property values. property value name name label name description name issortable true isfilterable true type datasource.datatype.string_short_type length 255 decimalplaces 0 textarea(name) returns a new column of data type string_long_type with the specified name and the length of 32,000 characters. signature public static datasource.column textarea(string name) 2114apex reference guide column class parameters name type: string name of the column. return value type: datasource.column the returned column has these property values. property value name name label name description name issortable true isfilterable true type datasource.datatype.string_long_type
length 32000 decimalplaces 0 url(name, length) returns a new column of data type url_type with the specified name and length. signature public static datasource.column url(string name, integer length) parameters name type: string name of the column. length type: integer number of characters allowed in the column. return value type: datasource.column the returned column has these property values. 2115apex reference guide column class property value name name label name description name issortable true isfilterable true type datasource.datatype.url_type length length decimalplaces 0 url(name) returns a new column of data type url_type with the specified name and the length of 1,000 characters. signature public static datasource.column url(string name) parameters name type: string name of the column. return value type: datasource.column the returned column has these property values. property value name name label name description name issortable true isfilterable true type datasource.datatype.url_type length 1000 decimalplaces 0 2116apex reference guide columnselection class columnselection class identifies the list of columns to return during a query or search. namespace datasource namespace usage this class is associated with the select clause for a soql query, or the returning clause for a sosl query. in this section: columnselection properties columnselection properties the following are properties for columnselection. in this section: aggregation how to aggregate the column’s data. columnname name of the selected column. tablename name of the column’s table. aggregation how to aggregate the column’s data. signature public datasource.queryaggregation aggregation {get; set;} property value type: datasource.queryaggregation columnname name of the selected column. signature public string columnname {get; set;} 2117apex reference guide connection class property value type: string tablename name of the column’s table. signature public string tablename {get; set;} property value type: string connection class extend this class to enable your salesforce org to sync the external system’s schema and to handle queries, searches, and write operations (upsert and delete) of the external data. this class extends the datasourceutil class and inherits its methods. namespace datasource usage your datasource.connection and datasource.provider classes compose a custom adapter for salesforce connect. changing the sync method on the datasource.connection class doesn’t automatically resync any external objects. example global class sampledatasourceconnection extends datasource.connection { global sampledatasourceconnection(datasource.connectionparams connectionparams) { } override global list<datasource.table> sync() { list<datasource.table> tables = new list<datasource.table>(); list<datasource.column> columns; columns = new list<datasource.column>(); columns.add(datasource.column.text('name', 255)); columns.add(datasource.column.text('externalid', 255)); columns.add(datasource.column.url('displayurl')); tables.add(datasource.table.get('sample', 'title', columns)); return tables; } override global datasource.tableresult query(datasource.querycontext c) { return datasource.tableresult.get(c, datasource.queryutils.process(c, getrows())); } 2118apex reference guide connection class override global list<datasource.tableresult> search(datasource.searchcontext c) { list<datasource.tableresult> results = new list<datasource.tableresult>(); for (datasource.tableselection tableselection : c.tableselections) { results.add(datasource.tableresult.get(tableselection, getrows())); } return results; } // helper method to get record values from the external system for the sample table. private list<map<string, object>> getrows () { // get row field values for the sample table from the external system via a callout. httpresponse response = makegetcallout(); // parse the json response and populate
the rows. map<string, object> m = (map<string, object>)json.deserializeuntyped( response.getbody()); map<string, object> error = (map<string, object>)m.get('error'); if (error != null) { throwexception(string.valueof(error.get('message'))); } list<map<string,object>> rows = new list<map<string,object>>(); list<object> jsonrows = (list<object>)m.get('value'); if (jsonrows == null) { rows.add(foundrow(m)); } else { for (object jsonrow : jsonrows) { map<string,object> row = (map<string,object>)jsonrow; rows.add(foundrow(row)); } } return rows; } global override list<datasource.upsertresult> upsertrows(datasource.upsertcontext context) { if (context.tableselected == 'sample') { list<datasource.upsertresult> results = new list<datasource.upsertresult>(); list<map<string, object>> rows = context.rows; for (map<string, object> row : rows){ // make a callout to insert or update records in the external system. httpresponse response; // determine whether to insert or update a record. if (row.get('externalid') == null){ // send a post http request to insert new external record. // make an apex callout and get httpresponse. response = makepostcallout( '{"name":"' + row.get('name') + '","externalid":"' + row.get('externalid') + '"'); } else { // send a put http request to update an existing external record. 2119apex reference guide connection class // make an apex callout and get httpresponse. response = makeputcallout( '{"name":"' + row.get('name') + '","externalid":"' + row.get('externalid') + '"', string.valueof(row.get('externalid'))); } // check the returned response. // first, deserialize it. map<string, object> m = (map<string, object>)json.deserializeuntyped( response.getbody()); if (response.getstatuscode() == 200){ results.add(datasource.upsertresult.success( string.valueof(m.get('id')))); } else { results.add(datasource.upsertresult.failure( string.valueof(m.get('id')), 'the callout resulted in an error: ' + response.getstatuscode())); } } return results; } return null; } global override list<datasource.deleteresult> deleterows(datasource.deletecontext context) { if (context.tableselected == 'sample'){ list<datasource.deleteresult> results = new list<datasource.deleteresult>(); for (string externalid : context.externalids){ httpresponse response = makedeletecallout(externalid); if (response.getstatuscode() == 200){ results.add(datasource.deleteresult.success(externalid)); } else { results.add(datasource.deleteresult.failure(externalid, 'callout delete error:' + response.getbody())); } } return results; } return null; } // helper methods // make a get callout private static httpresponse makegetcallout() { httpresponse response; // make callout // ... 2120apex reference guide connection class return response; } // populate a row based on values from the external system. private map<string,object> foundrow(map<string,object> foundrow) { map<string,object> row = new map<string,object>(); row.put('externalid', string.valueof(foundrow.get('id'))); row.put('displayurl', string.valueof(foundrow.get('displayurl'))); row.put('name', string.valueof(foundrow.get('name'))); return row; } // make a post callout private static httpresponse makepostcallout(
string jsonbody) { httpresponse response; // make callout // ... return response; } // make a put callout private static httpresponse makeputcallout(string jsonbody, string externalid) { httpresponse response; // make callout // ... return response; } // make a delete callout private static httpresponse makedeletecallout(string externalid) { httpresponse response; // make callout // ... return response; } } in this section: connection methods connection methods the following are methods for connection. in this section: deleterows(deletecontext) invoked when external object records are deleted via the salesforce user interface, apis, or apex. query(querycontext) invoked by a soql query of an external object. a soql query is generated and executed when a user visits an external object’s list view or record detail page in salesforce. returns the results of the query. 2121apex reference guide connection class search(searchcontext) invoked by a sosl query of an external object or when a user performs a salesforce global search that also searches external objects. returns the results of the query. sync() invoked when an administrator clicks validate and sync on the external data source detail page. returns a list of tables that describe the external system’s schema. upsertrows(upsertcontext) invoked when external object records are created or updated via the salesforce user interface, apis, or apex. deleterows(deletecontext) invoked when external object records are deleted via the salesforce user interface, apis, or apex. signature public list<datasource.deleteresult> deleterows(datasource.deletecontext deletecontext) parameters deletecontext type: datasource.deletecontext contains context information about the delete request. return value type: list<datasource.deleteresult> the results of the delete operation. query(querycontext) invoked by a soql query of an external object. a soql query is generated and executed when a user visits an external object’s list view or record detail page in salesforce. returns the results of the query. signature public datasource.tableresult query(datasource.querycontext querycontext) parameters querycontext type: datasource.querycontext represents the query to run against a data table. return value type: datasource.tableresult 2122apex reference guide connection class search(searchcontext) invoked by a sosl query of an external object or when a user performs a salesforce global search that also searches external objects. returns the results of the query. signature public list<datasource.tableresult> search(datasource.searchcontext searchcontext) parameters searchcontext type: datasource.searchcontext represents the query to run against an external data table. return value type: list<datasource.tableresult> sync() invoked when an administrator clicks validate and sync on the external data source detail page. returns a list of tables that describe the external system’s schema. signature public list<datasource.table> sync() return value type: list<datasource.table> each returned table can be used to create an external object in salesforce. on the validate external data source page, the administrator views the list of returned tables and selects which tables to sync. when the administrator clicks sync, an external object is created for each selected table. each column within the selected tables also becomes a field in the external object. upsertrows(upsertcontext) invoked when external object records are created or updated via the salesforce user interface, apis, or apex. signature public list<datasource.upsertresult> upsertrows(datasource.upsertcontext upsertcontext) parameters upsertcontext type: datasource.upsertcontext contains context information about the upsert request. 2123apex reference guide connectionparams class return value type: list<datasource.upsertresult> the results of the upsert operation. connectionparams class contains the credentials for authenticating to the external system. namespace datasource usage if your extension of the datasource.provider class returns datasource.authenticationcapability values that indicate support for authentication, the datasource.connection class is instantiated with a datasource.connectionparams instance in the constructor. the authentication credentials in the datasource.connectionpar
ams instance depend on the identity type field of the external data source definition in salesforce. • if identity type is set to named principal, the credentials come from the external data source definition. • if identity type is set to per user: – for queries and searches, the credentials are specific to the current user who invokes the query or search. the credentials come from the user’s authentication settings for the external system. – for administrative connections, such as syncing the external system’s schema, the credentials come from the external data source definition. the values in this class can appear in debug logs and can be accessed by users who have the “author apex” permission. if you require better security, we recommend that you specify named credentials instead of urls as your apex callout endpoints. salesforce manages all authentication for apex callouts that specify a named credential as the callout endpoint so that your code doesn’t have to. in this section: connectionparams properties connectionparams properties the following are properties for connectionparams. in this section: certificatename the name of the certificate for establishing each connection to the external system. endpoint the url of the external system. oauthtoken the oauth token that’s issued by the external system. 2124apex reference guide connectionparams class password the password for authenticating to the external system. principaltype an instance of datasource.identitytype, which determines which set of credentials to use to access the external system. protocol the type of protocol that’s used to authenticate to the external system. repository reserved for future use. username the username for authenticating to the external system. certificatename the name of the certificate for establishing each connection to the external system. signature public string certificatename {get; set;} property value type: string the value comes from the external data source definition in salesforce. endpoint the url of the external system. signature public string endpoint {get; set;} property value type: string the value comes from the external data source definition in salesforce. oauthtoken the oauth token that’s issued by the external system. signature public string oauthtoken {get; set;} property value type: string 2125apex reference guide connectionparams class password the password for authenticating to the external system. signature public string password {get; set;} property value type: string the value depends on the identity type field of the external data source definition in salesforce. • if identity type is set to named principal, the credentials come from the external data source definition. • if identity type is set to per user: – for queries and searches, the credentials are specific to the current user who invokes the query or search. the credentials come from the user’s authentication settings for the external system. – for administrative connections, such as syncing the external system’s schema, the credentials come from the external data source definition. principaltype an instance of datasource.identitytype, which determines which set of credentials to use to access the external system. signature public datasource.identitytype principaltype {get; set;} property value type: datasource.identitytype protocol the type of protocol that’s used to authenticate to the external system. signature public datasource.authenticationprotocol protocol {get; set;} property value type: datasource.authenticationprotocol repository reserved for future use. 2126apex reference guide datasourceutil class signature public string repository {get; set;} property value type: string reserved for future use. username the username for authenticating to the external system. signature public string username {get; set;} property value type: string the value depends on the identity type field of the external data source definition in salesforce. • if identity type is set to named principal, the credentials come from the external data source definition. • if identity type is set to per user: – for queries and searches, the credentials are specific to the current user who invokes the query or search. the credentials come from the user’s authentication settings for the external system. – for administrative connections, such as syncing the external system’s schema, the credentials come from the external data source definition. datasourceutil class parent class for the datasource.provider, datasource.connection, datasource.table, and data
source.column classes. namespace datasource in this section: datasourceutil methods datasourceutil methods the following are methods for datasourceutil. 2127apex reference guide datatype enum in this section: logwarning(message) logs the error message in the debug log. throwexception(message) throws a datasourceexception and displays the provided message to the user. logwarning(message) logs the error message in the debug log. signature public void logwarning(string message) parameters message type: string the error message. return value type: void throwexception(message) throws a datasourceexception and displays the provided message to the user. signature public void throwexception(string message) parameters message type: string error message to display to the user. return value type: void datatype enum specifies the data types that are supported by the apex connector framework. 2128apex reference guide deletecontext class usage the datasource.datatype enum is referenced by the type property on the datasource.column class. enum values the following are the values of the datasource.datatype enum. value description boolean_type boolean datetime_type date/time external_lookup_type external lookup relationship indirect_lookup_type indirect lookup relationship lookup_type lookup relationship number_type number string_long_type long text area string_short_type text area url_type url deletecontext class an instance of deletecontext is passed to the deleterows() method on your database.connection class. the class provides context information about the delete request to the implementor of deleterows(). namespace datasource usage the apex connector framework creates context for operations. context is comprised of parameters about the operations, which other methods can use. an instance of the deletecontext class packages these parameters into an object that can be used when a deleterows() operation is initiated. in this section: deletecontext properties deletecontext properties the following are properties for deletecontext. 2129apex reference guide deleteresult class in this section: externalids the external ids of the rows representing external object records to delete. tableselected the name of the table to delete rows from. externalids the external ids of the rows representing external object records to delete. signature public list<string> externalids {get; set;} property value type: list<string> tableselected the name of the table to delete rows from. signature public string tableselected {get; set;} property value type: string deleteresult class represents the result of a delete operation on an sobject record. the result is returned by the datasource.deleterows method of the datasource.connection class. namespace datasource usage a delete operation on external object records generates an array of objects of type datasource.deleteresult. its methods create result records that indicate whether the delete operation succeeded or failed. in this section: deleteresult properties deleteresult methods 2130apex reference guide deleteresult class deleteresult properties the following are properties for deleteresult. in this section: errormessage the error message that’s generated by a failed delete operation. recorded with a result of type datasource.deleteresult. externalid the unique identifier of a row that represents an external object record to delete. success indicates whether a delete operation succeeded or failed. errormessage the error message that’s generated by a failed delete operation. recorded with a result of type datasource.deleteresult. signature public string errormessage {get; set;} property value type: string externalid the unique identifier of a row that represents an external object record to delete. signature public string externalid {get; set;} property value type: string success indicates whether a delete operation succeeded or failed. signature public boolean success {get; set;} property value type: boolean 2131apex reference guide deleteresult class deleteresult methods the following are methods for deleteresult. in this section: equals(obj) maintains the integrity of lists of type deleteresult by determining the equality of external objects in a list. this method is dynamic and is based on the equals method in java. failure(externalid, errormessage) creates a delete result
indicating the failure of a delete request for a given external id. hashcode() maintains the integrity of lists of type deleteresult by determining the uniqueness of the external object records in a list. success(externalid) creates a delete result indicating the successful completion of a delete request for a given external id. equals(obj) maintains the integrity of lists of type deleteresult by determining the equality of external objects in a list. this method is dynamic and is based on the equals method in java. signature public boolean equals(object obj) parameters obj type: object external object whose key is to be validated. for information about the equals method, see using custom types in map keys and sets. return value type: boolean failure(externalid, errormessage) creates a delete result indicating the failure of a delete request for a given external id. signature public static datasource.deleteresult failure(string externalid, string errormessage) parameters externalid type: string 2132
apex reference guide filter class the unique identifier of the sobject record to delete. errormessage type: string the reason the delete operation failed. return value type: datasource.deleteresult status result of the delete operation. hashcode() maintains the integrity of lists of type deleteresult by determining the uniqueness of the external object records in a list. signature public integer hashcode() return value type: integer success(externalid) creates a delete result indicating the successful completion of a delete request for a given external id. signature public static datasource.deleteresult success(string externalid) parameters externalid type: string the unique identifier of the sobject record to delete. return value type: datasource.deleteresult status result of the delete operation for the sobject with the given external id. filter class represents a where clause in a sosl or soql query. namespace datasource 2133apex reference guide filter class usage compound types require child filters. specifically, the subfilters property can’t be null if the type property is not_, and_, or or_. in this section: filter properties filter properties the following are properties for filter. in this section: columnname name of the column that’s being evaluated in a simple comparative type of filter. columnvalue value that the filter compares records against in a simple comparative type of filter. subfilters list of subfilters for compound filter types, such as not_, and_, and or_. tablename name of the table whose column is being evaluated in a simple comparative type of filter. type type of filter operation that limits the returned data. columnname name of the column that’s being evaluated in a simple comparative type of filter. signature public string columnname {get; set;} property value type: string columnvalue value that the filter compares records against in a simple comparative type of filter. signature public object columnvalue {get; set;} property value type: object 2134apex reference guide filtertype enum subfilters list of subfilters for compound filter types, such as not_, and_, and or_. signature public list<datasource.filter> subfilters {get; set;} property value type: list<datasource.filter> tablename name of the table whose column is being evaluated in a simple comparative type of filter. signature public string tablename {get; set;} property value type: string type type of filter operation that limits the returned data. signature public datasource.filtertype type {get; set;} property value type: datasource.filtertype filtertype enum referenced by the type property on a datasource.filter. usage determines how to limit the returned data. enum values the following are the values of the datasource.filtertype enum. 2135apex reference guide identitytype enum value description and_ this compound filter type returns all rows that match all the subfilters. contains simple comparative filter type. ends_with simple comparative filter type. equals simple comparative filter type. greater_than simple comparative filter type. greater_than_or_equal_to simple comparative filter type. less_than simple comparative filter type. less_than_or_equal_to simple comparative filter type. like_ simple comparative filter type. not_ this compound filter type returns the rows that don’t match the subfilter. not_equals simple comparative filter type. or_ this compound filter type returns all rows that match any of the subfilters. starts_with simple comparative filter type. identitytype enum determines which set of credentials is used to authenticate to the external system. usage the relevant credentials are passed to your datasource.connection class. enum values the following are the values of the datasource.identitytype enum. value description anonymous no credentials are used to authenticate to the external system. named_user the credentials in the external data source definition are used to authenticate to the external system, regardless of which user is accessing the external data from your organization. per_user for queries and searches, the credentials are specific to the current user who invokes the query or search. the credentials come from the user’s authentication settings for the external system. for administrative connections
, such as syncing the external system’s schema, the credentials come from the external data source definition. 2136apex reference guide order class order class contains details about how to sort the rows in the result set. equivalent to an order by statement in a soql query. namespace datasource usage used in the order property on the datasource.tableselection class. in this section: order properties order methods order properties the following are properties for order. in this section: columnname name of the column whose values are used to sort the rows in the result set. direction direction for sorting rows based on column values. tablename name of the table whose column values are used to sort the rows in the result set. columnname name of the column whose values are used to sort the rows in the result set. signature public string columnname {get; set;} property value type: string direction direction for sorting rows based on column values. signature public datasource.orderdirection direction {get; set;} 2137apex reference guide order class property value type: datasource.orderdirection tablename name of the table whose column values are used to sort the rows in the result set. signature public string tablename {get; set;} property value type: string order methods the following are methods for order. in this section: get(tablename, columnname, direction) creates an instance of the datasource.order class. get(tablename, columnname, direction) creates an instance of the datasource.order class. signature public static datasource.order get(string tablename, string columnname, datasource.orderdirection direction) parameters tablename type: string name of the table whose column values are used to sort the rows in the result set. columnname type: string name of the column whose values are used to sort the rows in the result set. direction type: datasource.orderdirection direction for sorting rows based on column values. return value type: datasource.order 2138apex reference guide orderdirection enum orderdirection enum specifies the direction for sorting rows based on column values. usage used by the direction property on the datasource.order class. enum values the following are the values of the datasource.orderdirection enum. value description ascending sort rows in ascending order (a–z). descending sort rows in descending order (z–a). provider class extend this base class to create a custom adapter for salesforce connect. the class informs salesforce of the functional and authentication capabilities that are supported by or required to connect to the external system. this class extends the datasourceutil class and inherits its methods. namespace datasource usage create an apex class that extends datasource.provider to specify the following. • the types of authentication that can be used to access the external system • the features that are supported for the connection to the external system • the apex class that extends datasource.connection to sync the external system’s schema and to handle the queries and searches of the external data the values that are returned by the datasource.provider class determine which settings are available in the external data source definition in salesforce. to access the external data source definition from setup, enter external data sources in the quick find box, then select external data sources. in this section: provider methods provider methods the following are methods for provider. 2139apex reference guide provider class in this section: getauthenticationcapabilities() returns the types of authentication that can be used to access the external system. getcapabilities() returns the functional operations that the external system supports and the required endpoint settings for the external data source definition in salesforce. getconnection(connectionparams) returns a connection that points to an instance of the external data source. getauthenticationcapabilities() returns the types of authentication that can be used to access the external system. signature public list<datasource.authenticationcapability> getauthenticationcapabilities() return value type: list<datasource.authenticationcapability> getcapabilities() returns the functional operations that the external system supports and the required endpoint settings for the external data source definition in salesforce. signature public list<datasource.capability> getcapabilities() return value type: list<datasource.capability> getconnection
(connectionparams) returns a connection that points to an instance of the external data source. signature public datasource.connection getconnection(datasource.connectionparams connectionparams) parameters connectionparams type: datasource.connectionparams credentials for authenticating to the external system. 2140apex reference guide queryaggregation enum return value type: datasource.connection queryaggregation enum specifies how to aggregate a column in a query. usage used by the aggregation property on the datasource.columnselection class. enum values the following are the values of the datasource.queryaggregation enum. value description avg reserved for future use. count returns the number of rows that meet the query criteria. max reserved for future use. min reserved for future use. none no aggregation. sum reserved for future use. querycontext class an instance of querycontext is provided to the query method on your datasource.connection class. the instance corresponds to a soql request. namespace datasource in this section: querycontext properties querycontext methods querycontext properties the following are properties for querycontext. 2141apex reference guide querycontext class in this section: querymoretoken query token that’s used for server-driven paging to determine and fetch the subsequent batch of results. tableselection query details that represent the from, order by, select, and where clauses in a soql or sosl query. querymoretoken query token that’s used for server-driven paging to determine and fetch the subsequent batch of results. signature public string querymoretoken {get; set;} property value type: string tableselection query details that represent the from, order by, select, and where clauses in a soql or sosl query. signature public datasource.tableselection tableselection {get; set;} property value type: datasource.tableselection querycontext methods the following are methods for querycontext. in this section: get(metadata, offset, maxresults, tableselection) creates an instance of the querycontext class. get(metadata, offset, maxresults, tableselection) creates an instance of the querycontext class. signature public static datasource.querycontext get(list<datasource.table> metadata, integer offset, integer maxresults, datasource.tableselection tableselection) 2142apex reference guide queryutils class parameters metadata type: list<datasource.table> list of table metadata that describes the external system’s tables to query. offset type: integer used for client-driven paging. specifies the starting row offset into the query’s result set. maxresults type: integer used for client-driven paging. specifies the maximum number of rows to return in each batch. tableselection type: datasource.tableselection query details that represent the from, order by, select, and where clauses in a soql or sosl query. return value type: datasource.querycontext queryutils class contains helper methods to locally filter, sort, and apply limit and offset clauses to data rows. this helper class is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. namespace datasource usage the datasource.queryutils class and its helper methods can process query results locally within your salesforce org. this class is provided for your convenience to simplify the development of your salesforce connect custom adapter for initial tests. however, the datasource.queryutils class and its methods aren’t supported for use in production environments that use callouts to retrieve data from external systems. complete the filtering and sorting on the external system before sending the query results to salesforce. when possible, use server-driven paging or another technique to have the external system determine the appropriate data subsets according to the limit and offset clauses in the query. in this section: queryutils methods queryutils methods the following are methods for queryutils. 2143apex reference guide queryutils class in this section: applylimitandoffset(querycontext, rows) returns a subset of data rows after locally applying limit and offset clauses from the query. this helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. filter(querycontext, rows) returns a subset of data rows after
locally ordering and applying filters from the query. this helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. process(querycontext, rows) returns data rows after locally filtering, sorting, ordering, and applying limit and offset clauses from the query. this helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. sort(querycontext, rows) returns data rows after locally sorting and applying the order from the query. this helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. applylimitandoffset(querycontext, rows) returns a subset of data rows after locally applying limit and offset clauses from the query. this helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. signature public static list<map<string,object>> applylimitandoffset(datasource.querycontext querycontext, list<map<string,object>> rows) parameters querycontext type: datasource.querycontext represents the query to run against a data table. rows type: list<map<string, object>> rows of data. return value type: list<map<string, object>> filter(querycontext, rows) returns a subset of data rows after locally ordering and applying filters from the query. this helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. signature public static list<map<string,bject>> filter(datasource.querycontext querycontext, list<map<string,object>> rows) 2144apex reference guide queryutils class parameters querycontext type: datasource.querycontext querycontext rows type: list<map<string, object>> rows of data. return value type: list<map<string, object>> process(querycontext, rows) returns data rows after locally filtering, sorting, ordering, and applying limit and offset clauses from the query. this helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. signature public static list<map<string,bject>> process(datasource.querycontext querycontext, list<map<string,object>> rows) parameters querycontext type: datasource.querycontext represents the query to run against a data table. rows type: list<map<string, object>> rows of data. return value type: list<map<string, object>> sort(querycontext, rows) returns data rows after locally sorting and applying the order from the query. this helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments. signature public static list<map<string,ject>> sort(datasource.querycontext querycontext, list<map<string,bject>> rows) 2145apex reference guide readcontext class parameters querycontext type: datasource.querycontext represents the query to run against a data table. rows type: list<map<string, object>> rows of data. return value type: list<map<string, object>> readcontext class abstract base class for the querycontext and searchcontext classes. namespace datasource in this section: readcontext properties readcontext properties the following are properties for readcontext. in this section: maxresults maximum number of rows that the query can return. metadata describes the external system’s tables to query. offset the starting row offset into the query’s result set. used for client-driven paging. maxresults maximum number of rows that the query can return. signature public integer maxresults {get; set;} 2146apex reference guide searchcontext class property value type: integer metadata describes the external system’s tables to query. signature public list<datasource.table> metadata {get; set;} property value type: list<datasource.table> offset the starting row offset into the query’s result set. used for client-driven paging. signature public integer offset {get; set;} property value type: integer searchcontext class an instance of searchcontext is provided to the search method on your datasource.connection class. the instance correspond
s to a search or sosl request. namespace datasource in this section: searchcontext constructors searchcontext properties searchcontext constructors the following are constructors for searchcontext. in this section: searchcontext(metadata, offset, maxresults, tableselections, searchphrase) creates an instance of the searchcontext class with the specified parameter values. 2147apex reference guide searchcontext class searchcontext() creates an instance of the searchcontext class. searchcontext(metadata, offset, maxresults, tableselections, searchphrase) creates an instance of the searchcontext class with the specified parameter values. signature public searchcontext(list<datasource.table> metadata, integer offset, integer maxresults, list<datasource.tableselection> tableselections, string searchphrase) parameters metadata type: list<datasource.table> list of table metadata that describes the external system’s tables to query. offset type: integer specifies the starting row offset into the query’s result set. maxresults type: integer specifies the maximum number of rows to return in each batch. tableselections type: list<datasource.tableselection> list of queries and their details. the details represent the from, order by, select, and where clauses in each soql or sosl query. searchphrase type: string the user-entered search string as a case-sensitive single phrase, with all non-alphanumeric characters removed. searchcontext() creates an instance of the searchcontext class. signature public searchcontext() searchcontext properties the following are properties for searchcontext. 2148apex reference guide searchutils class in this section: searchphrase the user-entered search string as a case-sensitive single phrase, with all non-alphanumeric characters removed. tableselections list of queries and their details. the details represent the from, order by, select, and where clauses in each soql or sosl query. searchphrase the user-entered search string as a case-sensitive single phrase, with all non-alphanumeric characters removed. signature public string searchphrase {get; set;} property value type: string tableselections list of queries and their details. the details represent the from, order by, select, and where clauses in each soql or sosl query. signature public list<datasource.tableselection> tableselections {get; set;} property value type: list<datasource.tableselection> searchutils class helper class for implementing search on a custom adapter for salesforce connect. namespace datasource usage we recommend that you develop your own search implementation that can search columns in addition to the designated name field. in this section: searchutils methods searchutils methods the following are methods for searchutils. 2149apex reference guide table class in this section: searchbyname(searchdetails, connection) queries all the tables and returns each row whose designated name field contains the search phrase. searchbyname(searchdetails, connection) queries all the tables and returns each row whose designated name field contains the search phrase. signature public static list<datasource.tableresult> searchbyname(datasource.searchcontext searchdetails, datasource.connection connection) parameters searchdetails type: datasource.searchcontext the searchcontext class that specifies which data to search and what to search for. connection type: datasource.connection the datasource.connection class that connects to the external system. return value type: list<datasource.tableresult> table class describes a table on an external system that the salesforce connect custom adapter connects to. this class extends the datasourceutil class and inherits its methods. namespace datasource usage a list of table metadata is provided by the datasource.connection class when the sync() method is invoked. each table can become an external object in salesforce. the metadata is stored in salesforce. updating the apex code to return new or updated values for the table metadata doesn’t automatically update the stored metadata in salesforce. in this section: table properties table methods 2150apex reference guide table class table properties the following are properties for table. in this section: columns list of table columns. description description of what the table represents. labelplural plural form of the user-friendly name for the table. the label
plural becomes the object’s plural label in the salesforce user interface. labelsingular singular form of the user-friendly name for the table. the labelsingular becomes the object label in the salesforce user interface. we recommend that you make object labels unique across all standard, custom, and external objects in the org. name name of the table on the external system. namecolumn name of the table column that becomes the name field of the external object when the administrator syncs the table. columns list of table columns. signature public list<datasource.column> columns {get; set;} property value type: list<datasource.column> description description of what the table represents. signature public string description {get; set;} property value type: string labelplural plural form of the user-friendly name for the table. the labelplural becomes the object’s plural label in the salesforce user interface. 2151apex reference guide table class signature public string labelplural {get; set;} datasource.table, labelplural property value type: string labelsingular singular form of the user-friendly name for the table. the labelsingular becomes the object label in the salesforce user interface. we recommend that you make object labels unique across all standard, custom, and external objects in the org. signature public string labelsingular {get; set;} property value type: string name name of the table on the external system. signature public string name {get; set;} property value type: string namecolumn name of the table column that becomes the name field of the external object when the administrator syncs the table. signature public string namecolumn {get; set;} property value type: string table methods the following are methods for table. 2152apex reference guide table class in this section: get(name, labelsingular, labelplural, description, namecolumn, columns) returns the table metadata with the specified parameter values. get(name, namecolumn, columns) returns the table metadata with the specified parameter values, using the name for the labels and description. get(name, labelsingular, labelplural, description, namecolumn, columns) returns the table metadata with the specified parameter values. signature public static datasource.table get(string name, string labelsingular, string labelplural, string description, string namecolumn, list<datasource.column> columns) parameters name type: string name of the external table. labelsingular type: string singular form of the user-friendly name for the table. the labelsingular becomes the object label in the salesforce user interface. labelplural type: string plural form of the user-friendly name for the table. the labelplural becomes the object’s plural label in the salesforce user interface. description type: string description of the external table. namecolumn type: string name of the table column that becomes the name field of the external object when the administrator syncs the table. columns type: list<datasource.column> list of table columns. return value type: datasource.table get(name, namecolumn, columns) returns the table metadata with the specified parameter values, using the name for the labels and description. 2153apex reference guide tableresult class signature public static datasource.table get(string name, string namecolumn, list<datasource.column> columns) datasource.table, get, [string, string, list<datasource.column>], datasource.table parameters name type: string name of the external table. namecolumn type: string name of the table column that becomes the name field of the external object when the administrator syncs the table. columns type: list<datasource.column> list of table columns. return value type: datasource.table the returned table metadata has these property values. property value name name labelsingular name labelplural name description name namecolumn namecolumn columns columns tableresult class contains the results of a search or query. namespace datasource in this section: tableresult properties tableresult methods 2154apex reference guide tableresult class tableresult properties the following are properties for tableresult. in this section: errormessage errormessage querymoretoken query token that’s used for server-
driven paging to determine and fetch the subsequent batch of results. this token is passed back to the apex data source on subsequent queries in the querymoretoken property on the querycontext. rows rows of data. success whether the search or query was successful. tablename name of the table that was queried. totalsize the total number of rows that meet the query criteria, even when the external system is requested to return a smaller batch size. errormessage errormessage signature public string errormessage {get; set;} property value type: string querymoretoken query token that’s used for server-driven paging to determine and fetch the subsequent batch of results. this token is passed back to the apex data source on subsequent queries in the querymoretoken property on the querycontext. signature public string querymoretoken {get; set;} property value type: string rows rows of data. 2155apex reference guide tableresult class signature public list<map<string,object>> rows {get; set;} property value type: list<map<string, object>> success whether the search or query was successful. signature public boolean success {get; set;} property value type: boolean tablename name of the table that was queried. signature public string tablename {get; set;} property value type: string totalsize the total number of rows that meet the query criteria, even when the external system is requested to return a smaller batch size. signature public integer totalsize {get; set;} property value type: integer tableresult methods the following are methods for tableresult. 2156apex reference guide tableresult class in this section: error(errormessage) returns failed search or query results with the provided error message. get(success, errormessage, tablename, rows, totalsize) returns a subset of data rows in a tableresult with the provided property values and the number of rows in the table. get(success, errormessage, tablename, rows) returns a subset of data rows in a tableresult with the provided property values. get(querycontext, rows) returns the subset of data rows that meet the query criteria, and the number of rows in the table, in a tableresult. get(tableselection, rows) returns the subset of data rows that meet the query criteria, and the number of rows in the table, in a tableresult. error(errormessage) returns failed search or query results with the provided error message. signature public static datasource.tableresult error(string errormessage) parameters errormessage type: string errormessage return value type: datasource.tableresult the returned tableresult has these property values. property value success false errormessage errormessage tablename null rows null rows.size() 0 get(success, errormessage, tablename, rows, totalsize) returns a subset of data rows in a tableresult with the provided property values and the number of rows in the table. 2157apex reference guide tableresult class signature public static datasource.tableresult get(boolean success, string errormessage, string tablename, list<map<string,object>> rows, integer totalsize) parameters success type: boolean whether the search or query was successful. errormessage type: string errormessage tablename type: string name of the table that was queried. rows type: list<map<string, object>> rows of data. totalsize type: integer the total number of rows that meet the query criteria, even when the external system is requested to return a smaller batch size. return value type: datasource.tableresult get(success, errormessage, tablename, rows) returns a subset of data rows in a tableresult with the provided property values. signature public static datasource.tableresult get(boolean success, string errormessage, string tablename, list<map<string,object>> rows) parameters success type: boolean whether the search or query was successful. errormessage type: string errormessage tablename type: string 2158apex reference guide tableresult class name of the table that was queried. rows type: list<map<string, object>> rows of data. return value type: datasource.tableresult get(querycontext, rows) returns the subset of data rows that meet the query criteria, and the number of rows in the table, in a
tableresult. signature public static datasource.tableresult get(datasource.querycontext querycontext, list<map<string,object>> rows) parameters querycontext type: datasource.querycontext represents the query to run against a data table. rows type: list<map<string, object>> rows of data. return value type: datasource.tableresult get(tableselection, rows) returns the subset of data rows that meet the query criteria, and the number of rows in the table, in a tableresult. signature public static datasource.tableresult get(datasource.tableselection tableselection, list<map<string,object>> rows) parameters tableselection type: datasource.tableselection query details that represent the from, order by, select, and where clauses in a soql or sosl query. rows type: list<map<string, object>> rows of data. 2159apex reference guide tableselection class return value type: datasource.tableresult tableselection class contains a breakdown of the soql or sosl query. its properties represent the from, order by, select, and where clauses in the query. namespace datasource in this section: tableselection properties tableselection properties the following are properties for tableselection. in this section: columnsselected list of columns to query. corresponds to the select clause in a soql or sosl query. filter identifies the query filter, which can be a compound filter that has a list of subfilters. the filter corresponds to the where clause in a soql or sosl query. order identifies the order for sorting the query results. corresponds to the order by clause in a soql or sosl query. tableselected name of the table to query. corresponds to the from clause in a soql or sosl query. columnsselected list of columns to query. corresponds to the select clause in a soql or sosl query. signature public list<datasource.columnselection> columnsselected {get; set;} property value type: list<datasource.columnselection> filter identifies the query filter, which can be a compound filter that has a list of subfilters. the filter corresponds to the where clause in a soql or sosl query. 2160apex reference guide upsertcontext class signature public datasource.filter filter {get; set;} property value type: datasource.filter order identifies the order for sorting the query results. corresponds to the order by clause in a soql or sosl query. signature public list<datasource.order> order {get; set;} property value type: list<datasource.order> tableselected name of the table to query. corresponds to the from clause in a soql or sosl query. signature public string tableselected {get; set;} property value type: string upsertcontext class an instance of upsertcontext is passed to the upsertrows() method on your datasource.connection class. this class provides context information about the upsert request to the implementor of upsertrows(). namespace datasource usage the apex connector framework creates the contet for operations. context is comprised of parameters about the operations, which other methods can use. an instance of the upsertcontext class packages these parameters into an object that can be used when an upsertrows() operation is initiated. in this section: upsertcontext properties 2161apex reference guide upsertresult class upsertcontext properties the following are properties for upsertcontext. in this section: rows list of rows corresponding to the external object records to upsert. tableselected the name of the table to upsert rows in. rows list of rows corresponding to the external object records to upsert. signature public list<map<string,any>> rows {get; set;} property value type: list<map<string,object>> tableselected the name of the table to upsert rows in. signature public string tableselected {get; set;} property value type: string upsertresult class represents the result of an upsert operation on an external object record. the result is returned by the upsertrows method of the datasource.connection class. namespace datasource usage an upsert operation

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.