text
stringlengths 24
5.1k
|
|---|
, topics, and so on. in version 31.0 and later, every feed item (and feed element) can have a unique set of capabilities. if a capability property exists on a feed element, that capability is available, even if the capability property doesn’t have a value. for example, if the chatterlikes capability property exists on a feed element (with or without a value), the context user can like that feed element. if the capability property doesn’t exist, it isn’t possible to like that feed element. a capability can also contain associated data. for example, the moderation capability contains data about moderation flags. this class is abstract and has no public constructor. you can make an instance only of a subclass. this class is a superclass of: • connectapi.associatedactionscapabilityinput • connectapi.bookmarkscapabilityinput • connectapi.canvascapabilityinput • connectapi.contentcapabilityinput • connectapi.directmessagecapabilityinput • connectapi.extensionscapabilityinput • connectapi.feedentitysharecapabilityinput • connectapi.filescapabilityinput • connectapi.linkcapabilityinput • connectapi.mutecapabilityinput • connectapi.pollcapabilityinput • connectapi.questionandanswerscapabilityinput • connectapi.readbycapabilityinput • connectapi.recordcapabilityinput • connectapi.statuscapabilityinput • connectapi.topicscapabilityinput connectapi.feedelementinput feed elements are the top-level items that a feed contains. feeds are feed element containers. this class is abstract and has no public constructor. you can make an instance only of a subclass. superclass of connectapi.feediteminput. property type description required or available version optional capabilities connectapi. the capabilities that define auxiliary optional 31.0 feedelement information on this feed element. capabilitiesinput 1589apex reference guide connectapi input classes property type description required or available version optional feedelementtype connectapi. the type of feed element this input required when 31.0 feedelementtype represents. creating a feed element optional when updating a feed element subjectid string the id of the parent this feed element is required 31.0 being posted to. this value can be the id of a user, group, or record, or the string me to indicate the context user. in version 45.0 and later, you can move a feed element from one public group to another by setting this property to the id of the new public group. you can’t include or change any other properties when moving a feed element. see also: post a feed element with a mention post a feed element with existing content post a feed element with a new file (binary) attachment define an action link and post with a feed element define an action link in a template and post with a feed element share a feed element (in version 39.0 and later) edit a feed element edit a question title and post post a rich-text feed element with inline image connectapi.feedentitysharecapabilityinput share a feed entity with a feed post or comment. this class is a subclass of connectapi.feedelementcapabilityinput. 1590apex reference guide connectapi input classes property type description required or available version optional feedentityid string id of the feed entity to share with the feed required 39.0 post or comment. see also: connectapi.feedelementcapabilitiesinput connectapi.feediteminput used to create rich feed items, for example, feed items that include @mentions or files. subclass of connectapi.feedelementinput as of version 31.0. property type description required or available optional version attachment connectapi.feed specifies the attachment for the feed item. the feed optional 28.0–31.0 itemattachment item type is inferred based on the provided attachment. input important: as of api version 32.0, use the inherited capabilities property. body connectapi. message body. the body can contain up to 10,000 required unless 28.0 messagebody characters and 25 mentions. because the character the feed item input limit can change, clients should make a has a link describesobjects() call on the feeditem or capability or a feedcomment object and look at the length of the content body or commentbody field to determine the capability. |
maximum number of allowed characters. if you specify originalfeedelementid to share a feed item, use the body property to add the first comment to the feed item. to edit this property in a feed item, use updatefeedelement(communityid, feedelementid, feedelement). editing feed posts is supported in version 34.0 and later. isbookmarked boolean specifies if the new feed item should be bookmarked optional 28.0–31.0 bycurrentuser for the user (true) or not (false). important: as of api version 32.0, use the capabilities.bookmarks.isbookmarkedbycurrentuser property. 1591apex reference guide connectapi input classes property type description required or available optional version original string to share a feed element, specify its 18-character id. optional 31.0–38.0 feedelementid important: as of api version 39.0, use the capabilities.feedentity share.feedentityid property. original string to share a feed item, specify its 18-character id. optional 28.0–31.0 feeditemid important: in api version 32.0–38.0, use the originalfeedelementid property. in api version 39.0 and later, use the capabilities.feedentity share.feedentityid property. visibility connectapi. type of users who can see a feed item. optional 28.0 feeditem • allusers—visibility is not limited to internal visibilitytype users. enum • internalusers—visibility is limited to internal users. default values: • for external users, the default value is allusers. external users must use this value to see their posts. • for internal users, the default value is internalusers. internal users can accept this value or use the value allusers to allow external users to see their posts. if the parent of the feed item is a user, group, or direct message, the visibility of the feed item must be allusers. connectapi.fileidinput attach a file that has already been uploaded or remove a file from a feed element. property type description required or available version optional id string id of a file that has already been uploaded. required 36.0 1592apex reference guide connectapi input classes property type description required or available version optional operationtype connectapi. operation to carry out on the file. values are: optional 36.0 operationtype • add—adds the file to the feed if not specified, element. defaults to add. • remove—removes the file from the feed element. remove operations are processed before add operations. adding content that is already added and removing content that is already removed result in no operation. see also: connectapi.filescapabilityinput connectapi.findrouteswithfewestsplitsinputrepresentation data used to calculate order fulfillment routes involving the fewest number of shipment splits. property type description required or available version optional locationavailable list<connectapi. each list element represents the available at least one element 51.0 inventory locationavailability quantity of a product at an inventory is required inputrepresentation> location. maximumnumber integer the maximum allowable number of optional 51.0 ofsplits shipment splits. routing options that involve more than this number of splits are not returned. note: each split represents an additional shipment. specifying a maximum of 0 returns only locations that can fulfill the entire order in a single shipment. a maximum of 1 returns combinations of locations that can fulfill the order in one or two shipments, and so on. orderedquantities list<connectapi. each list element represents a quantity of a at least one element 51.0 quantitywithsku product to be routed for fulfillment. is required inputrepresentation> see also: findrouteswithfewestsplits(findrouteswithfewestsplitsinputrepresentation) 1593apex reference guide connectapi input classes connectapi.findrouteswithfewestsplitsgroupusingociinputrepresentation data used to calculate inventory availability and fulfillment routes for one order involving the fewest number of shipment splits. property type description required or available version optional excludelocations list<string> list of locations to exclude from the routing optional 55.0 calculations. maximumnumber integer maximum allowable number of shipment optional 54.0 ofsplits splits. routing options that involve more than this number of splits are not |
returned. note: each split represents an additional shipment. specifying a maximum of 0 returns only locations that can fulfill the entire order in a single shipment. a maximum of 1 returns combinations of locations that can fulfill the order in one or two shipments, and so on. ordereditems list<connectapi. each list element represents a quantity of a at least one element 54.0 findrouteswithfewest product to be routed for fulfillment and the is required splitsusingoci assigned location group or location. iteminputrepresentation> see also: findrouteswithfewestsplitsusingoci(findrouteswithfewestsplitsusingociinput) connectapi.findrouteswithfewestsplitsusingociinputrepresentation connectapi.findrouteswithfewestsplitsusingociinputrepresentation data used to calculate order fulfillment routes involving the fewest number of shipment splits, taking into account inventory availability. property type description required or available version optional findrouteswith list<connectapi. each list element represents a routing at least one element 54.0 fewestsplits findrouteswithfewest request for one order. is required usingociinputs splitsgroupusingoci inputrepresentation> see also: findrouteswithfewestsplitsusingoci(findrouteswithfewestsplitsusingociinput) 1594apex reference guide connectapi input classes connectapi.findrouteswithfewestsplitsusingociiteminputrepresentation a quantity of a product and a location group or location assigned to fulfill it. property type description required or available version optional locationgroup string the external reference of the location group required 54.0 identifier or location assigned to the order item. if you specify a location group, inventory is considered for all locations belonging to that group. quantity double quantity of the product. required 54.0 stockkeepingunit string sku of the product. required 54.0 see also: findrouteswithfewestsplitsusingoci(findrouteswithfewestsplitsusingociinput) connectapi.findrouteswithfewestsplitsusingociinputrepresentation connectapi.findrouteswithfewestsplitsgroupusingociinputrepresentation connectapi.filescapabilityinput attach up to 10 files that have already been uploaded or remove one or more files from a feed element. this class is a subclass of connectapi.feedelementcapabilityinput. property type description required or available version optional items list<connectapi. list of file ids and operations to be carried required 36.0 fileidinput> out on those files. see also: connectapi.feedelementcapabilitiesinput connectapi.formfieldinput marketing integration form field. property type description required or available version optional name string name of the marketing integration form required 53.0 field. 1595apex reference guide connectapi input classes property type description required or available version optional type connectapi. type of marketing integration form field. required 53.0 formfieldtype values are: • boolean • date • emailaddress • number • text see also: connectapi.forminput connectapi.forminput marketing integration form. property type description required or available version optional formfieldslist list<connectapi. fields for the marketing integration form. required 53.0 formfieldinput> formname string name of the marketing integration form. required 53.0 member string marketing cloud's member identification required 53.0 identification code (mid) associated with the marketing code integration form. connectapi.formsubmissionfieldinput marketing integration form field submission. property type description required or available version optional name string name of the marketing integration form required 53.0 field. value string value of the marketing integration form required 53.0 field. see also: connectapi.formsubmissioninput 1596apex reference guide connectapi input classes connectapi.formsubmissioninput marketing integration form submission. property type description required or available version optional formfieldslist list<connectapi. fields for the marketing integration form. required 53.0 formfield submissioninput> connectapi.fulfillmentgroupinputrepresentation a list of orderitemsummaries to be fulfilled together, and the fulfillment location to handle them. the fulfillment type |
is one of the values defined for the type field on the fulfillmentorder object, such as “warehouse” or “retail store.” the specified type is assigned to the fulfillmentorder for this fulfillment group. property type description required or available version optional fulfilledfrom string id of the fulfillment location. required 48.0 locationid fulfillmenttype string fulfillment type. one of the type field values required 48.0 defined for fulfillmentorders. orderitem list<connectapi. list of orderitemsummaries. required 48.0 summaries orderitem summaryinput representation> referenceid string reference to this input for use in optional 50.0 troubleshooting failures. this value is only used by the apis for creating fulfillment orders for multiple order delivery group summaries. see also: connectapi.fulfillmentorderinputrepresentation createfulfillmentorders(fulfillmentorderinput) connectapi.fulfillmentorderinputrepresentation an orderdeliverygroupsummary that defines a delivery method and recipient, and a list of fulfillment groups to assign to fulfillmentorders. each fulfillment group is a set of orderitemsummaries that match the orderdeliverygroupsummary and share the same fulfillment location. the method creates a fulfillmentorder for each fulfillment group and a fulfillmentorderlineitem for each orderitemsummary. 1597apex reference guide connectapi input classes property type description required or available version optional fulfillmentgroups list<connectapi. list of fulfillment groups that specify the required 48.0 fulfillmentgroup orderitemsummaries and fulfillment input locations. representation> orderdelivery string id of the orderdeliverygroupsummary. required 48.0 groupsummaryid ordersummaryid string id of the ordersummary. required 48.0 see also: createfulfillmentorders(fulfillmentorderinput) connectapi.fulfillmentorderinvoiceinputrepresentation instantiate and include this object with no properties when creating an invoice. this input class has no properties. see also: createinvoice(fulfillmentorderid, invoiceinput) connectapi.fulfillmentorderlineiteminputrepresentation a fulfillmentorderlineitem and quantity to cancel. you can cancel less than the full quantity, in which case you reallocate the canceled quantity to a different fulfillmentorder. property type description required or available version optional fulfillmentorder string id of the fulfillmentorderlineitem. required 48.0 lineitemid quantity double quantity to cancel. required 48.0 see also: connectapi.fulfillmentorderlineitemstocancelinputrepresentation cancelfulfillmentorderlineitems(fulfillmentorderid, cancelfulfillmentorderlineitemsinput) connectapi.fulfillmentorderlineitemstocancelinputrepresentation a list of fulfillmentorderlineitems and quantities to cancel. 1598apex reference guide connectapi input classes property type description required or available version optional fulfillment list<connectapi. list of fulfillmentorderlineitems and required 48.0 orderline fulfillmentorder quantities. itemstocancel lineiteminput representation> see also: cancelfulfillmentorderlineitems(fulfillmentorderid, cancelfulfillmentorderlineitemsinput) connectapi.baserequest base parameters for making a request to the payment gateway. this class is abstract. subclass of connectapi.auditparamsrequest. superclass of: • connectapi.authorizationrequest • connectapi.authorizationreversalrequest • connectapi.capturerequest • connectapi.paymentmethodtokenizationrequest • connectapi.postauthrequest • connectapi.refundrequest • connectapi.salerequest property type description required or available version optional additionaldata map<string, string> an optional map of additional parameters optional 50.0 to be sent to the payment gateway. idempotencykey string idempotency key. optional 50.0 connectapi.getfocapacityvaluesrequestinputrepresentation locations to get fulfillment order capacity information for. property type description required or available version optional locationids list<string> list of ids of the locations to get fulfillment required 55.0 order capacity information for. 1599a |
pex reference guide connectapi input classes connectapi.groupinformationinput property type description available version text string the text in the “information” section of a group. 28.0 title string the title of the “information” section of a group. 28.0 see also: connectapi.chattergroupinput connectapi.hashtagsegmentinput include a hashtag in a feed item or comment. subclass of connectapi.messagesegmentinput property type description available version tag string text of the hash tag without the # (hash tag) prefix 28.0 note: closing square brackets ( ] ) are not supported in hash tag text. if the text contains a closing square bracket ( ] ), the hash tag ends at the bracket. see also: connectapi.messagebodyinput connectapi.holdfocapacityinputrepresentation request to hold fulfillment order capacity at one or more locations. can correspond to one action call. property type description required or available version optional holdfocapacity list<connectapi. list of requests to hold fulfillment order required 55.0 requests holdfocapacity capacity at one or more locations. requestinput representation> connectapi.holdfocapacityrequestinputrepresentation request to hold fulfillment order capacity at one or more locations. 1600apex reference guide connectapi input classes property type description required or available version optional allornothing boolean controls whether a single failed request optional 55.0 cancels all other requests in the list (true) or whether some requests can succeed if others fail (false). the default value is false. capacityrequests list<connectapi. list of requests to hold fulfillment order required 55.0 capacityrequest capacity. each request is for one fulfillment inputrepresentation> order at one location. connectapi.inlineimagesegmentinput an inline image segment. subclass of connectapi.messagesegmentinput property type description required or available version optional alttext string alt text for the inline image. optional 35.0 if not specified, the title of the inline image file is used as the alt text. fileid string id of the inline image file. required 35.0 see also: post a rich-text feed element with inline image connectapi.messagebodyinput connectapi.innerensurefundsasyncinputrepresentation id of an invoice and id of the associated ordersummary. property type description required or available version optional invoiceid string id of the invoice to ensure funds for. required 56.0 1601apex reference guide connectapi input classes property type description required or available version optional ordersummaryid string id of the ordersummary associated with required 56.0 the invoice. see also: multipleensurefundsasync(multipleensurefundsinput) connectapi.multipleensurefundsasyncinputrepresentation connectapi.inviteinput an invitation. property type description required or available version optional invitees list<string> list of email addresses to send the invitation required 39.0 to. message string message to include in the invitation. optional 39.0 connectapi.invoicetopayinputrepresentation invoice for a fee. property type description required or available version optional invoiceid string id of the invoice for a fee. required 56.0 see also: ensurerefundsasync(ordersummaryid, ensurerefundsinput) connectapi.ensurerefundsasyncinputrepresentation connectapi.leadinput contains information about a lead or guest user. property type description required or available version optional company string the company of the lead. optional 53.0 email string the email address of the lead. optional 53.0 extendedfields <stliconnectapi.extendedfieldinput> use to add values to any of the fields, optional 53.0 including custom fields. 1602apex reference guide connectapi input classes property type description required or available version optional firstname string the first name of the lead. optional 53.0 lastname string the last name of the lead. optional 53.0 phone string the phone number of the lead. optional 53.0 connectapi.linkcapabilityinput create or update a link on a feed element. this class is a subclass of connectapi.feedelementcapabilityinput. property type description required or available version optional url string link url. the url can be to an external site. required |
32.0 urlname string description of the link. optional 32.0 see also: connectapi.feedelementcapabilitiesinput connectapi.linksegmentinput include a link segment in a feed item or comment. subclass of connectapi.messagesegmentinput property type description available version url string url to be used for the link 28.0 see also: connectapi.messagebodyinput connectapi.locationinputrepresentation inventory location data used to calculate shipping distance. property type description required or available version optional countrycode string the country code of the location. required 51.0 locationidentifier string the identifier of the location. required 51.0 postalcode string the postal code of the location. required 51.0 1603apex reference guide connectapi input classes connectapi.locationavailabilityinputrepresentation the available quantity of a product at an inventory location. property type description required or available version optional externalreferenceid string the external reference id of the inventory optional 51.0 location. quantity double the available quantity of the product. required 51.0 stockkeepingunit string the stock keeping unit of the product. required 51.0 connectapi.managedtopicpositioncollectioninput a collection of relative positions of managed topics. property type description required or available version optional managedtopic list<connectapi. list of relative positions of managed topics. required 32.0 positions managedtopic this list can include featured and positioninput> navigational managed topics and doesn’t need to include all managed topics. for more information about reordering managed topics, see the example in reordermanagedtopics(communityid, managedtopicpositioncollection). connectapi.managedtopicpositioninput relative position of a managed topic. property type description required or available version optional managedtopicid string id of existing managed topic. required 32.0 position integer relative position of the managed topic, required 32.0 indicated by zero-indexed, ascending whole numbers. see also: connectapi.managedtopicpositioncollectioninput connectapi.markupbeginsegmentinput the beginning tag for rich text markup. 1604apex reference guide connectapi input classes subclass of connectapi.messagesegmentinput property type description required or available version optional alttext string alternative text for the hyperlink optional 45.0 segment. markuptype connectapi. type of rich text markup. required 35.0 markuptype • 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—strikethrough tag. • underline—underline tag. • unorderedlist—unordered list tag. markup segments with a markuptype of code can include only text segments. url string url for the hyperlink segment. required for 45.0 supported hyperlink urls start with hyperlink http:// or https://. see also: post a rich-text feed element with inline image connectapi.messagebodyinput connectapi.markupendsegmentinput the end tag for rich text markup. subclass of connectapi.messagesegmentinput 1605apex reference guide connectapi input classes property type description required or available version optional markuptype connectapi. type of rich text markup. required 35.0 markuptype • 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—strikethrough tag. • underline—underline tag. • unorderedlist—unordered list tag. see also: post a rich-text feed element with inline image connectapi.messagebodyinput connectapi.mentionsegmentinput include an @mention of a user or group in a feed post or comment. when creating a feed post or comment, you can include up to 25 mentions. subclass of connectapi.messagesegmentinput property type description available version id string id of the user or group to mention. 28.0 to mention a user, use either id |
or username. you can’t include groups are available in 29.0. both. to mention a group, you must use id. username string user name of the user to mention. 38.0 to mention a user, use either id or username. you can’t include both. see also: connectapi.messagebodyinput 1606apex reference guide connectapi input classes connectapi.messagebodyinput add rich messages to feed items and comments. property type description available version messagesegments list<connectapi. list of message segments contained in the body 28.0 messagesegment input> see also: connectapi.feediteminput connectapi.commentinput connectapi.announcementinput connectapi.messagesegmentinput used to add rich message segments to feed items and comments. this class is abstract and has no public constructor. you can make an instance only of a subclass. superclass for: • connectapi.entitylinksegmentinput • connectapi.hashtagsegmentinput • connectapi.inlineimagesegmentinput • connectapi.linksegmentinput • connectapi.markupbeginsegmentinput • connectapi.markupendsegmentinput • connectapi.mentionsegmentinput • connectapi.textsegmentinput use the connectapihelper repository on github to simplify many of the tasks accomplished with connectapi.messagesegmentinput, such as posting with inline images, rich text, and mentions. 1607apex reference guide connectapi input classes property type description required or available version optional type connectapi. the type of message segment. values are: required 23.0 messagesegment • entitylink type • fieldchange • fieldchangename • fieldchangevalue • hashtag • inlineimage • link • markupbegin • markupend • mention • morechanges • resourcelink • text see also: edit a comment edit a feed element edit a question title and post post a rich-text feed element with inline image connectapi.messagebodyinput connectapi.multipleensurefundsasyncinputrepresentation list of invoices and the associated ordersummaries. property type description required or available version optional asyncinputs list<connectapi. list of invoices to ensure funds for and the required 56.0 innerensurefunds associated ordersummaries. asyncinput representation> see also: multipleensurefundsasync(multipleensurefundsinput) connectapi.multiplefulfillmentorderinputrepresentation list of inputs for creating fulfillment orders. 1608apex reference guide connectapi input classes property type description required or available version optional fulfillmentorders list<connectapi. each element contains the data to create required 50.0 fulfillmentorder one fulfillment order. inputrepresentation> connectapi.multiplefulfillmentorderinvoicesinputrepresentation the fulfillmentorders to create invoices for. property type description required or available version optional fulfillmentorderids list<string> list of ids of fulfillmentorders to create at least one id is 52.0 invoices for. required. connectapi.mutecapabilityinput mute or unmute a feed element. this class is a subclass of connectapi.feedelementcapabilityinput. property type description required or available version optional ismutedbyme boolean indicates whether the feed element is required 35.0 muted for the context user. default value is false. see also: setismutedbyme(communityid, feedelementid, ismutedbyme) connectapi.namedcredentialinput input used to create or update a named credential. property type description required or available version optional calloutoptions connectapi. callout options. required 58.0 namedcredential calloutoptionsinput callouturl string url of the named credential in a callout. required 58.0 customheaders list<connectapi. custom http headers. optional 58.0 credentialcustom headerinput> 1609apex reference guide connectapi input classes property type description required or available version optional developername string named credential developer name. required for creating 58.0 a named credential optional for updating a named credential external list< |
connectapi. external credentials used by the named required 58.0 credentials externalcredential credential. in version 58.0 and later only one input> external credential is supported. masterlabel string named credential label. required 58.0 network connectapi. privateconnect outbound network optional depending 58.0 connection networkconnection connection. on type input parameters list<connectapi. named credential parameters. optional 58.0 namedcredential parameterinput> type connectapi. type of named credential. values are: required 58.0 namedcredential • privateendpoint type • securedendpoint connectapi.namedcredentialcalloutoptionsinput named credential callout options input. property type description required or available version optional allowmergefields boolean specifies whether to allow merge fields in required 58.0 inbody the http body (true) or not (false). allowmergefields boolean specifies whether to allow merge fields in required 58.0 inheader the http header (true) or not (false). generate boolean specifies whether to generate an required 58.0 authorization authorization header (true) or not header (false). see also: connectapi.namedcredentialinput 1610apex reference guide connectapi input classes connectapi.namedcredentialparameterinput named credential parameter input. property type description required or available version optional id string id of the parameter. optional 58.0 parameter string description of the parameter. optional 58.0 description parametername string name of the parameter. required 58.0 parametertype connectapi. type of named credential parameter. values required 58.0 namedcredential are: parametertype • allowedmanagedpackagenamespaces • clientcertificate parametervalue string value of the parameter. required 58.0 see also: connectapi.namedcredentialinput connectapi.networkconnectioninput network connection input. property type description required or available version optional developername string developer name of the network connection. required 58.0 namespace string namespace of the network connection. optional 58.0 see also: connectapi.namedcredentialinput connectapi.nbastrategyinput a recommendation strategy. property type description required or available version optional contextrecordid string id of the context record. for example, if the optional 45.0 next best action is on a case detail page, the id of the case. 1611apex reference guide connectapi input classes property type description required or available version optional maxresults integer maximum number of results. valid values optional 45.0 are from 1 to 25. the default is 3. strategycontext map<string, string> variable and value mappings for the optional 45.0 strategy. debugtrace boolean specifies whether to return trace and debug optional 45.0 information in the response (true) or not (false). if unspecified, the default is false. connectapi.newuseraudiencecriteriainput criteria for the new members type of custom recommendation audience. subclass of connectapi.audiencecriteriainput. property type description required or available version optional value double the maximum number of days since a user required 36.0 became a site member. for example, if you specify 30, anyone who became a site member in the last 30 days is included in the new members audience. connectapi.oauthcredentialauthurlinput oauth authentication flow. property type description required or available version optional external string fully qualified developer name of the required 56.0 credential external credential. principalname string name of the external credential named required if 56.0 principal. principaltype is namedprincipal principaltype connectapi. type of credential principal. values are: required 56.0 credentialprincipal • awsstsprincipal type • namedprincipal • peruserprincipal 1612apex reference guide connectapi input classes property type description required or available version optional returnurl string return url to apply to the authentication optional 56.0 url. connectapi.ocicreatereservationinputrepresentation data to reserve inventory at one or more omnichannel inventory locations or location groups. property type description required or available version optional actionrequestid string a uuid that identifies the request. use the required 51.0 action request ids in response data |
to identify which requests succeeded or failed. allowpartial boolean when true, if the system can’t create the optional 51.0 reservations entire reservation, then it attempts to create a partial reservation. createrecords list<connectapi. a list of product quantities and locations or at least one element 51.0 ocicreatereservation location groups. the list can include up to is required singleinput 100 elements. representation> expirationseconds integer a length of time in seconds. if the optional 51.0 reservation isn’t fulfilled within this amount of time after the reservationtime, then it expires. the maximum value is 14400. externalrefid string external reference id. optional 51.0 reservationtime string the time at which to record the reservation. optional 51.0 example: 2020-07-24t21:13:00z connectapi.ocicreatereservationsingleinputrepresentation a quantity of a product and an omnichannel inventory location or location group at which to reserve it. property type description required or available version optional locationgroupidentifier string identifier of the location group at which to either 51.0 reserve inventory. locationgroupidentifier or locationidentifier is required, but not both 1613apex reference guide connectapi input classes property type description required or available version optional locationidentifier string identifier of the location at which to reserve either 51.0 inventory. locationgroupidentifier or locationidentifier is required, but not both quantity double the quantity of the product to reserve. required 51.0 stockkeepingunit string the sku of the product to reserve. required 51.0 connectapi.ocifulfillreservationinputrepresentation a list of inventory reservations to fulfill. property type description required or available version optional fulfillmentrecords list<connectapi. a list of inventory reservations. the list can at least one element 51.0 ocifulfillreservation include up to 100 elements. is required. singleinput representation> connectapi.ocifulfillreservationsingleinputrepresentation an inventory reservation to fulfill. property type description required or available version optional actionrequestid string a uuid that identifies the request. use the required 51.0 action request ids in response data to identify which requests succeeded or failed. externalrefid string the external reference id of the location optional 51.0 that’s fulfilling the reservation. locationidentifier string the identifier of the location that’s fulfilling required 51.0 the reservation. quantity double the quantity being fulfilled. required 51.0 stockkeepingunit string the sku of the product being fulfilled. required 51.0 connectapi.ocigetinventoryavailabilityinputrepresentation details of a request to retrieve inventory availability. 1614apex reference guide connectapi input classes property type description required or available version optional locationgroup string the external reference of a location group optional; can’t 51.0 identifier to retrieve inventory availability data for. combine with specifying this value retrieves inventory data locationgroupidentifiers for all locations belonging to this group. or locationidentifiers locationgroup list<string> a list of up to 100 external references of optional; can’t 51.0 identifiers location groups to retrieve inventory combine with availability data for. locationgroupidentifier or locationidentifiers locationidentifiers list<string> a list of up to 100 external references of optional; can’t 51.0 locations to retrieve inventory availability combine with data for. locationgroupidentifier or locationgroupidentifiers stockkeepingunit string the sku of a product to retrieve inventory optional; can’t 51.0 availability data for. specifying a sku with combine with no locations or location groups returns stockkeepingunits availability data for that sku at all inventory locations that are not assigned to location groups. stockkeepingunits list<string> a list of up to 100 skus of products to optional; can’t 51.0 retrieve inventory availability data for. combine with stockkeepingunit usecache boolean whether to fetch the inventory data from optional 51.0 the cache. default value is . connectapi.ocireleasereservationinputrepresentation details of one or more inventory reservations to release. property type description required or available version optional releaserecords list<connectapi. list of inventory reservations to release. the at least one element 51.0 ocireleasereservation list can include up to 100 elements. |
is required. singleinput representation> connectapi.ocireleasereservationsingleinputrepresentation a single inventory reservation to release. 1615apex reference guide connectapi input classes property type description required or available version optional actionrequestid string a uuid that identifies the request. use the required 51.0 action request ids in response data to identify which requests succeeded or failed. externalrefid string the external reference id of the location or optional 51.0 location group that has the reservation. locationgroupidentifier string the identifier of the location group that has the identifier for a 51.0 the reservation. location or location group, but not both, is required. locationidentifier string the identifier of the location that has the the identifier for a 51.0 reservation. location or location group, but not both, is required. quantity double the quantity of reserved inventory to required 51.0 release. stockkeepingunit string the sku of the product to release. required 51.0 connectapi.ocitransferreservationinputrepresentation a list of inventory reservation transfers and specifies whether a single failure cancels the entire list. property type description required or available version optional allornothing string controls whether a single failed transfer optional 51.0 transferid cancels all other transfers in the transferrecords list. • to allow some transfers in the transferrecords list to succeed when others fail, don’t include this property. • to cancel all the transfers in the transferrecords list when any of them fail, set this property to a uuid. the id must be unique, but isn’t otherwise used in this version. transferrecords list<connectapi. a list of inventory reservation transfers. the at least one element 51.0 ocitransferreservation list can include up to 100 elements. is required. singleinput representation> 1616apex reference guide connectapi input classes connectapi.ocitransferreservationsingleinputrepresentation an inventory reservation transfer. property type description required or available version optional actionrequestid string a uuid that identifies the request. use the required 51.0 action request ids in response data to identify which requests succeeded or failed. externalrefid string the external reference id of the location optional 51.0 receiving the transfer. fromlocationgroupidentifier string the identifier of the location group sending the identifier for a 51.0 the reservation. sending location or location group, but not both, is required fromlocationidentifier string the identifier of the location sending the the identifier for a 51.0 reservation. sending location or location group, but not both, is required ignoreavailabilitycheck boolean if true, force the transfer even if the receiving optional 52.0 location doesn’t have sufficient available inventory. the default value is false. quantity double the quantity of inventory being transferred. required 51.0 stockkeepingunit string the sku of the product being transferred. required 51.0 tolocationgroupidentifier string the identifier of the location group receiving the identifier for a 51.0 the reservation. receiving location or location group, but not both, is required tolocationidentifier string the identifier of the location receiving the the identifier for a 51.0 reservation. receiving location or location group, but not both, is required connectapi.orderitemsummaryinputrepresentation an orderitemsummary and quantity. property type description required or available version optional orderitem string id of the orderitemsummary. required 48.0 summaryid 1617apex reference guide connectapi input classes property type description required or available version optional quantity double quantity to include. required 48.0 see also: connectapi.fulfillmentgroupinputrepresentation connectapi.fulfillmentorderinputrepresentation createfulfillmentorders(fulfillmentorderinput) connectapi.orderitemsummaryadjustmentinput order item summary. property type description required or available version optional orderitem string id of the order item summary. required 53.0 summaryid see also: connectapi.orderitemsummaryadjustmentcollectioninput connectapi.orderitemsummaryadjustmentcollectioninput collection of order item summaries. property type description required or available version optional orderitem list<connectapi. list of order item summaries. required 53.0 summaries orderitemsummary adjustmentinput> connectapi.ordersummaryinputrepresentation an order from which to create an ordersummary. |
optionally, you can specify ordersummary-specific information such as its status and whether it is managed in salesforce order management. property type description required or available version optional businessmodel string the order’s business model. it can have one optional 53.0 of these values: • b2b • b2c 1618apex reference guide connectapi input classes property type description required or available version optional externalreference string used internally to prevent duplicate records. optional 56.0 identifier this value is case-sensitive. name string specifies an ordernumber to assign to the optional 50.0 order summary. orderid string id of the original order. required 48.0 orderlifecycletype string specifies whether the order is managed in optional 49.0 salesforce order management or by an external system. it can have one of these values: • managed—managed in salesforce order management. • unmanaged—managed by an external system. if no value is specified, the default is managed. sourceprocess string describes the order process creating the optional 57.0 ordersummary. it can have one of these values: • orderonbehalf—an order on behalf of process. • standard—any process other than order on behalf of. if no value is specified, the default is standard. status string specifies a status to assign to the order optional 50.0 summary. the value must match one of the picklist values on the status field of the ordersummary object. see also: createordersummary(ordersummaryinput) connectapi.ordersummaryadjustmentaggregatesasyncinput order summary ids for calculating adjustment aggregates. property type description required or available version optional ordersummaryids list< string> list of order summary ids. required 55.0 1619apex reference guide connectapi input classes connectapi.ordertocartinput input for action adding an order to a cart. property type description required or available version optional cartstateorid string cart state (active or current) or the required 57.0 id of the cart to which the products from an order are to be copied. connectapi.paymentgrouprequest payment group input consumed by a payment group service. property type description required or available version optional createpaymentgroup boolean specifies whether salesforce needs to create optional 50.0 a payment group (true) or not (false). currencyisocode string three-letter iso 4217 currency code optional 50.0 associated with the payment group record. id string id of the payment group record. optional 50.0 sourceobjectid string source object id of the payment group optional 50.0 record. supports only orderid. connectapi.paymentmethodtokenizationrequest payment method tokenization input consumed by the payment tokenization service. subclass of connectapi.baserequest. property type description required or available version optional address connectapi. address of the payment method. required 52.0 addressrequest cardpaymentmethod connectapi. object representation of the card payment required 52.0 cardpaymentmethodrequest method. paymentgatewayid string id of the card payment method's payment required 52.0 gateway. connectapi.photoinput specify how to crop a photo that has already been uploaded. 1620apex reference guide connectapi input classes property type description available version cropsize integer the length, in pixels, of any edge of the crop square. 29.0 cropx integer the position x, in pixels, from the left edge of the image to the start of 29.0 the crop square. top left is position (0,0). cropy integer the position y, in pixels, from the top edge of the image to the start of 29.0 the crop square. top left is position (0,0). fileid string 18 character id of an existing file. the key prefix must be 069 and the file 25.0 must be an image and be smaller than 2 gb. note: images uploaded on the group page and on the user page don’t have file ids and therefore can’t be used. versionnumber integer version number of the existing content. if not provided, the latest version 25.0 is used. see also: setphotowithattributes(communityid, groupid, photo) setphotowithattributes(communityid, groupid, photo, fileupload) updaterecommendationdefinitionphotowithattributes(communityid, recommendationdefinitionid, photo) updaterecommend |
ationdefinitionphotowithattributes(communityid, recommendationdefinitionid, photo, fileupload) setphotowithattributes(communityid, userid, photo) setphotowithattributes(communityid, userid, photo, fileupload) connectapi.pincapabilityinput pin or unpin a feed element to a feed. property type description required or available version optional entityid string id of the entity to pin or unpin. in version required 41.0 41.0 and later, entityid must be a feed item id. in version 41.0–42.0, only one feed item can be pinned per feed. in version 43.0 and later, three feed items can be pinned per feed. ispinned boolean specifies whether to pin (true) or unpin required 41.0 (false) the entity. connectapi.pollcapabilityinput create, update, or vote on a poll on a feed element. this class is a subclass of connectapi.feedelementcapabilityinput. 1621apex reference guide connectapi input classes property type description required or available version optional choices list<string> the choices used to create a new poll. you required for creating 32.0 must specify 2–10 poll choices for each poll. a poll mychoiceid string id of an existing choice on the feed poll. required for voting 32.0 used to vote on an existing poll. on a poll see also: connectapi.feedelementcapabilitiesinput connectapi.postauthrequest payment post authorization input consumed by the payment post authorization service. subclass of connectapi.baserequest property type description required or available version optional accountid string id of the account of the customer for the required 54.0 authorized payment. amount double amount of the post authorization. required 54.0 comments string comments for payment post authorization. optional 54.0 maximum of 1000 characters. currencyisocode string three-letter iso 4217 currency code optional 54.0 associated with the payment group record. effectivedate datetime date that the payment post authorization required 54.0 occurs. paymentgatewayid string payment gateway that evaluates the post required 54.0 authorization. paymentgroup connectapi. payment group associated with or to be optional 54.0 paymentgrouprequest created for the request. request must contain either a paymentgroupid or paymentgroup, but not both. paymentmethod connectapi. payment method sent for the post required. 54.0 postauthapi authorization. paymentmethodrequest connectapi.postauthapipaymentmethodrequest payment method input for post authorization. subclass of connectapi.baseapipaymentmethodrequest 1622apex reference guide connectapi input classes property type description required or available version optional alternativepaymentmethod connectapi. alternative payment method. required 54.0 alternativepayment method cardpaymentmethod connectapi. card payment method. required 54.0 cardpayment methodrequest connectapi.pricinginput pricing for multiple products. property type description required or available version optional pricinglineitems list<connectapi. up to 500 line items for pricing. required 49.0 pricinglineiteminput> connectapi.pricinglineiteminput pricing line item. property type description required or available version optional productid string id of the product to price. required 49.0 see also: connectapi.pricinginput connectapi.productsearchgroupinginput grouping information for product search results. property type description required or available version optional groupingoption connectapi. grouping option for search results. values required 52.0 commercesearch are: groupingoption • nogrouping—search results aren’t grouped. • variationparent—search results are grouped by the variation parent. 1623apex reference guide connectapi input classes property type description required or available version optional topproducttype connectapi. type of the top product to return for each optional 52.0 commercesearch product group in search results. value is: topproducttype • variationparent if nogrouping is specified for groupingoption, topproducttype is ignored. connectapi.productsearchinput product search. property type description required or available version optional categoryid string category id returns results for products in required if 52.0 this category or its subcategories. searchterm isn’t specified fields list<string> |
product fields to return in search results. optional 52.0 search results include fields you have access to. if unspecified, all accessible fields are returned. grouping connectapi. specifies whether to group products in optional 52.0 productsearch search results and how to group them. if groupinginput unspecified, the default is the value specified in search > results display settings > results grouping. includeprices boolean specifies whether to include prices for optional 52.0 products in search results (true) or not (false). if unspecified, defaults to false. includequantity boolean specifies whether to include purchase optional 52.0 rule quantity rule information for products in search results (true) or not (false). if unspecified, defaults to false. page integer number of the page you want returned. optional 52.0 starts at 0. if you pass in null or 0, the first page is returned. pagesize integer specifies the number of items per page. optional 52.0 valid values are from 1 through 200. if unspecified, the default is the value specified in results per page in search > results display settings. 1624apex reference guide connectapi input classes property type description required or available version optional refinements list<connectapi. list up to nine refinements (facets) for optional 52.0 refinementinput> search results. buyers or shoppers can select up to 20 values for each refinement. searchterm string list of up to 32 space-separated search required if 52.0 terms. categoryid isn’t specified sortruleid string id of the sort rule that specifies the order of optional 52.0 products in the search results. connectapi.promotioncartinput cart during promotion evaluation. property type description required or available version optional cartitems list<connectapi. a collection of items in the cart. required 57.0 promotioncart iteminput> currencyisocode string three-letter iso 4217 currency code required for 57.0 associated with the cart. multi-currency orgs id string id of the cart. optional 57.0 see also: connectapi.promotionevaluateinput evaluate(salestransaction) connectapi.promotioncartdeliverygroupinput ids of the cart delivery group and its delivery method. property type description required or available version optional cartdelivery string id of the cart delivery group. required 57.0 groupid deliverymethodid string id of the order delivery method. required 57.0 see also: connectapi.promotionevaluateinput evaluate(salestransaction) 1625apex reference guide connectapi input classes connectapi.promotioncartiteminput item in a cart during promotion evaluation. property type description required or available version optional cartdelivery string id of the cart delivery group. required when 57.0 groupid evaluating shipping promotions cartid string id of the cart. optional 57.0 id string id of the cart item. must be unique across required 57.0 all items in the cart. itemdescription string description of the cart item. optional 57.0 itemname string name of the cart item. optional 57.0 listprice string list price of the cart item. optional 57.0 product2id string product id of the cart item. required if sku isn’t 57.0 specified quantity string number of items in the cart. required 57.0 salesprice string sales price of the cart item. this is the price required if 57.0 per quantity and the value used to compute totallinebaseamount the discount. if salesprice and isn’t specified totallinebaseamount are specified, totallinebaseamount is used. sku string stock keeping unit (sku) of the cart item. required if 57.0 product2id isn’t specified totallinebase string total amount for the cart item, equal to sales required if 57.0 amount price multiplied by quantity. this value is salesprice isn’t used to compute the discount. if specified salesprice and totallinebaseamount are specified, totallinebaseamount is used. totallistbase string total amount for the cart item based on list optional 57.0 amount price and quantity. 1626apex reference guide connectapi input classes property type description required or available version optional type connectapi. type of item in a cart. values are: required when 57.0 cartitemtype evaluating shipping • deliverycharge promotions • product see also: connectapi |
.promotioncartinput connectapi.promotionevaluateinput evaluate(salestransaction) connectapi.promotionevaluateinput find promotions that the customer is eligible for and compute their discounts. property type description required or available version optional cart connectapi.promotioncart cart and its items. required 57.0 input cartdelivery list<connectapi. list of cart delivery groups associated with required when 57.0 groups promotioncartdelivery the items in the cart. available if shipping evaluating shipping groupinput> promotions are enabled. promotions couponcodes list<string> list of coupon codes to enable promotions. optional 57.0 a customer can apply a maximum of two coupons per cart. effectiveaccount string id of the account for which the request is required if 57.0 id made. segments isn’t specified isitemizeheader boolean specifies whether order-level adjustments optional 57.0 adjustments are itemized (true) or not (false). if unspecified, the default value is false. parentproducts list<connectapi. map of the parent product id to its variation optional 57.0 promotionparent product ids. productsinput> productcategories list<connectapi. map of product ids to their associated optional 57.0 promotionproduct category ids. categoriesinput> segments list<string> all promotions associated with promotion optional 57.0 segments specified in this list are active and can be evaluated against the cart. additionally, any segments associated with 1627apex reference guide connectapi input classes property type description required or available version optional a store or buyer group are also still evaluated against the cart. if this field is not present, only the promotions associated with a store or buyer group are evaluated. webstoreid string id of the store for which the request is optional 57.0 made. if unspecified, defined segments must be used instead. see also: evaluate(salestransaction) connectapi.promotionparentproductsinput ids of a parent product and variation product. property type description required or available version optional childproductid string id of the variation product. required 57.0 parentproductid string id of the parent product. required 57.0 see also: connectapi.promotionevaluateinput evaluate(salestransaction) connectapi.promotionproductcategoriesinput ids of a product and associated category. property type description required or available version optional categoryid string id of the category. required 57.0 productid string id of the product. required 57.0 see also: connectapi.promotionevaluateinput evaluate(salestransaction) 1628apex reference guide connectapi input classes connectapi.quantitywithskuinputrepresentation a quantity of a product. property type description required or available version optional quantity double quantity of the product. required 51.0 stockkeepingunit string sku of the product. required 51.0 connectapi.questionandanswerscapabilityinput create or edit a question feed element or set the best answer of the existing question feed element. this class is a subclass of connectapi.feedelementcapabilityinput. property type description required or available version optional bestanswerid string a comment id to use as a best answer for a required to update 32.0 question feed element. the best answer a feed element. comment must already exist on the not supported when question feed element. posting a feed element. questiontitle string title for a question feed element. required to post a 32.0 feed element. to edit the title of a question, use updatefeedelement(communityid, not supported when feedelementid, feedelement). updating a feed editing question titles is supported in element. version 34.0 and later. see also: edit a question title and post connectapi.feedelementcapabilitiesinput connectapi.rankaveragedistanceinputrepresentation an order recipient’s geographic location and information about sets of inventory locations that can fulfill the order. property type description required or available version optional deliverycountrycode string the country code of the order recipient. required 51.0 deliverypostalcode string the postal code of the order recipient. required 51.0 1629apex reference guide connectapi input classes property type description required or available version optional distanceunit string specify mi or km to return average 51.0 distances in miles or kilometers, respectively. sortresult string specify asc or desc to rank the results 51 |
.0 by average shipping distance in ascending or descending order, respectively. targetlocations list<connectapi. each element is a set of inventory locations at least one element 51.0 targetlocation that can combine to fulfill the order. is required inputrepresentation> connectapi.readbycapabilityinput mark feed elements as read by the context user. this class is a subclass of connectapi.feedelementcapabilityinput. property type description required or available version optional isreadbyme boolean specifies to mark the feed element as read required 40.0 (true) for the context user. lastreaddatebyme datetime specifies the last date, in iso 8601 format, optional 40.0 when the feed element is marked as read for the context user. if you don’t specify a date or you specify a future date, the current system date is used. see also: connectapi.feedelementcapabilitiesinput connectapi.sequenceorderpaymentsummaryinputrepresentation amount to apply to specified orderpaymentsummary as part of a payment or refund. property type description required or available version optional amount double amount to apply to the optional 56.0 orderpaymentsummary. 1630apex reference guide connectapi input classes property type description required or available version optional orderpayment string id of the orderpaymentsummary to apply required 56.0 summaryid the amount to. see also: ensurerefundsasync(ordersummaryid, ensurerefundsinput) connectapi.ensurerefundsasyncinputrepresentation connectapi.recipientengagementcontextinput context based on which the survey invitation is sent to a participant. property type description required or available version optional recipient map<string, string> map each recipient with the context based required 50.0 engagement on which the survey invitation is emailed. context recipientid string participant id with whom the engagement required 50.0 context should be associated. see also: connectapi.surveyinvitationemailinput connectapi.recommendationaudienceinput a custom recommendation audience. property type description required or available version optional criteria connectapi. the criteria for the custom recommendation optional 36.0 audiencecriteria audience type. if not specified when input creating a recommendation audience, the audience criteria type defaults to custom list. 1631apex reference guide connectapi input classes property type description required or available version optional memberoperation connectapi. required to update 35.0 only important: this property is type recommendation a recommendation available only in version 35.0. in audiencemember audience version 36.0 and later, use operationtype don’t use or specify connectapi. null to create a customlistaudiencecriteriainput. recommendation the operation to carry out on the audience audience members. • add—adds specified members to the audience. • remove—removes specified members from the audience. members list<string> required to update 35.0 only important: this property is a recommendation available only in version 35.0. in audience version 36.0 and later, use don’t use or specify connectapi. null to create a customlistaudiencecriteriainput. recommendation a collection of user ids. audience when updating an audience, you can include up to 100 members. an audience can have up to 100,000 members, and each experience cloud site can have up to 100 audiences. name string the unique name of the custom optional to update a 35.0 recommendation audience. recommendation audience required to create a recommendation audience see also: createrecommendationaudience(communityid, recommendationaudience) connectapi.recommendationdefinitioninput a custom recommendation definition. 1632 |
apex reference guide connectapi input classes property type description required or available version optional actionurl string url for acting on the custom required to create a 35.0 recommendation, for example, the url to recommendation join a group. definition optional to update a recommendation definition actionurlname string text label for the action url in the user required to create a 35.0 interface, for example, “launch.” recommendation definition optional to update a recommendation definition explanation string explanation, or body, of the custom required to create a 35.0 recommendation. recommendation definition optional to update a recommendation definition name string name of the custom recommendation required to create a 35.0 definition. the name is displayed in setup. recommendation definition optional to update a recommendation definition title string title of the custom recommendation optional 35.0 definition. see also: createrecommendationdefinition(communityid, recommendationdefinition) connectapi.recommendationreactioninput a reaction to a recommendation produced by a recommendation strategy. property type description required or available version optional aimodel string reserved for future use. optional 47.0 1633apex reference guide connectapi input classes property type description required or available version optional contextrecordid string id of the context record. for example, if the optional 45.0 next best action is on a case detail page, the id of the case. executionid string id of the original recommendation strategy optional 45.0 execution. externalid string external id of the recommendation. this id optional 46.0 doesn’t need to be a salesforce 18-character id. for example, it can be a product number from an external system. onbehalfofid string id of the user or entity for which the optional 45.0 reaction took place. reactiontype connectapi. type of reaction to a recommendation. required 45.0 recommendation values are: reactiontype • accepted • rejected recommendation string reserved for future use. optional 46.0 mode recommendation double reserved for future use. optional 46.0 score strategyname string name of the recommendation strategy. required 45.0 targetactionid string id of the target action. optional 45.0 targetactionname string name of the target action. required 45.0 targetid string id of the recommendation that is being required 45.0 reacted to. connectapi.recordcapabilityinput attach an existing knowledge article to a comment. this class is a subclass of connectapi.feedelementcapabilityinput. property type description required or available version optional recordid string id of the existing knowledge article to required 42.0 attach. 1634apex reference guide connectapi input classes connectapi.recordsetfiltercriteriainput a set of recordset filter criteria applied to records, such as service appointment records. property type description required or available version optional criteriaids list<string> recordset filter criteria ids. required 53.0 enforcesharing boolean determines whether record sharing checks optional 53.0 are enforced (true) or not (false) during the execution of this call. filteredobjectname string object that the filter is applied to. required 53.0 recordids list<string> list of record ids of the filtered object. required 53.0 connectapi.referencedrefundrequest referenced refund input. subclass of connectapi.refundrequest. property type description required or available version optional accountid string id of the account linked to the referenced optional 50.0 refund request. amount double amount refunded. required 50.0 clientcontext string context for payment apis. used for a optional 50.0 payment caller to re-establish context. comments string optional comments for the refund. optional 50.0 effectivedate datetime date when the refund becomes effective. optional 50.0 paymentgroup connectapi. payment group details associated with the optional 50.0 paymentgrouprequest refund request. connectapi.refinementinput attribute-based refinement input for product search. this class is abstract and is a superclass of connectapi.distinctvaluerefinementinput. property type description required or available version optional attributetype connectapi. search attribute type. required 52.0 commercesearch • custom attributetype • productattribute 1635apex reference guide connectapi input classes property type description required or available version optional • standard nameorid string developer name |
of the attribute. in version required 52.0 52.0 and later, the id of the attribute isn’t supported. type connectapi. search facet type. value is: required 52.0 commercesearch • distinctvalue facettype connectapi.refundrequest refund input. this class is abstract. subclass of connectapi.baserequest. no additional properties. superclass of connectapi.referencedrefundrequest. connectapi.releaseheldfocapacityinputrepresentation request to release held fulfillment order capacity at one or more locations. can correspond to one action call. property type description required or available version optional releaseheldfo list<connectapi. list of requests to release held fulfillment required 55.0 capacityrequests releaseheldfo order capacity at one or more locations. capacityrequest inputrepresentation> connectapi.releaseheldfocapacityrequestinputrepresentation request to release held fulfillment order capacity at one or more locations. property type description required or available version optional allornothing boolean controls whether a single failed request optional 55.0 cancels all other requests in the list (true) or whether some requests can succeed if others fail (false). the default value is false. 1636apex reference guide connectapi input classes property type description required or available version optional capacityrequests list<connectapi. list of requests to release held fulfillment required 55.0 capacityrequest order capacity. each request is for capacity inputrepresentation> for one fulfillment order held at one location. connectapi.requestheaderinput an http request header name and value pair. property type description required or available version optional name string the name of the request header. required 33.0 value string the value of the request header. required 33.0 see also: define an action link and post with a feed element connectapi.returnitemsinputrepresentation data about products and delivery charges to return, as well as associated return fees. property type description required or available version optional returnorderitem list<connectapi. list of returnorderlineitems to return that optional 52.0 deliverycharges returnorderitem represent delivery charges. deliverycharge inputrepresentation> returnorderitemfees list<connectapi. list of returnorderlineitems to process that optional 56.0 returnorderitemfee represent return fees. inputrepresentation> returnorderitems list<connectapi. list of returnorderlineitems to process that required 52.0 returnorderitem represent products, along with data about inputrepresentation> how to process them. see also: returnitems(returnorderid, returnitemsinput) connectapi.returnorderinputrepresentation data for creating a returnorder and returnorderlineitems. 1637apex reference guide connectapi input classes property type description required or available version optional ordersummaryid string id of the ordersummary containing the required 50.0 items to be returned. the ordersummary’s orderlifecycletype must be managed. returnorder string the lifecycletype of the returnorder. required 51.0 lifecycletype possible values are: • managed—process the returnorder using the apis and actions. it can generate change orders and affects financial fields and rollup calculations. • unmanaged—the returnorder is for tracking purposes only. it isn’t involved in any financial calculations and doesn’t generate any change orders. the system doesn’t prevent the creation of duplicate returnorderlineitems in an unmanaged returnorder for the same orderitem. returnorderlineitems list<connectapi. list of data for creating at least one element 50.0 returnorderlineitem returnorderlineitems. is required inputrepresentation> status string status to assign the returnorder. this value required 51.0 must match an entry in the returnorder object’s status picklist. see also: createreturnorder(returnorderinput) connectapi.returnorderiteminputrepresentation id of a returnorderlineitem and instructions for updating it. after the update, the returnorderlineitem is read-only. any remaining quantity to be returned is added to a new returnorderlineitem. property type description required or available version optional quantityreceived double the quantity of the returnorderlineitem required 52.0 that has been received. the value must be zero or greater. this value isn’t used by any |
standard features, but is provided for use in customizations. quantityrejected double the quantity of the returnorderlineitem required 52.0 that has been rejected for return. the value 1638apex reference guide connectapi input classes property type description required or available version optional must be zero or greater. this value isn’t used by any standard features, but is provided for use in customizations. quantityreturned double the quantity of the returnorderlineitem required 52.0 that has been returned. the value must be greater than zero. if this value plus quantitytocancel is less than the expected return quantity, then the remaining quantity to be returned is added to a new returnorderlineitem. quantitytocancel double the quantity of the returnorderlineitem to required 52.0 remove because it’s not being returned. the value must be zero or greater. if this value plus quantityreturned is less than the expected return quantity, then the remaining quantity to be returned is added to a new returnorderlineitem. reasonforrejection string the reason why the rejected quantity, if any, optional 52.0 was rejected. this value isn’t used by any standard features, but is provided for use in customizations. returnorder string the id of the returnorderlineitem. required 52.0 lineitemid see also: connectapi.returnitemsinputrepresentation returnitems(returnorderid, returnitemsinput) connectapi.returnorderitemdeliverychargeinputrepresentation id of a returnorderlineitem representing a delivery charge. property type description required or available version optional returnorder string id of a returnorderlineitem to return. required 52.0 lineitemid see also: connectapi.returnitemsinputrepresentation returnitems(returnorderid, returnitemsinput) 1639apex reference guide connectapi input classes connectapi.returnorderitemfeeinputrepresentation id of a returnorderlineitem representing a return fee, and instructions for updating it. after the update, the returnorderlineitem is read-only. any remaining quantity of the fee to be processed is added to a new returnorderlineitem. property type description required or available version optional quantityreturned double quantity of the returnorderlineitem to required 56.0 process. when the fee is a fixed amount, the charge is determined by multiplying the total fee amount by this value divided by the expected quantity. for example, if the fee amount is $10 and the expected quantity is 2, then if the quantityreturned is 1, $5 is charged. this value normally equals the quantity returned of the returnorderlineitem for the returned item that the fee applies to. the value must be greater than zero. if this value plus quantitytocancel is less than the expected quantity, then the remaining quantity to be returned is added to a new returnorderlineitem. quantitytocancel double quantity of the returnorderlineitem to required 56.0 remove. this value normally equals the quantity canceled of the returnorderlineitem for the returned item that the fee applies to. this value can also be used to cancel a portion of the fee. the value must be zero or greater. if this value plus quantityreturned is less than the expected quantity, then the remaining quantity to be returned is added to a new returnorderlineitem. returnorder string id of the returnorderlineitem representing required 56.0 lineitemid the return fee. see also: connectapi.returnitemsinputrepresentation returnitems(returnorderid, returnitemsinput) connectapi.returnorderlineiteminputrepresentation data for creating a returnorderlineitem for an order item being returned, including data to create returnorderlineitems representing any return fees associated with it. 1640apex reference guide connectapi input classes property type description required or available version optional canreduceshipping boolean whether to refund any associated shipping required 50.0 charge. orderitemsummaryid string id of the associated orderitemsummary. if required 50.0 the orderitemsummary already has an associated returnorderlineitem, then you must specify a different reasonforreturn. duplicating the reason breaks the financial calculations. quantityexpected double quantity expected to be returned. this value required 50.0 also applies to any fees specified in returnorderlineitemfees. quantityreceived double quantity already physically returned. optional 50.0 reasonforreturn string |
reason for the return. the value must match required if the 50.0 an entry in both the ordersummarychange returnorder reason field and the returnorderlineitem lifecycletype object’s reasonforreturn picklist. is managed. returnorder list<connectapi. list of input data for return fees associated optional 56.0 lineitemfees returnorder with the order item being returned. a lineitemfee returnorderlineitem of type fee is created inputrepresentation> to represent each fee. see also: connectapi.returnorderinputrepresentation createreturnorder(returnorderinput) connectapi.returnorderlineitemfeeinputrepresentation data for creating a returnorderlineitem that represents a return fee. property type description required or available version optional amount double value used to calculate the fee amount, as required 56.0 described by the amounttype. it must be a positive value. amounttype string describes how the fee amount is calculated. required 56.0 it can have one of these values: • amountwithtax—value of amount is the fee amount, including tax. 1641apex reference guide connectapi input classes property type description required or available version optional • amountwithouttax—value of amount is the fee amount, not including tax. tax is calculated on the value and added. • percentage—value of amount is a percentage. to determine the fee amount, amount is divided by 100, and then multiplied by the totalprice and totaltaxamount of the associated orderitemsummary, prorated for the quantity being returned. • percentagegross—value of amount is a percentage. to determine the fee amount, amount is divided by 100, and then multiplied by the totallineamountwithtax of the associated orderitemsummary, prorated for the quantity being returned. description string description of the fee. required 56.0 product2id string id of the product representing the fee. required 56.0 reason string reason for the fee. the value must match required 56.0 an entry in the returnorderlineitem object’s reasonforreturn picklist. see also: connectapi.returnorderinputrepresentation createreturnorder(returnorderinput) connectapi.returnorderlineiteminputrepresentation connectapi.salerequest payment sale input consumed by the payment sale service. subclass of connectapi.baserequest. property type description required or available version optional accountid string reference to account. required 54.0 amount double the amount of the sale request. required 54.0 comments string optional comment for the sale request. optional 54.0 1642apex reference guide connectapi input classes property type description required or available version optional currencyisocode string three-letter iso 4217 currency code required 54.0 associated with the payment output. effectivedate datetime date that the sale request takes effect. required 54.0 paymentgatewayid string the payment gateway that receives the sale required 54.0 request. paymentgroup connectapi.paymentgrouprequest payment group information for the sale optional 54.0 request. paymentmethod connectapi.saleapipaymentmethodrequest payment method used within the sale reqiured 54.0 request. connectapi.saleapipaymentmethodrequest payment method request for sale. subclass of connectapi.baseapipaymentmethodrequest. property type description required or available version optional cardpaymentmethod connectapi.cardpaymentmethodrequest payment method used in a sale request. required 54.0 connectapi.scheduledrecommendationinput a scheduled custom recommendation. property type description required or available version optional channel connectapi. a way to tie custom recommendations optional for creating 36.0 recommendation together. for example, display a scheduled channel recommendations in specific places in the recommendation ui or show recommendations based on time if not specified, of day or geographic locations. values are: defaults to • customchannel1—custom defaultchannel. recommendation channel. not used by don’t use when default. work with your community updating a manager to define custom channels. scheduled for example, community managers can recommendation 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. 1643apex reference guide connectapi input classes property type description required or available |
version optional • 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. use these channel values; you can’t rename or create other channels. enabled boolean indicates whether scheduling is enabled. if optional 35.0 true, 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. rank integer relative rank of the scheduled custom optional 35.0 recommendation indicated by ascending whole numbers starting with 1. setting the rank is comparable to an insertion into an ordered list. the scheduled custom recommendation is inserted into the position specified by the rank. the rank of all the scheduled custom recommendations after it is pushed down. 1644apex reference guide connectapi input classes property type description required or available version optional see ranking scheduled custom recommendations example. if the specified rank is larger than the size of the list, the scheduled custom recommendation is put at the end of the list. the rank of the scheduled custom recommendation is the size of the list, instead of the one specified. if a rank is not specified, the scheduled custom recommendation is put at the end of the list. recommendation string id of the audience for this scheduled custom optional 35.0 audienceid recommendation.when updating a scheduled custom recommendation, specify all to remove the association between a custom recommendation audience and a scheduled custom recommendation. recommendation string id of the custom recommendation required to create a 35.0 definitionid definition that this scheduled scheduled recommendation schedules. recommendation you can’t specify a recommendation definitionid when updating a scheduled recommendation. ranking scheduled custom recommendations example if you have these scheduled custom recommendations: scheduled recommendations rank scheduledrecommendationa 1 scheduledrecommendationb 2 scheduledrecommendationc 3 and you include this information in the scheduled custom recommendation input: scheduled recommendation rank scheduledrecommendationd 2 1645apex reference guide connectapi input classes the result is: scheduled recommendation rank scheduledrecommendationa 1 scheduledrecommendationd 2 scheduledrecommendationb 3 scheduledrecommendationc 4 see also: createscheduledrecommendation(communityid, scheduledrecommendation) connectapi.sellerdetailsrequest seller details for the tax calculation property type description required or available version optional code string code used to identify the seller of the taxed 55.0 items. connectapi.serviceappointmentinput contains information about the service appointment. property type description required or available version optional additionalinformation string the extra information about the service optional 53.0 appointment. appointmenttype string the type of the appointment. optional 53.0 city string the name of the city. optional 53.0 comments string the comments about the appointment. optional 53.0 contactid string the id of the contact associated with the optional 53.0 parent record. country string the name of the country. optional 53.0 description string the description of the appointment. optional 53.0 1646apex reference guide connectapi input classes property type description required or available version optional engagementchanneltypeid string id of the engagement channel type to optional 56.0 associate with the appointment. you can use engagement channel type only if: • schedule appointments using engagement channels is enabled in salesforce scheduler settings in your salesforce org. • shifts are defined in the scheduling policy. for more information on setting up shifts in the scheduling policy, see define shift rules in scheduling policy. note: engagement channel |
types are not supported with operating hours rules in the scheduling policy. extendedfields <stliconnectapi.extendedfieldinput> use to add values to any of the fields, optional 53.0 including custom fields. parentrecordid string the id of the parent record associated with required if lead 53.0 the account. isn’t provided. postalcode string the postal code of the city. optional 53.0 schedendtime datetime the time at which the appointment is optional 53.0 scheduled to end. schedstarttime datetime the time at which the appointment is optional 53.0 scheduled to start. serviceterritoryid string the id of the service territory associated optional 53.0 with the service appointment. state string the name of the state. optional 53.0 street string the name of the street. optional 53.0 subject string the short phrase describing the optional 53.0 appointment. worktypeid string the id of the work type associated with the optional 53.0 service appointment. if specified, it is added to the service appointment record. connectapi.shiftsfrompatterninput shifts from a pattern. 1647apex reference guide connectapi input classes property type description required or available version optional schedulingend string scheduling end date in yyyy-mm-dd required if 51.0 date format. scheduling occurrences provide schedulingenddate or isn’t provided schedulingoccurrences. don’t provide both. scheduling integer number of scheduling occurrences. required if 51.0 occurrences schedulingend provide schedulingenddate or date isn’t provided schedulingoccurrences. don’t provide both. schedulingstart string scheduling start date in yyyy-mm-dd required 51.0 date format. serviceresourceid string id of the service resource to assign shifts to. optional 51.0–52.0 in version 53.0 and later, use serviceresourceidlist. serviceresourceid list<string> list of service resource ids to assign shifts optional 53.0 list to. serviceterritoryid string id of the service territory to assign shifts to. optional 51.0 shiftstatus string status of the shifts. default values are: optional 52.0 • confirmed • published • tentative additional status values can be created. connectapi.socialpostmassapprovalinput list of social post ids and the action to approve or reject publishing them. property type description required or available version optional isapproved boolean specifies whether to approve (true) or optional 46.0 reject (false) publishing the social posts. if unspecified, defaults to false. socialpost list<string> a list of up to 200 social post ids. required 46.0 idlist 1648apex reference guide connectapi input classes connectapi.statuscapabilityinput change the status of a feed post or comment. this class is a subclass of connectapi.feedelementcapabilityinput. property type description required or available version optional feedentitystatus connectapi. status of the feed post or comment. values required 37.0 feedentitystatus are: • 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. • published—the feed post or comment is approved and visible. posts that have a status of pendingreview or published can’t be changed to a status of draft and vice versa. see also: connectapi.feedelementcapabilitiesinput connectapi.streamsubscriptioninput an entity to subscribe to for a chatter feed stream. property type description required or available version optional entityid string the id of any feed-enabled entity, such as required 39.0 a group, record, or user, that the context user can access. when subscribed, the entity’s feed is included in the feed stream. see also: connectapi.chatterstreaminput connectapi.surveyinvitationemailinput survey invitation email. 1649apex reference guide connectapi input classes property type description required or available version optional allowguest boolean specifies whether participants who don't required 50.0 |
userresponse have a salesforce account can respond (true) or not (false). allowparticipants boolean specifies whether participants can see their required 50.0 accesstheirresponse responses (true) or not (false). associaterecords list<connectapi. maps each recipient with another record optional 50.0 withrecipients associaterecordswith that must be associated with the recipient's recipientinput> survey invitation. body string content of the email. specify the email body optional 50.0 in case you don't specify an email template. the email body must contain one of the following merge fields: • to embed a link to launch the survey: [[survey_invitation_url]] • to embed a survey question: {{{surveyquestion.questionname}}} and {{{surveyquestion.questionhtmlcontent}}} collectanonymous boolean specifies whether participants can respond required 50.0 response anonymously (true) or not (false). communityid string id of the site that's used to open the survey optional 50.0 for users outside your org. emailtemplateid string id of the lightning email template that's optional 50.0 used to send the survey invitation. the template must contain the required merge fields that embed either the survey link or a question in the email. only lightning email templates are used to send survey invitations. fromemailaddress string email id of the user or the org-wide email required 50.0 address associated with the user's profile. invitation datetime date on which the survey invitation expires. optional 50.0 expirationdate invitationowner string id of the owner of the survey invitation optional 50.0 records. ispersonal boolean specifies whether an unique invitation is required 50.0 invitation created for each participant (true) or not (false). when a participant responds using a personal invitation, the response record is associated with the participant's salesforce record. 1650apex reference guide connectapi input classes property type description required or available version optional recipient list<connectapi. maps each recipient with the context based optional 50.0 engagement recipientengagement on which the survey invitation is emailed. contexts contextinput> recipients list<string> list of up to 300 ids of leads, contacts, or required 50.0 users to whom the survey invitation is emailed. shareinvitations list<string> ids of the users with whom the survey optional 50.0 with invitation records must be shared. the invitation records are shared with read access. subject string subject of the email. specify the subject in optional 50.0 case you don't specify an email template. surveyquestion list<string> ids of the questions that are embedded in optional 50.0 ids the email. you can send an email invitation for questions of the following types: net promoter score (nps), rating, and score. connectapi.targetcollectioninput collection of targets to create. property type description required or available version optional targets list<connectapi. list of targets to create. required 48.0 targetinput> connectapi.targetcollectionupdateinput collection of targets to update. property type description required or available version optional targets list<connectapi. list of targets to update. required 48.0 targetupdate input> connectapi.targetlocationinputrepresentation a set of inventory locations that together can fulfill an order. 1651apex reference guide connectapi input classes property type description required or available version optional locations list<connectapi. a list of locations with information about required 51.0 locationinputrepresentation> their country and postal codes. connectapi.targetinput target to create. property type description required or available version optional audienceid string id of the audience to assign to the target. required 48.0 groupname string group name of the target. groups bundle required 48.0 related target and audience pairs.you can have up to 2,000 groups and 500 targets per group.to determine the group name for targets of type experiencevariation, see personalization target developer and group names in the experience cloud developer guide. priority integer priority of the target. within a group, priority optional 48.0 determines which target is returned if the user matches more than one audience. publishstatus connectapi. the publish status of the target. values are: optional 48.0 publishstatus • draft • live we recommend setting the publish status to draft. |
if you specify live, your changes revert after you publish the site. targettype string type of target, indicating the nature of the required 48.0 data being targeted.supported values include: • experiencevariation (version 48.0 and later) • custom object api names, such as customobjectname__c (version 48.0 and later) • navigationlinkset (version 49.0 and later) • topic (version 49.0 and later) 1652apex reference guide connectapi input classes property type description required or available version optional • collaborationgroup (version 49.0 and later) • knowledgearticle (version 49.0 and later) • contentdocument (version 49.0 and later) • managedcontent (version 49.0 and later) • report (version 49.0 and later) • dashboard (version 49.0 and later) you can have up to 2,500 experiencevariation targets and 25,000 record targets. targetvalue string value of the target.if targettype is required 48.0 experiencevariation, targetvalue is the developer name of the experience variation. if targettype is customobjectname__c, targetvalue is the id of the custom object.to determine the developer name for targets of type experiencevariation, see personalization target developer and group names in the experience cloud developer guide. see also: connectapi.targetcollectioninput connectapi.targetupdateinput target to update. property type description required or available version optional audienceid string id of the audience to assign to the target. required if 48.0 priority isn’t specified. otherwise, optional 1653apex reference guide connectapi input classes property type description required or available version optional priority integer priority of the target. within a group, priority required if 48.0 determines which target is returned if the audienceid isn’t user matches more than one audience. specified. otherwise, optional targetid string id of the target to update. required 48.0 see also: connectapi.targetcollectionupdateinput connectapi.calculatetaxrequest request to sent through the tax adapter to the external tax engine. inputs with a taxtransactiontype of debit represent a tax calculation request. inputs with a taxtransactiontype of credit represent a tax cancellation request. subclass of connectapi.taxtransactionrequest. property type description required or available version optional iscommit boolean commits the transaction for tax calculation. required 55.0 taxengineid string id of the salesforce tax engine entity used required 55.0 to represent the external tax engine. taxtransactiontype connectapi. type of tax transaction. values are: required 55.0 taxtransaction • credit—transaction is a credit type transaction. • debit—transaction is a debit transaction. taxtype connectapi. type of tax calculation. values are: required 55.0 calculatetax • actual—calculated tax represents type the final taxed amount for the transaction. • estimated—calculated tax represents only an estimated value before the transaction is finalized. connectapi.taxaddressrequest address input representation for tax calculation. 1654apex reference guide connectapi input classes name type description required or available version optional city string city. optional 55.0 country string country. optional 55.0 latitude double latitude. optional 55.0 locationcode string location code. optional 55.0 longitude double longitude. optional 55.0 postalcode string postal code. optional 55.0 state string state. optional 55.0 street string street. optional 55.0 connectapi.taxaddressesrequest addresses, including the bill to address, ship from address, ship to address, and sold to address. name type description required or available version optional billto connectapi. bill to address. optional 55.0 taxaddress request shipfrom connectapi. ship from address. optional 55.0 taxaddress request shipto connectapi. ship to address. optional 55.0 taxaddress request soldto connectapi. sold to address. optional 55.0 taxaddress request connectapi.taxcustomerdetailsrequest customer details for the tax calculation. property type description required or available version optional accountid string id of the customer's account. optional 55.0 code string customer code. optional 55.0 exemptionno string tax exemption number. optional |
55.0 1655apex reference guide connectapi input classes property type description required or available version optional exemptionreason string tax exemption reason. optional 55.0 connectapi.taxlineitemrequest a list of line items passed to the tax engine for tax calculation. property type description required or available version optional addresses connectapi. addresses, including the bill to address, ship optional 55.0 taxaddresses from address, ship to address, and sold to request address. amount double amount of the line item. optional 55.0 description string description of the line item. optional 55.0 effectivedate datetime date to apply the tax calculation to the line optional 55.0 item. linenumber string line number of the line item. optional 55.0 productcode string product code of the line item. optional 55.0 quantity double quantity of the line item. optional 55.0 taxcode string tax code for the line item. optional 55.0 connectapi.taxtransactionrequest information about the tax transaction sent to the tax adapter as part of a tax calculation request. this class is abstract. superclass of connectapi.calculatetaxrequest. property type description required or available version optional addresses connectapi. addresses, including the bill to address, ship optional 55.0 taxaddresses from address, ship to address, and sold to request address. currencyisocode string three-letter iso 4217 currency code optional 55.0 associated with the payment group record. customerdetails connectapi. customer details for the tax calculation. optional 55.0 taxcustomer detailsrequest 1656apex reference guide connectapi input classes property type description required or available version optional description string information about whether the tax optional 55.0 transaction failed or was successful. documentcode string document code. optional 55.0 effectivedate datetime the date that tax is applied to the taxed required 55.0 entity. lineitems list<connectapi. the line items on which tax was calculated. required 55.0 taxline itemrequest> referencedocumentcode string the original document code. used in case optional 55.0 of subsequent transactions such as credit tax. referenceentityid string id of the reference entity used during tax optional 55.0 calculation. transactiondate datetime the date that the tax transaction occurred. optional 53.0 connectapi.textsegmentinput include a text segment in a feed item or comment. subclass of connectapi.messagesegmentinput property type description available version text string plain text for this segment. if hashtags or links are detected in text, 28.0 they’re included in the comment as hashtag and link segments. mentions aren’t detected in text and aren’t separated out of the text. mentions require connectapi.mentionsegmentinput. see also: edit a comment edit a feed element edit a question title and post post a rich-text feed element with inline image connectapi.messagebodyinput connectapi.topicinput update a topic’s name or description or merge topics. 1657apex reference guide connectapi input classes property type description available version description string description of the topic 29.0 idstomerge list<string> list of up to five secondary topic ids to merge with the primary topic 33.0 if any of the secondary topics are navigational or featured topics, they lose their topic type, topic images, and children topics. their feed items are reassigned to the primary topic. if you merge a topic with a content topic, the content associations are preserved. if you merge a topic with an inactive endorsee, the endorsement isn’t mapped to the primary topic. name string name of the topic 29.0 use this property to change only the capitalization and spacing of the topic name. see also: updatetopic(communityid, topicid, topic) connectapi.topicnamesinput a list of topic names to replace currently assigned topics. also a list of suggested topics to assign. property type description required or available version optional topicnames list<string> a list of up to 10 topic names for a feed item required 35.0 or 100 topic names for a record. topicsuggestions list<string> a list of suggested topics to assign to a optional 37.0 record or feed item to improve future topic suggestions. see also: reassigntopicsbyname(communityid, recordid, topicnames) connectapi.articletopicassignmentjobinput |
connectapi.topicscapabilityinput assign topics to a feed element. property type description required or available version optional contexttopic string name of the parent topic in the site to optional 38.0 name which the feed element belongs. 1658apex reference guide connectapi input classes property type description required or available version optional topics list<string> list of topics to assign to the feed element. required 38.0 see also: connectapi.feedelementcapabilitiesinput connectapi.updownvotecapabilityinput upvote or downvote a feed element or a comment. property type description required or available version optional vote connectapi. type of vote for a feed element or comment. required 41.0 updownvotevalue values are: • down • none • up connectapi.updateserviceappointmentinput contains information to update a service appointment. property type description required or available version optional serviceappointmentid string the id of the service appointment to be required 53.0 modified. assignedresources <tslcionnectapi.assignedresourcesinput> represents the service resources who are optional 53.0 assigned to a service appointment. when updating an appointment, pass the complete list of required resources. if you don’t pass a resource who is already assigned to the appointment, the api deletes that assigned resource. for example, suppose that an existing service appointment has assigned resources: a and b and you pass b and c in assigned resources in the patch request. the api checks the resource availability of b and c for existing work type and service territory, and if both are available, the service appointment gets updated with: • resource a—deleted 1659apex reference guide connectapi input classes property type description required or available version optional • resourceb—updated • resourcec—created however, if you don’t pass any of the assigned resources, the api assumes there’s no change. note: when creating an appointment, use extendedfields to add values to any of the fields, including custom fields, in assignedresources as long as you have edit access to those fields. lead connectapi.leadinput represents a prospect or lead. required if 53.0 serviceappointment note: required to create a service isn’t provided. appointment for unauthenticated guest users. schedulingpolicyid string the id of the optional 53.0 appointmentschedulingpolicy object. if no scheduling policy is passed in the request body, the default configurations are used. the only scheduling policy configuration that is used in determining time slots is the enforcement of account visiting hours. serviceappointment connectapi.serviceappointmentinput represents the service appointment details required if lead 53.0 to book an appointment. when updating isn’t provided. an appointment, pass only the fields that must be updated. note: when creating an appointment, use extendedfields to add values to any of the fields, including custom fields, in assignedresources as long as you have edit access to those fields. connectapi.userinput update a user’s about me information. 1660apex reference guide connectapi input classes property type description available version aboutme string the aboutme property of a connectapi.userdetail output 29.0 object. this property populates the about me section of the user profile, which is visible to all members of an experience cloud site or org. see also: updateuser(communityid, userid, userinput) connectapi.wishlistinput wishlist to create. property type description required or available version optional name string name of the wishlist. required 49.0 products list<connectapi. list of products to add to the wishlist. optional 49.0 wishlistitem input> connectapi.wishlistiteminput item to update or add to a wishlist. property type description required or available version optional productid string id of the product to update or add to the required 49.0 wishlist. see also: connectapi.wishlistinput connectapi.wishlistupdateinput wishlist name to update. property type description required or available version optional name string wishlist name to update. required 50.0 retired connectapi input classes these connectapi input classes are retired |
. 1661apex reference guide connectapi input classes in this section: connectapi.canvasattachmentinput used to attach a canvas app to a feed item. connectapi.contentattachmentinput used to attach existing content to a comment or feed item. connectapi.datacloudorderinput input representation for a datacloud order to purchase contacts or companies and retrieve purchase information. connectapi.feeditemattachmentinput used to attach a file to a feed item. connectapi.linkattachmentinput add links to a feed item. connectapi.newfileattachmentinput attach a new file to a feed item. connectapi.pollattachmentinput attach a poll to a feed item. connectapi.canvasattachmentinput used to attach a canvas app to a feed item. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, use connectapi.canvascapabilityinput. subclass of connectapi.feeditemattachmentinput. property type description available version description string optional. the description of the canvas app. 29.0–31.0 developername string 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. namespaceprefix string optional. the namespace prefix of the developer edition organization in 29.0–31.0 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 the title of the link used to call the canvas app. 29.0–31.0 connectapi.contentattachmentinput used to attach existing content to a comment or feed item. 1662apex reference guide connectapi input classes important: this class isn’t available in version 32.0 and later. in version 32.0 and later, use connectapi.contentcapabilityinput. subclass of connectapi.feeditemattachmentinput property type description available version contentdocumentid string id of the existing content. 28.0–31.0 connectapi.datacloudorderinput input representation for a datacloud order to purchase contacts or companies and retrieve purchase information. property type description required or available optional version companyids string a comma-separated list of required to 32.0 identification numbers for the purchase companies to be purchased. companies you can’t include any contact ids or your purchase fails. contactids string a comma-separated list of required to 32.0 identification numbers for the purchase contacts to be purchased. contacts you can’t include any company ids or your purchase fails. usertype connectdatacloudusertypeenum indicates the data.com user type to optional 32.0 be used. there are two user types. • monthly (default) • listpool see also: postorder(orderinput) connectapi.feeditemattachmentinput used to attach a file to a feed item. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, use connectapi.feedelementcapabilityinput. this class is abstract and has no public constructor. you can make an instance only of a subclass. superclass for: • connectapi.canvasattachmentinput • connectapi.contentattachmentinput • connectapi.linkattachmentinput 1663apex reference guide connectapi output classes • connectapi.newfileattachmentinput • connectapi.pollattachmentinput connectapi.linkattachmentinput add links to a feed item. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, use connectapi.linkcapabilityinput. subclass of connectapi.feeditemattachmentinput property type description available version url string url to be used for the link 28.0–31.0 urlname string title of the link 28.0–31.0 connectapi.newfileattachmentinput attach a new file to a feed item. important: this class isn’t |
available in version 32.0 and later. in version 32.0 and later, use connectapi.contentcapabilityinput. the actual binary file, that is the attachment, is provided as part of the binaryinput in the method that takes this attachment input, such as postfeeditem or postcomment. subclass of connectapi.feeditemattachmentinput property type description available version description string description of the file to be uploaded. 28.0–31.0 title string the title of the file. this value is required and is also used as the file 28.0–31.0 name. for example, if the title is my title, and the file is a .txt file, the file name is my title.txt. connectapi.pollattachmentinput attach a poll to a feed item. important: this class isn’t available in version 32.0 and later. in version 32.0 and later, use connectapi.pollcapabilityinput. subclass of connectapi.feeditemattachmentinput property type description available version pollchoices list<string> the text labels for the poll items. polls must contain between 2 to 10 poll 28.0–31.0 choices. connectapi output classes most connectapi methods return instances of connectapi output classes. 1664apex reference guide connectapi output classes all properties are read-only, except for instances of output classes created within test code. all output classes are concrete unless marked abstract in this documentation. all concrete output classes have no-argument constructors that you can invoke only from test code. see testing connectapi code. connectapi.abstractcartitem a cart item. this class is abstract. superclass of: • connectapi.cartitem • connectapi.cartitemwithoutprice property name type description available version cartid string id of the cart. 49.0 cartitemid string id of the item. 49.0 messagessummary connectapi. messages summary for the item. 49.0 cartmessagessummary name string name of the item. productdetails connectapi. summary of the product details. 49.0 cartitemproduct productid string id of the product. 49.0 quantity string quantity of the item. 49.0 type connectapi. type of item in a cart. values are: 49.0 cartitemtype • deliverycharge • product see also: connectapi.cartitemresult connectapi.abstractcontenthubitemtype an item type associated with a repository folder. this class is abstract. superclass of: • connectapi.contenthubitemtypedetail • connectapi.contenthubitemtypesummary 1665apex reference guide connectapi output classes property name type description available version contentstream connectapi. support for content streaming. values are: 39.0 support contenthub • contentstreamallowed streamsupport • contentstreamnotallowed • contentstreamrequired description string description of the item type. 39.0 displayname string display name of the item type. 39.0 id string id of the item type. 39.0 isversionable boolean indicates whether the item type can have versions. 39.0 url string url to the detailed information of the item type. 39.0 connectapi.abstractdirectoryentrysummary a directory entry with summary information. this class is abstract. superclass of: • connectapi.repositorygroupsummary • connectapi.repositoryusersummary property name type description available version domain string domain of the directory entry. 39.0 email string email of the directory entry. 39.0 id string id of the directory entry. 39.0 type connectapi. type of directory entry. values are: 39.0 contenthub • groupentry directoryentry • userentry type connectapi.abstractextensioninformation extension information. this class is abstract. superclass of .connectapi.lightningextensioninformation property name type description available version extension connectapi. information type of the extension. values are: 40.0 informationtype extensioninformation • lightning type 1666apex reference guide connectapi output classes connectapi.abstractgatewaycommonresponse payment gateway response fields commonly used in payment services. this class is abstract. superclass of connectapi.abstractgatewayresponse. property name type description available version gatewayavscode string used to verify the address mapped to a payment 50.0 method when the payments platform requests tokenization |
from the payment gateway. gatewaydate datetime date when the notification occurred. some gateways 50.0 don’t send this value. gatewaymessage string error messages that the gateway returned for the 50.0 notification request. maximum length of 255 characters. gatewayresultcode string gateway-specific result code. you can map the result 50.0 code to a salesforce-specific result code. maximum length of 64 characters. gatewayresultcodedescription string a description of the gateway-specific result code that 50.0 a payment gateway returned. maximum length of 1,000 characters. salesforceresultcode string the salesforce result code for the gateway result 50.0 code. connectapi.abstractgatewayresponse payment gateway response fields used in sale, authorization, and capture services. this class is abstract. subclass of connectapi.abstractgatewaycommonresponse. super class of: • connectapi.authreversalgatewayresponse • connectapi.authorizationgatewayresponse • connectapi.authorizationreversalresponse • connectapi.capturegatewayresponse • connectapi.paymentmethodtokenizationgatewayresponse • connectapi.postauthgatewayresponse • connectapi.refundgatewayresponse • connectapi.salegatewayresponse 1667apex reference guide connectapi output classes property name type description available version gatewayreferencedetails string provides information about the gateway 50.0 communication. gatewayreferencenumber string unique transaction id created by the payment 50.0 gateway. connectapi.abstractmanagedcontentdeliverydocument managed content delivery document. this class is abstract. superclass of: • connectapi.managedcontentdeliverydocument • connectapi.managedcontentdeliverydocumentsummary property name type description available version contentkey string globally unique identifier (guid) for the managed 55.0 content. contenttype connectapi. type of managed content. 55.0 managedcontent typesummary language string language locale of the managed content. 55.0 managedcontentid string id of the managed content. 55.0 publisheddate datetime most recent publish date of the managed content. 55.0 resourceurl string url to the single content delivery resource. 55.0 title string title of the managed content. 55.0 unauthenticatedurl string public url for the managed content. 55.0 urlname string url name of the managed content. 55.0 see also: connectapi.managedcontentdeliverydocumentcollection connectapi.abstractmanagedcontentreference managed content reference. this class is abstract. superclass of: • connectapi.managedcontentreference • connectapi.managedcontentreferencesummary 1668apex reference guide connectapi output classes property name type description available version contentkey string unique identifier for the managed content reference. 54.0 managedcontentid string id of the managed content reference. 54.0 resourceurl string url to the single content delivery resource. 55.0 see also: connectapi.managedcontentdeliverydocumentcollection connectapi.abstractmessagebody this class is abstract. superclass of: • connectapi.feedbody • connectapi.messagebody name type description available version isrichtext boolean indicates whether the body is rich text. 35.0 messagesegments list<connectapi. list of message segments 28.0 messagesegment> text string display-ready text. use this text if you don’t want to process 28.0 the message segments. connectapi.abstractnbaaction a recommended action of recommendation strategy. this class is abstract. superclass of connectapi.nbaflowaction. property name type description available version parameters list<connectapi. list of parameters to pass to the action. 45.0 nbaaction parameter> type connectapi. type of action. values are: 45.0 nbaactiontype • flow—automated process tool with multiple subtypes. see also: connectapi.nbarecommendation 1669apex reference guide connectapi output classes connectapi.abstractnbatarget a recommendation target of a recommendation strategy. this class is abstract. superclass of connectapi.nbanativerecommendation. property name type description available version type connectapi. type of target. values are: 45.0 nbatargettype • recommendation see also: connectapi.nbarecomm |
endation connectapi.abstractrecommendation a chatter, custom, or static recommendation. this class is abstract. superclass of: • connectapi.entityrecommendation • connectapi.nonentityrecommendation 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 explanation connectapi. the chatter, custom, or static recommendation 32.0 recommendation explanation. explanation platformaction connectapi. a platform action group instance with state 34.0 group platformaction appropriate for the context user. group recommendation connectapi. specifies the type of record being recommended. 32.0 type recommendationtype url string url for the chatter, custom, or static 34.0 recommendation. see also: connectapi.recommendationscapability connectapi.recommendationcollection 1670apex reference guide connectapi output classes connectapi.abstractrecommendationexplanation explanation for a chatter recommendation. this class is abstract. superclass of connectapi.recommendationexplanation. property name type description available version summary string summary explanation for the chatter 32.0 recommendation. type connectapi. indicates the reason for the chatter recommendation. 32.0 recommendation • articlehasrelatedcontent—articles explanationtype 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. 1671apex reference guide connectapi output classes property name type description available version • topicfollowedtogether—topics often followed together with the record that the context user just followed. • 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.abstractrecordfield a field on a record. this class is abstract. superclass of: • connectapi.blankrecordfield • connectapi.labeledrecordfield 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. 1672apex reference guide connectapi output classes name type description available version |
type string type of the field. one of these values: 29.0 • address • blank • boolean • compound • createdby • date • datetime • email • lastmodifiedby • location • name • number • percent • phone • picklist • reference • text • time see also: connectapi.recordviewsection connectapi.abstractrecordview 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. this class is abstract. subclass of connectapi.actorwithid superclass of: • connectapi.recordsummary • connectapi.recordview name type description available version name string the localized name of the record. 29.0 1673apex reference guide connectapi output classes connectapi.abstractrepositoryfile a repository file. this class is abstract. subclass of connectapi.abstractrepositoryitem. superclass of: • connectapi.repositoryfiledetail • connectapi.repositoryfilesummary property name type description available version checkincomment string checkin comment of the file. 39.0 contentbody string text of the file’s content if available, otherwise null. 43.0 contentsize integer length in bytes of the content of the file. 39.0 downloadurl string url to the repository file content. 39.0 external string url of this file’s content in the external system. 39.0 contenturl external string url of this file in the external system. 39.0 documenturl external connectapi. external file permission information, such as available 39.0 filepermission externalfile groups, available permission types, and current information permissioninformation sharing status, or null if includeexternalfilepermissionsinfo is false. mimetype string mime type of the file. 39.0 previewurl string url to the thumbnail preview (240 x 180 png). 39.0 thumbnail previewurl string url to the big thumbnail preview (720 x 480 png). 39.0 thumbnailbig previewurl string url to the tiny thumbnail preview (120 x 90 png). 39.0 thumbnailtiny previewsurl string url to the previews. 39.0 title string title of the file. 39.0 versionid string id of the file version in the external system. 39.0 connectapi.abstractrepositoryfolder a repository folder. this class is abstract. 1674apex reference guide connectapi output classes subclass of connectapi.abstractrepositoryitem. superclass of: • connectapi.repositoryfolderdetail • connectapi.repositoryfoldersummary property name type description available version externalfolderurl string url of this folder in the external system. 39.0 folderitemsurl string url that lists the files and folders in this folder. 39.0 path string absolute path of the folder in the external system. 39.0 connectapi.abstractrepositoryitem a repository item. this class is abstract. superclass of: • connectapi.abstractrepositoryfile • connectapi.abstractrepositoryfolder property name type description available version createdby string name of the user who created the item. 39.0 createddate datetime date the item was created. 39.0 description string description of the item. 39.0 id string id of the item. 39.0 itemtypeurl string url to the item type information. 39.0 modifiedby string name of the user who last modified the item. 39.0 modifieddate datetime date the item was last modified. 39.0 motif connectapi.motif motif of the item. 39.0 name string name of the item. 39.0 repository connectapi. item external repository. 39.0 reference type string item type, file or folder. 39.0 url string the url to the item. 39.0 connectapi.abstractusermissionactivity user activity associated with missions. this class is abstract. 1675apex reference guide connectapi output classes superclass of: • connectapi.usermission • connectapi.usermissionactivity property name type description available version activitycount integer number of mission activities of the specified type for 45.0 the user. activitytype string type of mission activity for a user. values are: 45.0 • 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. see also: connectapi.usermissionactivitycollection connectapi.actionlinkdefinition the definition of an action link. action link definition can be sensitive to a third party (for example, oauth bearer token headers). for this reason, only calls made from the apex namespace that created the action link definition can read, modify, or delete the definition. in addition, the user making the call must have created the definition or have view all data permission. property name type description available version actionurl string the action link url. for example, a ui action link 33.0 url is a web page. a download action link url is a link to the file to download. ui and download action link urls are provided to clients. an api or 1676apex reference guide connectapi output classes property name type description available version apiasync action link url is a rest resource. api and apiasync action link urls aren’t provided to clients. links to salesforce can be relative. all other links must be absolute and start with https://. createddate datetime iso 8601 format date string, for example, 33.0 2011-02-25t18:24:31.000z. excludeduserid string id of a single user to exclude from performing the 33.0 action. if you specify an excludeduserid, you can’t specify a userid. groupdefault boolean true if this action is the default action link in the 33.0 action link group; false otherwise. there can be only one default action link per action link group. the default action link gets distinct styling in the salesforce ui. headers list<connectapi. the request headers for the api and apiasync 33.0 requestheader> action link types. id string the 18-character id for the action link definition. 33.0 label string a custom label to display on the action link button. 34.0 a label value can be set only in an action link template. action links have four statuses: newstatus, pendingstatus, successstatus, and failedstatus. these strings are appended to the label for each status: • label • label pending • label success • label failed for example, if the value of label is “see example,” the values of the four action link states are: see example, see example pending, see example success, and see example failed. an action link can use either label or labelkey to generate label names, it can’t use both. if label has a value, the value of labelkey is none. if labelkey has a value other than none, the value of label is null. labelkey string key for the set of labels to show in the user interface. 33.0 a set includes labels for these states: newstatus, pendingstatus, successstatus, failedstatus. for example, if you use the approve key, you get these labels: approve, pending, approved, failed. 1677apex reference guide connectapi output classes property name type description available version for a complete list of label keys, see action links labels in the connect rest api developer guide. method connectapi. the http method. one of these values: 33.0 httprequestmethod • 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. modifieddate datetime iso 8601 format date string, for example, 33.0 2011-02-25t18:24:31.000z. requestbody string the request body for api and apiasync action 33.0 link types. note: escape quotation mark characters in the requestbody value. requires boolean true to require the user to confirm the action; 33.0 confirmation false otherwise. templateid string the id of the action link template from which to 33.0 instantiate this action link. if the action link isn’t associated with a template, the value is null. type connectapi. defines the type of action link. values are: 33.0 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 1678apex reference guide connectapi output classes property name type description available version /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. 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. userid string the id of the user who can execute the action. if not 33.0 specified or null, any user can execute the action. if you specify a userid, you can’t specify an excludeduserid. see also: connectapi.actionlinkgroupdefinition connectapi.actionlinkdiagnosticinfo any diagnostic information that may exist for an executed action link. diagnostic info is provided only for users who can access the action link. property name type description available version diagnosticinfo string any diagnostic information returned when an action 33.0 link is executed. diagnostic information is provided only for users who can access the action link. url string the url for this action link diagnostic information. 33.0 connectapi.actionlinkgroupdefinition the definition of an action link group. information in the action link group definition can be sensitive to a third party (for example, oauth bearer token headers). for this reason, only calls made from the apex namespace that created the action link group definition can read, modify, or delete the definition. in addition, the user making the call must have created the definition or have view all data permission. 1679apex reference guide connectapi output classes property name type description available version actionlinks list<connectapi. a collection of action link definitions that make up 33.0 actionlinkdefinition> the action link group. within an action link group, action links are displayed in the order listed in the actionlinks property of the connectapi.actionlinkgroupdefinitioninput class. within a feed item, action link groups are displayed in the order specified in the actionlinkgroupids property of the connectapi.associatedactionscapabilityinput class. category connectapi. indicates the priority and location of the action links. 33.0 platformaction 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. createddate datetime iso 8601 date string, for example, 33.0 2011-02-25t18:24:31.000z. executions connectapi. defines the number of times an action link can be 33.0 allowed actionlink executed. values are: 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. expirationdate datetime iso 8601 date string, for example, 33.0 2011-02-25t18:24:31.000z, that represents the date and time this action group expires and can no longer be executed. if the value is null, there isn’t an expiration date. id string 18-character id of the action link group definition. 33.0 modifieddate datetime iso 8601 date string, for example, 33.0 2011-02-25t18:24:31.000z. templateid string the id of the action link group template from which 33.0 to instantiate this action link group, or null if this group isn’t associated with a template. url string the url for this action link group definition. 33.0 1680apex reference guide connectapi output classes connectapi.activitysharingresult the results of sharing a captured email or event. property name type description available version success boolean whether the share operation succeeded or not. 39.0 connectapi.actor actor. this class is abstract. superclass of: • connectapi.actorwithid • connectapi.recommendedobject • connectapi.unauthenticateduser name type description available version name string name of the actor, such as the group name. 28.0 type string one of the following: 28.0 • file • group • recommendedobject (version 34.0 and later) • unauthenticateduser • user • record type name—the name of the record type, such as mycustomobject__c or account see also: connectapi.casecommentcapability connectapi.entityrecommendation connectapi.editcapability connectapi.feedentitysummary connectapi.feeditem connectapi.feeditemsummary connectapi.subscription connectapi.actorwithid actor with id. this class is abstract. 1681apex reference guide connectapi output classes subclass of: connectapi.actor superclass of: • connectapi.abstractrecordview • connectapi.articlesummary • connectapi.chattergroup • connectapi.contenthubrepository • connectapi.file • connectapi.relatedfeedpost • connectapi.user name type description available version id string actor’s 18-character id 28.0 motif connectapi. an icon that identifies the actor as a user, group, file, or custom 28.0 motif object. the icon isn’t the user or group photo, and it isn’t a preview of the file. the motif can also contain the object’s base color. mysubscription connectapi. if the context user is following the item, this contains information 28.0 reference about the subscription, else returns null. url string connect rest api url for the resource 28.0 see also: connectapi.feedelement connectapi.feedentitysummary connectapi.grouprecord connectapi.mentionsegment connectapi.recordsummarylist connectapi.address name type description available version city string name of the city 28.0 country string name of the country 28.0 formattedaddress string formatted address per the locale of the context user 28.0 state string name of the state, province, or so on 28.0 street string street number 28.0 1682 |
apex reference guide connectapi output classes name type description available version zip string zip or postal code 28.0 see also: connectapi.datacloudcompany connectapi.datacloudcontact connectapi.userdetail connectapi.adjustordersummaryoutputrepresentation output representation of the financial changes for an adjust items action. for a preview action, these values are the expected output. for a submit action, these values are the actual output. subclass of connectapi.baseoutputrepresentation. property name type description available version changebalances connectapi. expected (for preview) or actual (for submit) financial 49.0 changeitem values for the price adjustment action. most of the outputrepresentation values match the change order values. if two change orders are returned, then these values combine them. the sign of a value in this output is the opposite of the corresponding value on a change order record. for example, a discount is a positive value in changebalances and a negative value on a change order record. infulfillment string id of the change order that holds the financial 55.0 changeorderid changes applicable to orderitemsummary quantities that are in the process of being fulfilled. this change order is only created for a request that specified an allocateditemschangeordertype of infulfillment. for an adjustpreview call, this value is always null. ordersummaryid string id of the ordersummary. 49.0 postfulfillment string id of the change order that holds the financial 49.0 changeorderid changes applicable to orderitemsummary quantities that have been fulfilled. for an adjustpreview call, this value is always null. prefulfillment string id of the change order that holds the financial 49.0 changeorderid changes applicable to orderitemsummary quantities that have not been fulfilled. if the request specified an allocateditemschangeordertype of prefulfillment, this change order also includes the changes applicable to orderitemsummary quantities 1683apex reference guide connectapi output classes property name type description available version that are in the process of being fulfilled. for an adjustpreview call, this value is always null. connectapi.alternative alternative representation for an extension on a feed element. property name type description available version text string text representation of the extension. 40.0 representation thumbnailurl string thumbnail url to the extension. 40.0 title string title of the extension. 40.0 connectapi.alternativepaymentmethodoutput alternative payment method details output. property name type description available version accountid string salesforce payments account to which this payment 56.0 method is linked. comments string details about a record added by a user. maximum of 56.0 1,000 characters. email string email address of the card holder. 56.0 gatewaytoken string a unique, alphanumeric id, called a token, that a 56.0 payment gateway generates when it first processes a payment. the token replaces the actual payment data so that the data is kept secure. this token is stored as encrypted text, and can be used for recurring payments. gatewaytoken string detailed information about the gateway token. 56.0 details name string name that you assign to the payment method object. 56.0 connectapi.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. 1684apex reference guide connectapi output classes name type description available version expirationdate datetime the salesforce ui displays an announcement until 11:59 31.0 p.m. on this date unless another announcement is posted first. the salesforce ui ignores the time value in the expirationdate. however, you can use the time value to create your own display logic in your own ui. feedelement connectapi. the feed element that contains the body of the 31.0 feedelement announcement and its associated comments, likes, and so on. id string 18-character id of the announcement. 31.0 isarchived boolean specifies whether the announcement is archived. 36.0 sendemails boolean specifies whether the announcement is sent as an email 36.0 to all group members. url string the url to the announcement. 33.0 see also: connectapi.announcementpage connectapi.chattergroup connectapi.announcementpage a collection of announcements. name type description available version announcements |
list<connectapi a collection of connectapi.announcement objects. 31.0 .announcement> currentpageurl string connect rest api url identifying the current page. 31.0 nextpageurl string connect rest api url identifying the next page, or null 31.0 if there isn’t a next page. previouspageurl string connect rest api url identifying the previous page, or 31.0 null if there isn’t a previous page. connectapi.approvalcapability if a feed element has this capability, it includes information about an approval. subclass of connectapi.feedelementcapability. 1685apex reference guide connectapi output classes property name type description available version id string the work item id. the work item id is null if there 32.0 isn’t a pending work item associated with the approval record. posttemplate list<connectapi. the details of the approval post template field. 32.0 fields approvalpost templatefield> processinstance string the process instance step id. the associated record 32.0 stepid represents one step in an approval process. status connectapi. the status of the approval. 32.0 workflowprocess status see also: connectapi.feedelementcapabilities connectapi.approvalintent approval intent for a social post. property name type description available version isrecallable boolean specifies whether the social post can be recalled 45.0 (true) or not (false). see also: connectapi.socialpostintents connectapi.approvalposttemplatefield name type description available version displayname string the field name. 28.0 displayvalue string the field value or null if the field is set to null. 28.0 record connectapi. a record id. 28.0 reference if no record exists or if the reference is null, this value is null. see also: connectapi.approvalcapability 1686apex reference guide connectapi output classes connectapi.articleitem article item in question and answers suggestions. property name type description available version id string id of the article. 32.0 rating double the rating of the article. 32.0 title string title of the article. 32.0 urllink string link url of the article. 32.0 viewcount integer number of votes given to the article. 32.0 see also: connectapi.questionandanswerssuggestions connectapi.articlesummary a knowledge article summary. subclass of connectapi.actorwithid property name type description available version articletype string type of the knowledge article. 37.0 knowledgearticle string id of the knowledge article version. 39.0 versionid lastpublisheddate datetime last published date of the knowledge article. 37.0 rating double the rating of the article. 37.0 summary string summary of the knowledge article contents. 37.0 title string title of the knowledge article. 37.0 urlname string url name of the knowledge article. 37.0 viewcount integer number of times the knowledge article has been 38.0 viewed. connectapi.associatedactionscapability if a feed element has this capability, it has platform actions associated with it. 1687apex reference guide connectapi output classes property name type description available version platformaction list<connectapi. the platform action groups associated with a feed 33.0 groups platformactiongroup> element. platform action groups are returned in the order specified in the connectapi.associatedactions capabilityinput class. see also: connectapi.feedelementcapabilities connectapi.asyncoutputrepresentation output representation of the async operation. subclass of connectapi.baseasyncoutputrepresentation. no additional properties. see also: multipleensurefundsasync(multipleensurefundsinput) connectapi.multipleasyncoutputrepresentation connectapi.audience a personalization audience. property name type description available version criteria list<connectapi. criteria details for the audience. 48.0 audiencecriteria detail> customformula string custom formula for the audience criteria. for 48.0 example, (1 and 2) or 3. formulafiltertype connectapi. formula filter type for the personalization audience. 48.0 formulafiltertype values are: • allcriteriamatch—all audience criteria are true (and operation). • anycriterionmatches—any audience crit |
erion is true (or operation). • customlogicmatches—audience criteria match the custom formula (for example, (1 and 2) or 3). id string id of the audience. 48.0 name string name of the audience. 48.0 1688apex reference guide connectapi output classes property name type description available version targets list<connectapi. target assignments for the audience. 48.0 audiencetarget assignment> url string url to this audience. 48.0 see also: connectapi.audiencecollection connectapi.audiencecollection collection of personalization audiences. property name type description available version audiences list<connectapi. collection of audiences. 48.0 audience> connectapi.audiencecriteria custom recommendation audience criteria. this class is abstract. this class is a superclass of: • connectapi.customlistaudiencecriteria • connectapi.newuseraudiencecriteria property name type description available version type connectapi. specifies the custom recommendation audience 36.0 recommendationaudience criteria type. one of these values: criteriatype • customlist—a custom list of users makes up the audience. • maxdaysincommunity—new members make up the audience. see also: connectapi.recommendationaudience connectapi.audiencecriteriadetail personalization audience criteria. 1689apex reference guide connectapi output classes property name type description available version criterion list<connectapi. list of mappings of audience criteria fields and values. 48.0 audiencecriterion detail> criterionnumber integer number associated with the audience criterion in a 48.0 formula. for example, (1 and 2) or 3. if unspecified, criteria are assigned numbers in the order that they’re added. criterionoperator connectapi. operator used in the personalization audience 48.0 audiencecriteria criterion. values are: operator • contains • equal • greaterthan • greaterthanorequal • includes • lessthan • lessthanorequal • notequal • notincludes • startswith criteriontype connectapi. type of personalization audience criterion. values 48.0 audiencecriteria are: type • 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. see also: connectapi.audience connectapi.audiencecriteriondetail audience criterion information. 1690apex reference guide connectapi output classes property name type description available version value map<string, string> mapping of an audience criterion value and field. 48.0 see also: connectapi.audiencecriteriadetail connectapi.audiencetarget personalization audience assigned to a target. property name type description available version audiencename string name of the audience assigned to the target. 48.0 id string id of the audience assigned to the target. 48.0 url string url to the audience assigned to the target. 48.0 see also: connectapi.target connectapi.audiencetargetassignment target assignments for a personalization audience. property name type description available version formulascope connectapi. formula scope of the target. 51.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 ismatch boolean specifies whether the target matches the current 48.0 context (true) or doesn’t (false). 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 targettype string type of target, indicating the nature of the data being 48.0 targeted. 1691apex reference guide connectapi output classes property name type description available version targetvalue string value of the target. 48.0 url string url to the target. 48.0 see also: connectapi. |
audience connectapi.availablelocationoutputrepresentation a set of inventory locations that can combine to fulfill an order. property name type description available version locations list<string> a list of inventory locations. 51.0 see also: findrouteswithfewestsplits(findrouteswithfewestsplitsinputrepresentation) findrouteswithfewestsplitsusingoci(findrouteswithfewestsplitsusingociinput) connectapi.findrouteswithfewestsplitsoutputrepresentation connectapi.findrouteswithfewestsplitsusingocioutputrepresentation connectapi.averagedistanceresultoutputrepresentation wraps inventory location shipping distance calculation results. property name type description available version distancecalculation connectapi. results of the shipping distance calculations. 51.0 distancecalculation outputrepresentation connectapi.paymentauthadjustmentresponse authorization adjustment output representation. property name type description available version accountid string id of the account containing the payment 51.0 authorization being adjusted. amount double amount of the payment authorization adjustment. 51.0 currencyisocode string three-letter iso 4217 currency code associated with 51.0 the payment authorization adjustment. 1692apex reference guide connectapi output classes property name type description available version effectivedate datetime date when the authorization adjustment becomes 51.0 effective. id string id of the paymentauthadjustment record. 51.0 paymentauthadjustmentnumber string system-defined reference number. 51.0 requestdate datetime date when the authorization adjustment transaction 51.0 occurred. status string status of the payment authorization 51.0 adjustment.possible values are: • canceled: the payment authorization reversal has been canceled. the parent authorization has returned to its pre-reversal balance. • draft: the payment authorization reversal can be edited before applying it against the parent authorization. • processed: the payment authorization reversal has been finalized. users can change the status as follows: • draft to processed • processed to canceled • draft to canceled connectapi.authreversalgatewayresponse authorization reversal gateway response representation. subclass of connectapi.abstractgatewayresponse. no additional properties. connectapi.authorizationreversalresponse authorization reversal output representation. property name type description available version error connectapi. error response representation for the authorization 51.0 errorresponse reversal. gatewayresponse connectapi. gateway response representation for authorization 51.0 authreversal reversal. gatewayresponse 1693apex reference guide connectapi output classes property name type description available version paymentauthadjustment connectapi. payment authorization adjustment response 51.0 paymentauth representation for the authorization reversal. adjustmentresponse paymentgatewaylogs list<connectapi. gateway log collection representation for the 51.0 gatewaylogresponse> authorization reversal. connectapi.authorizationgatewayresponse payment gateway authorization response representation. subclass of connectapi.abstractgatewayresponse. property name type description available version gatewayauthorizationcode string gateway authorization code. 51.0 connectapi.authorizationresponse payment authorization output representation. property name type description available version error connectapi. error representation for the payment authorization. 51.0 errorresponse gatewayresponse connectapi. gateway response representation for the payment 51.0 authorizationgateway authorization. response paymentauthorization connectapi. payment authorization representation. 51.0 paymentauthorization response paymentgatewaylogs list<connectapi. gateway log list representation for the payment 51.0 gatewaylogresponse> authorization. paymentgroup connectapi. payment group representation for the payment 51.0 paymentgroupresponse authorization. paymentmethod connectapi. payment method representation for the payment 51.0 paymentmethodresponse authorization. connectapi.bannercapability if a feed element has this capability, it has a banner motif and style. subclass of connectapi.feedelementcapability. 1694apex reference guide connectapi output classes property name type description available version motif connectapi.motif a banner motif. 31.0 style connectapi.bannerstyle decorates a feed item with a color and set of icons. 31.0 possible value: • 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. see also: connectapi.feedelementcapabilities connectapi.bannerphoto a banner photo. property name type description available version bannerphotourl string url to the banner photo in a large format. this url 36.0 is available only to authenticated users. bannerphoto string 18-character version id of the banner photo. 36.0 versionid url string url to the banner photo. 36.0 see also: connectapi.chattergroup connectapi.userdetail connectapi.basemanagedsocialaccount base information describing a managed social account or fan page of a social network. this class is abstract. superclass of connectapi.managedsocialaccount property name type description available version defaultresponse string default response account to use when replying to 44.0 accountid posts sent to this account. displayname string real name (or user name if real name not available) 44.0 for this account on the social network. externalpictureurl string url to the account's avatar image. 44.0 1695apex reference guide connectapi output classes property name type description available version id string internal sfdc id for this managed social account. 44.0 label string label for the social account. 44.0 profileurl string url to the account's profile. 44.0 socialnetwork connectapi. social network that this account belongs to. values 44.0 socialnetworkprovider are: • facebook • googleplus • instagram • instagrambusiness • kakaotalk • kik • line • linkedin • messenger • other • pinterest • qq • rypple • sinaweibo • sms • snapchat • telegram • twitter • vkontakte • wechat • whatsapp • youtube uniquename string unique name used for distinguishing same name fan 44.0 pages; acts like a user name for a fan page. username string unique user name or handle for this account on the 44.0 social network. connectapi.baseasyncoutputrepresentation base order management async output class. this class is abstract. subclass of connectapi.baseoutputrepresentation. 1696apex reference guide connectapi output classes superclass of: • connectapi.asyncoutputrepresentation • connectapi.ensurefundsasyncoutputrepresentation • connectapi.ensurerefundsasyncoutputrepresentation property name type description available version background string id of the background operation. 48.0 operationid connectapi.baseinvoiceoutputrepresentation base order management invoice output class. this class is abstract. subclass of connectapi.baseoutputrepresentation. superclass of: • connectapi.changeordersinvoiceoutputrepresentation property name type description available version invoiceid string id of the created invoice. 56.0 connectapi.baseoutputrepresentation base order management output class. this class is abstract. superclass of: • connectapi.adjustordersummaryoutputrepresentation • connectapi.baseasyncoutputrepresentation • connectapi.baseinvoiceoutputrepresentation • connectapi.confirmheldfocapacityoutputrepresentation • connectapi.createcreditmemooutputrepresentation • connectapi.createmultipleinvoicesfromchangeordersoutputrepresentation • connectapi.createorderpaymentsummaryoutputrepresentation • connectapi.ensurefundsasyncoutputrepresentation • connectapi.ensurerefundsasyncoutputrepresentation • connectapi.findrouteswithfewestsplitsoutputrepresentation • connectapi.findrouteswithfewestsplitsusingocioutputrepresentation • connectapi.findrouteswithfewestsplitswithinventoryoutputrepresentation • connectapi.fulfillmentgroupoutputrepresentation • connectapi.fulfillmentordercancellineitemsoutputrepresentation • connectapi.fulfillmentorderinvoiceoutputrepresentation 1697apex reference guide connectapi output classes • connectapi.fulfillmentorderoutputrepresentation • connectapi.getfocapacityvaluesoutputrepresentation • connectapi.holdfocapacityoutputrepresentation • connectapi.multipleasyncoutputrepresentation • connectapi.multiplefulfillmentorderinvoicesoutputrepresentation • connectapi.multiplefulfillmentorderoutputrepresentation • connect |
api.ordersummaryoutputrepresentation • connectapi.previewcanceloutputrepresentation • connectapi.previewreturnoutputrepresentation • connectapi.productdetailsoutputrepresentation • connectapi.rankaveragedistanceoutputrepresentation • connectapi.releaseheldfocapacityoutputrepresentation • connectapi.returnitemsoutputrepresentation • connectapi.returnorderitemsplitlineoutputrepresentation • connectapi.returnorderoutputrepresentation • connectapi.submitcanceloutputrepresentation • connectapi.submitreturnoutputrepresentation property name type description available version errors list<connectapi. any errors that were returned. 48.0 errorresponse> success boolean indicates whether the transaction was successful. 48.0 connectapi.batchresult the result of an operation returned by a batch method. namespace connectapi usage calls to batch methods return a list of batchresult objects. each element in the batchresult list corresponds to the strings in the list parameter passed to the batch method. the first element in the batchresult list matches the first string passed in the list parameter, the second element corresponds with the second string, and so on. if only one string is passed, the batchresult list contains a single element. example the following example shows how to obtain and iterate through the returned connectapi.batchresult objects. the code adds two group ids to a list. one of group ids is incorrect, which causes a failure when the code calls the batch method. after it calls the batch method, it iterates through the results to determine whether the operation was successful or not for each group id in the list. the 1698apex reference guide connectapi output classes code writes the id of every group that was processed successfully to the debug log. the code writes an error message for every failed group. this example generates one successful operation and one failure. list<string> mylist = new list<string>(); // add one correct group id. mylist.add('0f9d00000000oot'); // add one incorrect group id. mylist.add('0f9d00000000izf'); connectapi.batchresult[] batchresults = connectapi.chattergroups.getgroupbatch(null, mylist); // iterate through each returned result. for (connectapi.batchresult batchresult : batchresults) { if (batchresult.issuccess()) { // operation was successful. // print the group id. connectapi.chattergroupsummary groupsummary; if(batchresult.getresult() instanceof connectapi.chattergroupsummary) { groupsummary = (connectapi.chattergroupsummary) batchresult.getresult(); } system.debug('success'); system.debug(groupsummary.id); } else { // operation failed. print errors. system.debug('failure'); system.debug(batchresult.geterrormessage()); } } in this section: batchresult methods batchresult methods the following are instance methods for batchresult. in this section: geterror() if an error occurred, returns a connectapi.connectapiexception object providing the error code and description. geterrormessage() returns a string that contains an error message. geterrortypename() returns a string that contains the name of the error type. 1699apex reference guide connectapi output classes getresult() returns an object that contains the results of the batch operation. the object is typed according to the batch method. for example, if you call getmembershipbatch(), a successful call to batchresult getresult() returns a connectapi.groupmembership object. issuccess() returns a boolean that is set to true if the batch operation was successful for this object, false otherwise. geterror() if an error occurred, returns a connectapi.connectapiexception object providing the error code and description. signature public connectapi.connectapiexception geterror() return value type: connectapi.connectapiexception geterrormessage() returns a string that contains an error message. signature public string geterrormessage() return value type: string usage the error message doesn’t make a round trip through a visualforce view state, because exceptions can’t be serialized. geterrortypename() returns a string that contains the name of the error type. signature public string geterrortypename |
() return value type: string 1700apex reference guide connectapi output classes getresult() returns an object that contains the results of the batch operation. the object is typed according to the batch method. for example, if you call getmembershipbatch(), a successful call to batchresult getresult() returns a connectapi.groupmembership object. signature public object getresult() return value type: object issuccess() returns a boolean that is set to true if the batch operation was successful for this object, false otherwise. signature public boolean issuccess() return value type: boolean connectapi.blankrecordfield record field displayed as a place holder in a grid of fields. subclass of connectapi.abstractrecordfield connectapi.bookmarkscapability if a feed element has this capability, the context user can bookmark it. subclass of connectapi.feedelementcapability. property name type description available version isbookmarked boolean indicates whether the feed element has been 32.0 bycurrentuser bookmarked by the context user (true) or not (false). see also: connectapi.feedelementcapabilities connectapi.bookmarksummary summary of a bookmark. 1701apex reference guide connectapi output classes subclass of connectapi.userfeedentityactivitysummary no additional properties. connectapi.botinforepresentation information about the bot associated with the conversation application. property name type description available version botid string id of the bot. 54.0 botname string name of the bot. 54.0 lastmodifieddate datetime last modified date of the bot definition. 54.0 connectapi.botversionactivationinfo success or failure information of the bot version activation. property name type description available version isactivated boolean indicates whether the bot is active or not. 51.0 messages list<string> failure messages. 50.0 success boolean indicates whether the activation was successful or 50.0 not. connectapi.bundlecapability if a feed element has this capability, it has a container of feed elements called a bundle. this class is abstract. subclass of connectapi.feedelementcapability. superclass of: • connectapi.genericbundlecapability • connectapi.trackedchangebundlecapability . property name type description available version bundletype connectapi.bundletype defines this feed element's bundle type. the bundle 31.0 type determines what additional information appears in the bundle. page connectapi. a collection of feed elements. 31.0 feedelementpage 1702apex reference guide connectapi output classes property name type description available version totalelements integer the total number of feed elements that this bundle 31.0 aggregates. see also: connectapi.feedelementcapabilities connectapi.callcollaborationcapability if a feed element has this capability, it has a recording comment. subclass of connectapi.feedelementcapability. property name type description available version commentendtime integer end time of the comment on the media player, in 51.0 seconds. commentstarttime integer start time of the comment on the media player, in 51.0 seconds. see also: connectapi.feedelementcapabilities connectapi.candidateanswersstatus the status of candidate answers on a feed element. property name type description available version hascandidate boolean indicates whether candidate answers are available 41.0 answers for a question. hascandidate boolean indicates whether any candidate answers are 41.0 answerspublished published. hascandidate boolean indicates whether any candidate answers are rated. 41.0 answersrated see also: connectapi.questionandanswerscapability connectapi.canvascapability if a feed element has this capability, it renders a canvas app. subclass of connectapi.feedelementcapability. 1703apex reference guide connectapi output classes property name type description available version description string a description of the canvas app. the maximum size 32.0 is 255 characters. developername string the api name (developer name) of the connected 32.0 app. height string the height of the canvas app in pixels. 32.0 icon connectapi.icon the icon for the canvas app. 32.0 namespaceprefix string a unique namespace prefix for the canvas app. 32.0 parameters string json parameters passed to the canvas app. 32 |
.0 thumbnailurl string a thumbnail url to a preview image. the maximum 32.0 thumbnail size is 120 pixels by 120 pixels. title string a title for the canvas link. 32.0 see also: connectapi.feedelementcapabilities connectapi.capacityresponseoutputrepresentation response to a request related to a location’s fulfillment capacity. property name type description available version actionrequestid string unique string that identifies the original capacity 55.0 request. error connectapi. error returned by the request, if any. 55.0 errorresponse success boolean indicates whether the request was successful. 55.0 connectapi.capturegatewayresponse gateway capture response. subclass of connectapi.abstractgatewayresponse. no additional properties. connectapi.captureresponse capture output. 1704apex reference guide connectapi output classes property name type description available version error connectapi. error response representation for an authorization 50.0 errorresponse capture. gatewayresponse connectapi. gateway log response containing details about 50.0 capturegatewayresponse gateway logs created during the process of the capture request. payment connectapi. payment response object for the capture request. 50.0 paymentresponse contains the information related to a payment object created during request processing. paymentgatewaylogs list<connectapi. gateway log collection for an authorization capture. 50.0 gatewaylogresponse> paymentgroup connectapi. payment group associated with the capture request. 50.0 paymentgroupresponse connectapi.cardpaymentmethodoutput card payment method details output. property name type description available version accountid string salesforce payments account to which this payment 56.0 method is linked. autopay boolean indicates whether a token for recurring payments is 56.0 being requested (true) or not (false). the token lets the payment method be used for recurring payments. cardbin string bank identification number (bin). the bin is the first 56.0 4-6 numbers on a payment card that identifies the card issuer. cardcategory connectapi. 56.0 • creditcard cardcategory • debitcard cardholderfirstname string first name of the card holder 56.0 cardholderlastname string last name of the card holder 56.0 cardholdername string full name of card holder 56.0 cardlastfour string last four digits on a card. 56.0 cardtype connectapi.cardtype credit card issuer. 56.0 • americanexpress • dinersclub • jcb 1705apex reference guide connectapi output classes property name type description available version • maestro • mastercard • visa comments string details about a record added by a user. maximum of 56.0 1,000 characters. displaycardnumber string card displayed number 56.0 email string email address of the card holder. 56.0 expirymonth integer card expiration month 56.0 expiryyear integer card expiration year 56.0 nickname string optional card nickname 56.0 startmonth integer month when card becomes active 56.0 startyear integer year when card becomes active 56.0 connectapi.cartcoupon cart coupon representation. property name type description available version cartcouponid string id of the cart coupon code. 54.0 couponcode string the coupon code a buyer can use to manually apply 54.0 a promotion to the cart. connectapi.cartcouponcollection collection of coupons related to a cart. property name type description available version cartcoupons lsit<connectapi.cartcouponlist> collection of coupons. 54.0 cartid string id of the cart. 54.0 cartstatus connectapi. status of the cart. values are: 54.0 cartstatus • active—cart is active. • checkout—cart is in checkout. • closed—cart is closed. • pendingdelete—cart is pending delete, for example, a user deleted the cart but the job hasn’t completed yet. 1706apex reference guide connectapi output classes property name type description available version • processing—cart is processing. ownerid string id of the user who owns the cart. 54.0 connectapi.cartcouponlist list of coupons for a cart. property name type description available version coupons lsit<connectapi.cartcoupon> list of coupons associated with a cart. 54.0 connectapi |
.cartinventoryitemreservationoutputrepresentation (developer preview) inventory item reservation. note: this feature is available as a developer preview. it isn’t generally available unless or until salesforce announces its general availability in documentation or in press releases or public statements. all commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. property name type description available version errorcode string error code for this reservation item. 58.0 errormessage string error message for this reservation item. 58.0 id string id for this reservation item. 58.0 itemreservation string item reservation source id for this reservation item. 58.0 sourceid productid string product id for this reservation item. 58.0 quantity double quantity for this reservation item. 58.0 reservedat string reserved at location or group id for this reservation 58.0 locationid item. stockkeepingunit string stock keeping unit for this reservation item. 58.0 connectapi.cartinventoryreservationoutputrepresentation (developer preview) inventory reservation note: this feature is available as a developer preview. it isn’t generally available unless or until salesforce announces its general availability in documentation or in press releases or public statements. all commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. 1707apex reference guide connectapi output classes property name type description available version errorcode string error code for this reservation. 58.0 errormessage string error message for this reservation. 58.0 inventoryitem list<connectapi. collection of inventory item reservations. 58.0 reservations cartinventory itemreservation outputrepresentation> reservation string reservation identifier. 58.0 identifier success boolean indicates whether the transaction was successful. 58.0 connectapi.cartitem an item in a cart. subclass of connectapi.abstractcartitem property name type description available version currencyisocode string currency iso code of the cart. 57.0 itemizedadjustment string total itemized adjustment amount for the item, 52.0 amount including promotions and excluding taxes. listprice string list price for the item. 49.0 salesprice string sales price for the item. 49.0 totaladjustment string total adjustment amount for the item. 50.0 amount totalamount string total amount for the item. 49.0 totallistprice string total list price for the item. 49.0 totalprice string total price for the item including adjustments but 49.0 excluding taxes. totaltax string total tax for the item. 49.0 unitadjustedprice string unit price, including adjustments, for the item. this 50.0 value is informational only and isn’t used in pricing calculations. unitadjustment string adjustments made to the unit price for the item. this 50.0 amount value is informational only and isn’t used in pricing calculations. 1708apex reference guide connectapi output classes connectapi.cartitemcollection cart item collection. property name type description available version cartitems list<connectapi. collection of cart item results. 49.0 cartitemresult> cartsummary connectapi. summary of the cart. 49.0 cartsummary 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. 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. connectapi.cartitemproduct product summary for a cart item. property name type description available version fields map<string, string> map of product fields and values. 49.0 name string name of the product. 49.0 productid string id of the product. 49.0 purchasequantityrule connectapi. if one exists, purchase quantity rule for the product. 52.0 purchasequantity rule sku string sku of the product. 49.0 thumbnailimage connectapi. |
thumbnail image of the product. 49.0 productmedia 1709apex reference guide connectapi output classes property name type description available version variationattributes map<string, variation attributes associated with the product. 50.0 connectapi. cartproduct attribute> see also: connectapi.abstractcartitem connectapi.wishlistitem connectapi.cartitempromotioncollectionoutputrepresentation promotions for the items in a cart. property name type description available version currencyisocode string currency code associated with the cart. 53.0 items map<string, collection of promotions. 52.0 connectapi. cartpromotionlist representation> connectapi.cartitemresult result after requesting a cart item. property name type description available version cartitem connectapi. cart item. 49.0 abstractcartitem message string message when the request isn’t successful. 49.0 status string status for the request. 49.0 see also: connectapi.cartitemcollection connectapi.wishlisttocartresult connectapi.cartitemwithoutprice an item without price information in a cart. subclass of connectapi.abstractcartitem no additional properties. 1710apex reference guide connectapi output classes connectapi.cartmessage cart message. property name type description available version message string cart message. 49.0 messageid string id of the object supplying the message. 49.0 relatedentityid string id of the entity, for example, cart, cart item, or cart 49.0 tax, associated with the message. severity connectapi. severity of cart message. values are: 49.0 cartmessageseverity • error • info • warning type string type of message. standard values include 49.0 inventory, taxes, pricing, shipping, entitlement, systemerror, and other. visible boolean specifies whether the message is visible (true) or 49.0 dismissed (false). see also: connectapi.cartmessagessummary connectapi.cartmessagessummary cart messages summary. property name type description available version errorcount integer in connectapi.cartitemresult, the count 49.0 of messages with the error severity level. haserrors boolean specifies whether there are messages related to the 49.0 entity (true) or not (false). limitedmessages list<connectapi. in connectapi.cartitemresult, a limited 49.0 cartmessage> list of messages related to the cart item. in connectapi.cartsummary, each message can be related to the cart or to another cart-related entity. relatedentityid string in connectapi.cartitemresult, the id of 49.0 the related cart item. in connectapi.cartsummary, each message can be related to the cart or to another cart-related entity. 1711apex reference guide connectapi output classes property name type description available version totallineitems integer in connectapi.cartitemresult, either 50.0 witherrors null if the cart item has no errors or 1 if the cart item has errors. in connectapi.cartsummary, the total number of product line items that contain errors. see also: connectapi.abstractcartitem connectapi.cartmessagesvisibilityresult result of setting the visibility for cart messages. property name type description available version visibility boolean specifies whether cart messages are set to visible 50.0 (true) or not (false). connectapi.cartproductattribute product attribute for a cart item. property name type description available version label string label or display name of the attribute. 50.0 sequence integer sequence of the attribute within the attribute set. 50.0 value string display value of the attribute. 50.0 see also: connectapi.cartitemproduct connectapi.cartpromotioncollection all the promotions associated with the cart. property name type description available version cartid string id of the cart. 53.0 cartstatus connectapi. status of the cart. values are: 53.0 cartstatus • active—cart is active. • checkout—cart is in checkout. • closed—cart is closed. 1712apex reference guide connectapi output classes property name type description available version • pendingdelete—cart is pending delete, for example, a user deleted the cart but the job hasn’t completed yet. • processing— |
cart is processing. currencyisocode string currency iso code of the cart. 53.0 promotions list<connectapi. collection of promotions. 53.0 cartpromotion list> connectapi.cartpromotionlist a list of promotions for a cart. property name type description available version promotions list<connectapi. promotions associated with a cart. 54.0 cartpromotion outputrepresentation> connectapi.cartpromotionoutputrepresentation a promotion associated with a cart. property name type description available version adjustmentamount string adjustment amount out of the promotion. 53.0 couponcode string coupon code for a promotion. a coupon code is 54.0 available only for manual promotions, not for automatic promotions. currencyisocode string currency iso code associated with the cart. 57.0 displayname string localized display name of the promotion. 52.0 promotionid string id of the promotion. 53.0 targettype connectapi. promotion target type. values are: 53.0 cartpromotion • cart—promotion targets a cart. type • item—promotion targets an item in a cart. termsandconditions string localized terms and conditions for the promotion. 53.0 connectapi.cartsummary a cart summary. 1713apex reference guide connectapi output classes property name type description available version accountid string id of the account for the cart. 49.0 cartid string id of the cart. 49.0 currencyisocode string three-letter iso 4217 currency code associated with 49.0 the cart. grandtotalamount string grand total amount including shipping and tax for 49.0 items in the cart, in the currency of the cart. issecondary boolean specifies whether the cart is secondary (true) or 53.0 not (false). name string name of the cart. 49.0 ownerid string id of the owner of the cart. 49.0 ownerorderid string id of the owner of the order. 58.0 purchaseordernumber string purchase order for the cart. 50.0 status connectapi. status of the cart. values are: 49.0 cartstatus • active—cart is active. • checkout—cart is in checkout. • 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. taxtype string tax type of the cart. 55.0 • gross—gross taxation policy. • net—net taxation policy. totalchargeamount string total amount for shipping and other charges in the 49.0 currency of the cart. totallistprice string total list price for the cart. 49.0 totalproductamount string total amount including discounts, but excluding 49.0 shipping and tax, for product items in the cart. totalproductamount string total product amount, including promotions. 52.0 afteradjustments totalproductcount string total count of items in the cart. 49.0 totalpromotional string total promotional adjustment amount for items in 52.0 adjustmentamount the cart. totaltaxamount string total tax amount for the cart, including tax on 49.0 shipping, if applicable. 1714apex reference guide connectapi output classes property name type description available version type connectapi. type of cart.value is cart. 49.0 carttype uniqueproductcount integer total count of unique items, or skus, in the cart. 49.0 webstoreid string id of the webstore of the cart. 49.0 see also: connectapi.cartitemcollection connectapi.carttowishlistresult result of copying products from a cart to a wishlist. property name type description available version productsaddedcount integer number of products copied from the cart to the 50.0 wishlist. wishlistid string id of the wishlist that cart products were copied to. 50.0 connectapi.casecommentcapability if a feed element has this capability, it has a case comment on the case feed. subclass of connectapi.feedelementcapability. property name type description available version actortype connectapi. specifies the type of user who made the comment. 32.0 caseactortype createdby connectapi.actor information about the user who created the 32.0 comment. createddate datetime iso 8601 date string, for example, 32.0 2011-02-25t18:24:31.000 |
z. eventtype connectapi. specifies an event type for a comment in the case 32.0 casecomment feed. eventtype id string 18-character id of case comment. 32.0 published boolean specifies whether the comment has been published. 32.0 1715apex reference guide connectapi output classes property name type description available version text string text of the case comment. 32.0 see also: connectapi.feedelementcapabilities connectapi.cdpactionresponse customer data platform action response. this class is abstract. superclass of: • connectapi.cdpcalculatedinsightstandardactionresponserepresentation property name type description available version errors list<connectapi. list of errors that resulted from the action. 57.0 cdperrorresponse> success boolean indicates whether the call was successful (true) or 57.0 not (false). connectapi.cdpcalculatedinsightpage collection of calculated insights. property name type description available version collection connectapi. collection of calculated insights. 57.0 cdpcalculated insightpagedata connectapi.cdpcalculatedinsightpagedata calculated insight collection data. property name type description available version count integer number of results returned in the page. 57.0 currentpagetoken string token identifying the current page. 57.0 currentpageurl string connect rest api url identifying the current page. 57.0 items list<connectapi. list of calculated insights. 57.0 cdpcalculated insightoutput> 1716apex reference guide connectapi output classes property name type description available version nextpagetoken string token identifying the next page, or null if there 57.0 isn’t a next page. nextpageurl string connect rest api url identifying the next page, or 57.0 null if there isn’t a next page. previouspagetoken string token identifying the previous page, or null if 57.0 there isn’t a previous page. previouspageurl string connect rest api url identifying the previous page, 57.0 or null if there isn’t a previous page. total integer total row count of calculated insights. 57.0 see also: connectapi.cdpcalculatedinsightpage connectapi.cdpcalculatedinsightdatasource calculated insight data source. property name type description available version sourceapiname string data source api name. 57.0 type string data source type. 57.0 see also: connectapi.cdpcalculatedinsightdimension connectapi.cdpcalculatedinsightmeasure connectapi.cdpcalculatedinsightdimension calculated insight dimension. property name type description available version apiname string api name of the dimension. 57.0 creationtype string creation type of the dimension. 57.0 datasource connectapi. data source of the dimension. 57.0 cdpcalculated insightdatasource datatype string data type of the dimension. 57.0 dategranularity string date granularity of the dimension. 57.0 1717apex reference guide connectapi output classes property name type description available version displayname string display name of the dimension. 57.0 fieldrole string field role of the dimension. 57.0 formula string formula of the dimension. 57.0 see also: connectapi.cdpcalculatedinsightoutput connectapi.cdpcalculatedinsightmeasure calculated insight measure. property name type description available version apiname string api name of the measure. 57.0 creationtype string creation type of the measure. 57.0 datasource connectapi. data source of the measure. 57.0 cdpcalculated insightdatasource datatype string data type of the measure. 57.0 displayname string display name of the measure. 57.0 fieldaggregationtype string field aggregation type of the measure. 57.0 fieldrole string field role of the measure. 57.0 formula string formula of the measure. 57.0 see also: connectapi.cdpcalculatedinsightoutput connectapi.cdpcalculatedinsightoutput calculated insight. property name type description available version apiname string api name of the calculated insight. 57.0 calculatedinsight string status of the calculated insight. 57.0 status creationtype string creation type of the calculated insight. 57.0 dataspace string data space of the calculated insight. 57.0 1718apex reference |
guide connectapi output classes property name type description available version definitionstatus string definition status of the calculated insight. 57.0 definitiontype string definition type of the calculated insight. 57.0 description string description of the calculated insight. 57.0 dimensions list<connectapi. dimensions of the calculated insight. 57.0 cdpcalculated insightdimension> displayname string display name of the calculated insight. 57.0 expression string expression of the calculated insight. 57.0 isenabled boolean specifies whether the calculated insight is enabled 57.0 (true) or not (false). lastcalcinsight string last calculated insight status date and time. 57.0 statusdatetime lastcalcinsight string last calculated insight status error code. 57.0 statuserrorcode lastrundatetime string last run date and time of the calculated insight. 57.0 lastrunstatus string last run status of the calculated insight. 57.0 lastrunstatus string last run status date and time of the calculated insight. 57.0 datetime lastrunstatus string last run status error code of the calculated insight. 57.0 errorcode measures list<connectapi. measures of the calculated insight. 57.0 cdpcalculated insightmeasure> see also: connectapi.cdpcalculatedinsightpagedata connectapi.cdpcalculatedinsightstandardactionresponserepresentation response of the calculated insight run action. subclass of connectapi.cdpactionresponse. no additional properties. connectapi.cdperrorresponse error response. 1719apex reference guide connectapi output classes property name type description available version errorcode string error code. 57.0 message string message stating the reason for the error, if any. 57.0 see also: connectapi.cdpactionresponse connectapi.cdpidentityresolutionmatchcriterionoutput identity resolution ruleset's match rule criterion. property name type description available version entityname string api name of the data model object the match rule 57.0 applies to. fieldname string name of the field the criterion applies to. 57.0 matchmethodtype connectapi. match method for a match rule criterion. values are: 57.0 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. partyidentification connectapi. party identifier information. 57.0 info cdpidentityresolution matchcriterionparty identificationinfooutput shouldmatchonblank boolean specifies whether blank fields can be used for 57.0 matching (true) or not (false). see also: connectapi.cdpidentityresolutionmatchruleoutput connectapi.cdpidentityresolutionmatchcriterionpartyidentificationinfooutput information when party identification is used in an identity resolution ruleset's match rule criterion. property name type description available version partyname string party identification name. 57.0 1720apex reference guide connectapi output classes property name type description available version partytype string party identification type. 57.0 see also: connectapi.cdpidentityresolutionmatchcriterionoutput connectapi.cdpidentityresolutionmatchruleoutput identity resolution ruleset’s match rule. property name type description available version criteria list<connectapi. object and field the match rule applies to and the 57.0 cdpidentityresolution match method applied. matchcriterionoutput> label string user friendly name for the identity resolution match 57.0 rule. see also: connectapi.cdpidentityresolutionoutput connectapi.cdpidentityresolutionoutput identity resolution ruleset. property name type description available version anonymousunified long count of anonymous unified profiles created by 57.0 profiles running the identity resolution ruleset. configurationtype connectapi. source object for an identity resolution ruleset. values 57.0 cdpidentityresolution are: configurationtype • account • individual consolidationrate double consolidation rate resulting from the run of an 57.0 identity resolution ruleset. dataspacename string data space used as source data for an identity 57.0 resolution ruleset. description string description of the identity resolution ruleset. 57. |
0 doesrun boolean specifies whether automatic job run scheduling is 57.0 automatically enabled for the ruleset (true) or not (false). if unspecified, defaults to false. 1721apex reference guide connectapi output classes property name type description available version id string identity resolution ruleset's id. this is not the identity 57.0 resolution's extended ruleset id (rulesetid). knownunified long count of known unified profiles created by running 57.0 profiles the identity resolution ruleset. label string user friendly name of the identity resolution ruleset. 57.0 lastjobcompleted datetime date and time the last job completed. 57.0 lastjobstatus string last job's status. possible values are: 57.0 • success • in_progress • fail • scheduled • skipped matchrules list<connectapi. list of match rules. 57.0 cdpidentityresolution matchruleoutput> matchedsource long count of matched source profiles identified by 57.0 profiles running the identity resolution ruleset. objectapiname string object name of the identity resolution ruleset. 57.0 reconciliationrules list<connectapi. list of reconciliation rules. 57.0 cdpidentityresolution reconciliationruleoutput> rulesetid string extension id of a ruleset. the ruleset id must be 57.0 unique and no longer than 4 characters. this id is not the identifying id for the ruleset. rulesetstatus string status of a ruleset job. possible values are: 57.0 • new • publishing • published • error • deleting • delete_failed sourceprofiles long count of source profiles that were processed by a 57.0 ruleset job. 1722apex reference guide connectapi output classes property name type description available version totalunifiedprofiles long count of unified profiles created by running the 57.0 identity resolution ruleset. see also: connectapi.cdpidentityresolutionsoutput connectapi.cdpidentityresolutionreconciliationfieldruleoutput identity resolution ruleset's reconciliation rule for a field. property name type description available version fieldname string the field that this reconciliation rule applies to. 57.0 ruletype connectapi. default reconciliation rule applied to fields in the 57.0 cdpidentityresolution object the reconciliation rule applies to. values are: reconciliationruletype • lastupdated • mostfrequent • sourcesequence shouldignore boolean specifies whether to ignore an empty value (true) 57.0 emptyvalue or not (false). sources list<connectapi. if ruletype is sourcesequence, a prioritized 57.0 cdpidentityresolution list of data sources. reconciliationsourceoutput> see also: connectapi.cdpidentityresolutionreconciliationruleoutput connectapi.cdpidentityresolutionreconciliationruleoutput identity resolution ruleset’s reconciliation rule for an object. property name type description available version entityname string api name of the data model object the reconciliation 57.0 rule applies to. fields list<connectapi. field-specific reconciliation rules that override this 57.0 cdpidentityresolution default rule for the specified field. reconciliationfield ruleoutput> linkdmoname string api name of the unified link object created by the 57.0 identity resolution process. 1723apex reference guide connectapi output classes property name type description available version ruletype connectapi. default reconciliation rule applied to fields in the 57.0 cdpidentityresolution object the reconciliation rule applies to. values are: reconciliationruletype • lastupdated • mostfrequent • sourcesequence shouldignore boolean specifies whether to ignore an empty value (true) 57.0 emptyvalue or not (false). sources list<connectapi. if ruletype is sourcesequence, a list of data 57.0 cdpidentityresolution sources in priority order. reconciliationsourceoutput> unifieddmoname string api name of the unified data model object created 57.0 by the identity resolution process. see also: connectapi.cdpidentityresolutionoutput connectapi.cdpidentityresolutionreconciliationsourceoutput source for an identity resolution default reconciliation rule or field-specific rule using the |
sourcesequence match method. property name type description available version name string if the ruletype for a reconciliation rule is 57.0 sourcesequence, api name of a source data lake object. see also: connectapi.cdpidentityresolutionreconciliationruleoutput connectapi.cdpidentityresolutionreconciliationfieldruleoutput connectapi.cdpidentityresolutionrunnowoutput identity resolution ruleset run now output. property name type description available version resultcode connectapi. result of an identity resolution ruleset job run. values 57.0 cdpidentityresolution are: runnowresultcode • exceededmaximumnumberof successfulrunsallowedin24hours 1724apex reference guide connectapi output classes property name type description available version • identityresolutionjobisalready running • nopendingchangesjobrunskipped • successfullysubmittedidentity resolutionjobrunrequest connectapi.cdpidentityresolutionsoutput identity resolution rulesets. property name type description available version identityresolutions list<connectapi. list of identity resolution rulesets. 57.0 cdpidentity resolutionoutput> connectapi.cdpquerydataoutput query data output. property name type description available version data list<object> result data set. 54.0 connectapi.cdpquerymetadataitem metadata item. property name type description available version placeinorder integer attribute place order in the result. 55.0 type string metadata type for column. 55.0 typecode integer metadata type code. 55.0 see also: connectapi.cdpqueryoutputv2 connectapi.cdpquerymetadataoutput query metadata result. 1725apex reference guide connectapi output classes property name type description available version metadata list<object> metadata set. 52.0 connectapi.cdpqueryoutput query result. property name type description available version data list<object> result data set. 52.0 done boolean specifies whether the query is done (true) or not 52.0 (false). endtime string query end time. 52.0 metadata map<string, object> result metadata set. 52.0 queryid string query id. 52.0 rowcount integer number of rows in the result data set. 52.0 starttime string query start time. 52.0 connectapi.cdpqueryoutputv2 query output for the v2 api. property name type description available version data list<connectapi. result data set. 54.0 cdpqueryv2row> (in version 55.0 and later) list<object> (version 54.0 only) done boolean specifies whether the query is done (true) or not 54.0 (false). endtime string query end time. 54.0 metadata map<string, result metadata set. 54.0 connectapi. cdpquery metadataitem> (version 55.0 and later) map<string, object> (version 54.0 only) 1726apex reference guide connectapi output classes property name type description available version nextbatchid string next batch id. 54.0 use this property as the nextbatchid parameter in the nextbatchansisqlv2(nextbatchid) method to get the next batch of data. queryid string query id. 54.0 rowcount integer number of rows in the result data set. 54.0 starttime string query start time. 54.0 connectapi.cdpqueryv2row row in the query output for the v2 api. property name type description available version rowdata list<object> row values. 55.0 see also: connectapi.cdpqueryoutputv2 connectapi.cdpsegmentactionoutput segment action. property name type description available version errorcode string error code associated with the action, if any. 57.0 errormessage string error message associated with the action, if any. 57.0 jobid string job id for the publish job. 56.0 partitionid string id of the partition. 56.0 publishstatus string publish status of the segment. 57.0 segmentid string id of the segment. 56.0 connectapi.cdpsegmentcontaineroutput segment container. property name type description available version batchsize integer number of items returned. 56 |
.0 1727apex reference guide connectapi output classes property name type description available version offset integer number of rows skipped before returning results. 56.0 orderbyexpression string expression indicating how results are ordered. 56.0 segments list<connectapi. list of segments. 55.0 cdpsegmentoutput> connectapi.cdpsegmentdbtmodel segment dbt model. property name type description available version name string dbt model name. 55.0 sql string dbt model sql. 55.0 see also: connectapi.cdpsegmentdbtpipeline connectapi.cdpsegmentdbtpipeline segment dbt pipeline. property name type description available version models list<connectapi. dbt models. 55.0 cdpsegment dbtmodel> see also: connectapi.cdpsegmentoutput connectapi.cdpsegmentoutput segment. property name type description available version apiname string api name of the segment. 56.0 dataspace string data space of the segment. 57.0 description string segment description. 55.0 developername string segment developer name. 55.0 displayname string segment display name. 57.0 1728apex reference guide connectapi output classes property name type description available version excludecriteria string segment exclude criteria. 57.0 includecriteria string segment include criteria. 57.0 includedbt connectapi. segment dbt pipeline. 55.0 cdpsegment dbtpipeline lookalikecriteria reserved for future use. 56.0 marketsegment string id of the market segment definition. 55.0 definitionid marketsegmentid string id of the market segment. 56.0 nextpublish string date and time of the next segment publish. 57.0 datetime publishinterval string segment publish interval. 55.0 publishschedule string publish schedule end date. 55.0 enddate publishschedule string publish schedule start date time. 55.0 startdatetime publishstatus string segment publish status. 55.0 segmentmembership string name of the segment membership table. 56.0 table segmentonapiname string api name of the segmenton entity. 56.0 segmentonid string id of the dmo segment. 55.0 segmentstatus string segment status. 55.0 segmenttype string type of segment. 56.0 see also: connectapi.cdpsegmentcontaineroutput connectapi.changeitemoutputrepresentation the financial changes resulting from a change to one or more orderitemsummaries. most of the values represent the deltas of the values on the associated ordersummary. the sign of each value is the opposite of the corresponding value on a change order record. for example, a discount is a positive value here and a negative value on a change order record. property name type description available version grandtotalamount double change to the grandtotalamount field. 48.0 1729apex reference guide connectapi output classes property name type description available version totaladjdelivery double change to the totaladjdeliveryamtwithtax field. 49.0 amtwithtax totaladjdist double change to the totaladjdistamountwithtax field. 49.0 amountwithtax totaladjproduct double change to the totaladjproductamtwithtax field. 49.0 amtwithtax totaladjusted double change to the totaladjusteddeliveryamount field. 48.0 deliveryamount totaladjusted double change to the totaladjusteddeliverytaxamount field. 48.0 deliverytaxamount totaladjusted double change to the totaladjustedproductamount field. 48.0 productamount totaladjusted double change to the totaladjustedproducttaxamount field. 48.0 producttaxamount totaladjustment double change to the totaladjustmentdistributedamount 48.0 distributedamount field. totaladjustment double change to the 48.0 distributedtaxamount totaladjustmentdistributedtaxamount field. totalamount double change to the totalamount field. 48.0 totalexcess double amount of excess funds available on the 48.0 fundsamount orderpaymentsummaries related to the ordersummary. it is equal to the captured amount that is owed as a refund but is not associated with an invoice or credit memo. excess funds normally occur when order items are canceled before fulfillment but after payment has |
been captured. this situation is not common in the us, where funds are normally authorized but not captured until the fulfillment process begins. this value includes all current excess funds related to the ordersummary, not only the funds related to the current change. totalfeeamount double total amount of the fees charged for the change. 57.0 totalfeetaxamount double total amount of tax on the fees charged for the 57.0 change. totalrefundable double total amount available to be refunded. it is the sum 48.0 amount of the excess funds and any outstanding change order grand total amounts that apply to post-fulfillment changes. this value includes all current refundable amounts related to the 1730apex reference guide connectapi output classes property name type description available version ordersummary, not only the amount related to the current change. totalrequired double the required funds associated with added order 54.0 fundsamount items. totaltaxamount double change to the totaltaxamount field. 48.0 see also: connectapi.previewcanceloutputrepresentation connectapi.previewreturnoutputrepresentation connectapi.submitcanceloutputrepresentation connectapi.submitreturnoutputrepresentation connectapi.chatteractivity chatter activity. name type description available version commentcount integer total number of comments in the org or site made by the user. 28.0 commentreceived integer total number of comments in the org or site received by the user. 28.0 count likereceived integer total number of likes and upvotes (in version 45.0 and later) on posts 28.0 count and comments in the org or site received by the user. postcount integer total number of posts in the org or site made by the user. 28.0 see also: connectapi.userdetail connectapi.chatteractivitysummary summary of chatter activity. subclass of connectapi.userfeedentityactivitysummary property name type description available version commentcount integer total number of comments in the org or site made 42.0 by the user. commentreceived integer total number of comments in the org or site received 42.0 count by the user. 1731apex reference guide connectapi output classes property name type description available version likereceived integer total number of likes and upvotes (in version 45.0 42.0 count and later) on posts and comments in the org or site received by the user. postcount integer total number of posts in the org or site made by the 42.0 user. connectapi.chatterconversation chatter conversation. name type description available version conversationid string id for the conversation. 29.0 conversationurl string connect rest api url identifying the conversation. 29.0 members list<connectapi. list of users in the conversation. 29.0 usersummary> messages connectapi. content of the conversation. 29.0 chatter messagepage read boolean specifies if the conversation is read (true) or not read 29.0 (false). connectapi.chatterconversationpage chatter conversation page. name type description available version conversations list<connectapi.chatter list of conversations on the page. 29.0 conversationsummary> currentpagetoken string token identifying the current page. 29.0 currentpageurl string connect rest api url identifying the current page. 29.0 nextpagetoken string token identifying the next page, or null if there isn’t 29.0 a next page. nextpageurl string connect rest api url identifying the next page, or 29.0 null if there isn’t a next page. connectapi.chatterconversationsummary chatter conversation summary. 1732 |
apex reference guide connectapi output classes name type description available version id string id for the conversation summary. 29.0 latestmessage connectapi.chattermessage contents of the latest message. 29.0 members list<connectapi.usersummary> list of members in the conversation. 29.0 read boolean specifies if the conversation is read (true) or not read 29.0 (false). url string connect rest api url to the conversation summary. 29.0 see also: connectapi.chatterconversationpage connectapi.chattergroup chatter group. this class is abstract. subclass of connectapi.actorwithid superclass of: • connectapi.chattergroupdetail • connectapi.chattergroupsummary name type description available version additional string an extra label for the group, for example, “archived,” “private,” or “private with 30.0 label customers.” if there isn’t an extra label, the value is null. announcement connectapi. the current announcement for this group.an announcement displays in a 31.0 announcement designated location in the salesforce ui until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement. bannerphoto connectapi. the banner photo for the group. 36.0 bannerphoto canhave boolean true if this group allows chatter guests. 28.0 chatterguests community connectapi. information about the experience cloud site the group is in. 28.0 reference description string group’s description. 28.0 emailto string group’s email address for posting to this group by email. 30.0 chatteraddress returns null if chatter emails and posting to chatter by email aren’t both enabled in your organization. 1733apex reference guide connectapi output classes name type description available version isarchived boolean specifies whether the group is archived (true) or not (false). 29.0 isauto boolean specifies whether automatic archiving is disabled for the group (true) or 29.0 archivedisabled not (false). isbroadcast boolean specifies whether the group is a broadcast group (true) or not (false). 36.0 in a broadcast group, only group owners and managers can post to the group. lastfeedelement datetime iso 8601 date string, for example, 2011-02-25t18:24:31.000z, of the most 31.0 postdate recent feed element posted to the group. lastfeeditem datetime iso 8601 date string, for example, 2011-02-25t18:24:31.000z, of the most 28.0–30.0 postdate recent feed item posted to the group. use lastfeedelementposted. membercount integer total number of group members. 28.0 myrole connectapi. type of membership the user has with the group. 28.0 groupmembershiptype • groupowner • groupmanager • notamember • notamemberprivaterequested • standardmember mysubscription connectapi. if the context user is a member of this group, contains information about that 28.0 reference subscription; otherwise, returns null. name string name of the group. 28.0 owner connectapi. information about the owner of the group. 28.0 usersummary photo connectapi.photo information about the group photo. 28.0 visibility connectapi. group visibility type. valid values are: 28.0 groupvisibility • privateaccess—only members of the group can see posts to this type group. • publicaccess—all users within the experience cloud site can see posts to this group. • unlisted—reserved for future use. connectapi.chattergroupdetail chatter group details. subclass of connectapi.chattergroup. 1734apex reference guide connectapi output classes name type description available version filecount integer the number of files posted to the group. 28.0 information connectapi. describes the information section of the group. if the group is private, this 28.0 group section is visible only to members. if the context user is not a member of information the group or does not have modify all data or view all data permission, this value is null. pending integer the number of requests to join a group that are in a pending state. 29.0 requests see also: |
connectapi.chattergrouppage connectapi.usergroupdetailpage connectapi.chattergrouppage page of groups. name type description available version currentpageurl string connect rest api url identifying the current page. 28.0 groups list<connectapi. list of group details. 28.0 chatter group detail> nextpageurl string connect rest api url identifying the next page, or null if there isn’t a 28.0 next page. previous string connect rest api url identifying the previous page, or null if there isn’t 28.0 pageurl a previous page. connectapi.chattergroupsummary subclass of connectapi.chattergroup. name type description available version filecount integer the number of files posted to the group. 28.0 see also: connectapi.chattergroupsummarypage connectapi.usergrouppage 1735apex reference guide connectapi output classes connectapi.chattergroupsummarypage page of group summaries. name type description available version currentpageurl string connect rest api url identifying the current page. 29.0 groups list<connectapi. list of group summary objects. 29.0 chattergroup summary> nextpageurl string connect rest api url identifying the next page, or null if 29.0 there isn’t a next page. previouspageurl string connect rest api url identifying the previous page, or null 29.0 if there isn’t a previous page. connectapi.chatterlike chatter like information. name type description available version id string like’s 18-character id 28.0 likeditem connectapi. a reference to the liked comment or feed element. 28.0 reference url string like’s connect rest api url 28.0 user connectapi.user like’s creator 28.0 summary see also: connectapi.chatterlikepage connectapi.chatterlikepage page of chatter likes. 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 items list<connectapi. list of likes. 32.0 chatterlike> 1736apex reference guide connectapi output classes name type description available version likes list<connectapi. list of likes. 28.0–31.0 chatterlike> important: as of api version 32.0, use the items property. 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 there 28.0 isn’t a next page. previouspagetoken integer token identifying the previous page, or null if there isn’t a 28.0 previous page. previouspageurl string connect rest api url identifying the previous page, or null if 28.0 there isn’t a previous page. total integer total number of likes across all pages. 28.0 see also: connectapi.chatterlikescapability connectapi.comment connectapi.chatterlikescapability if a feed element has this capability, the context user can like it. exposes information about existing likes. subclass of connectapi.feedelementcapability. property name type description available version islikedby boolean indicates whether the feed element is liked by the 32.0 currentuser context user (true) or not (false). page connectapi. likes information for this feed element. 32.0 chatterlikepage likesmessage connectapi. a message body that describes who likes the feed 32.0 messagebody element. mylike connectapi. if the context user has liked the feed element, this 32.0 reference property is a reference to the specific like, null otherwise. see also: connectapi.feedelementcapabilities 1737apex reference guide connectapi output classes connectapi.chattermessage chatter message. name type description available version body connectapi.messagebody contents of the message. 29.0 conversationid string id for the conversation. 29.0 conversationurl string connect rest api url identifying the conversation. 29.0 id string id of the message. 29.0 recipients list<connectapi.usersummary> list of |
the recipients of the message. 29.0 sender connectapi.usersummary sender of the message. 29.0 sendingcommunity connectapi.reference information about the experience cloud site from 32.0 which the message was sent. returns null for the default site or if digital experiences isn’t enabled. sentdate datetime the date and time the message was sent. 29.0 url string connect rest api url identifying the current page 29.0 of the conversation. see also: connectapi.chatterconversationsummary connectapi.chattermessagepage connectapi.chattermessagepage chatter message page. name type description available version currentpagetoken string token identifying the current page. 29.0 currentpageurl string connect rest api url identifying the current page. 29.0 messages list<connectapi.chattermessage> messages on the current page. 29.0 nextpagetoken string token identifying the next page, or null if there 29.0 isn’t a next page. 1738apex reference guide connectapi output classes name type description available version nextpageurl string connect rest api url identifying the next page, or 29.0 null if there isn’t a next page. see also: connectapi.chatterconversation connectapi.chatterstream a chatter feed stream. property name type description available version community connectapi. experience cloud site where the stream is. 41.0 communitysummary createddate datetime date the stream was created. 39.0 description string description of the stream. 39.0 id string 18-character id of the stream. 39.0 name string name of the stream. 39.0 subscriptions list<connectapi. list of entities whose feeds are included in the stream. 39.0 feedenabledentity> url string url to the stream. 39.0 see also: connectapi.chatterstreampage connectapi.chatterstreampage a collection of chatter feed streams. property name type description available version currentpageurl string url to the current page of streams. 39.0 items list<connectapi. list of streams. 39.0 chatterstream> nextpageurl string url to the next page of streams. 39.0 in version 39.0, all streams are included in currentpageurl and nextpageurl is null. 1739apex reference guide connectapi output classes property name type description available version total integer total number of streams in the collection. 39.0 connectapi.clientinfo client information. name type description available version applicationname string name of the connected app used for authentication. 28.0 applicationurl string value from the info url field of the connected app used for 28.0 authentication. see also: connectapi.comment connectapi.feeditem connectapi.closecapability if a feed element has this capability, users with permission can close it. users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. if the closed feed element is a poll, users can’t vote on it. users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer. admins and moderators can edit and delete closed feed elements and comments on closed feed elements. admins and moderators can select or remove the best answer status on comments on closed feed elements. property name type description available version cancontextuser boolean specifies whether the context user has permission 43.0 updateisclosed to set the feed element to closed (true) or not (false). isclosed boolean specifies whether the feed element is closed (true) 43.0 or not (false). see also: connectapi.feedelementcapabilities connectapi.comment a comment. 1740apex reference guide connectapi output classes name type description available version attachment connectapi.feeditem if the comment contains an attachment, property value is 28.0–31.0 attachment contentattachment. if the comment does not contain an attachment, it is null. important: as of version 32.0, use the capabilities property. body connectapi.feedbody body of the comment. 28.0 capabilities connectapi. capabilities associated with the comment, such as any file 32.0 commentcapabilities attachments. clientinfo connectapi. information about the connected app used |
to authenticate 28.0 clientinfo the connection. createddate datetime iso 8601 date string, for example, 2011-02-25t18:24:31.000z. 28.0 feedelement connectapi. feed element on which the comment is posted. reference feeditem connectapi. feed item on which the comment is posted. 28.0–31.0 reference important: as of version 32.0, use the feedelement property. id string comment’s 18–character id. 28.0 isdelete boolean if this property is true, the context user can’t delete the 28.0 restricted comment. if this property is false, the context user might be able to delete the comment. likes connectapi.chatter the first page of likes for the comment. 28.0 likepage this property has no information for comments on direct messages. likesmessage connectapi.message a message body that describes who likes the comment. 28.0 body this property is null for comments on direct messages. moderation connectapi. information about the moderation flags on a comment. if 29.0 flags moderationflags connectapi.features.communitymoderation is false, this property is null. mylike connectapi. if the context user liked the comment, this property is a 28.0 reference reference to the specific like, null otherwise. this property is null for comments on direct messages. parent connectapi. information about the parent feed-item for this comment. 28.0 reference 1741apex reference guide connectapi output classes name type description available version relativecreateddate string the created date formatted as a relative, localized string, for 28.0 example, “17m ago” or “yesterday.” threadlevel integer level of nesting for a comment. 0 indicates a standard 44.0 comment with a parent post. 1 indicates a threaded comment with a parent comment and a parent post. 2 indicates a threaded comment with two parent comments and a parent post. the ui is limited to these three levels. threadparentid string id of the parent comment for a threaded comment. 44.0 type connectapi. type of comment. 28.0 commenttype enum • contentcomment—comment holds a content capability. • textcomment—comment contains only text. url string connect rest api url to this comment. 28.0 user connectapi.user information about the comment author. 28.0 summary see also: connectapi.commentpage connectapi.questionandanswerscapability connectapi.commentcapabilities a set of capabilities on a comment. property name type description available version comments connectapi. if a comment has this capability, it has threaded 44.0 commentscapability comments. content connectapi. if a comment has this capability, it has a file 32.0 contentcapability attachment. most connectapi.contentcapability properties are null if the content has been deleted from the feed element or if the access has changed to private. edit connectapi. if a comment has this capability, users who have 34.0 editcapability permission can edit it. feedentityshare connectapi. if a comment has this capability, a feed entity is 42.0 feedentity shared with it. sharecapability 1742apex reference guide connectapi output classes property name type description available version record connectapi. if a comment has this capability, it has a record 42.0 recordcapability attachment. status connectapi. if a comment has this capability, it has a status that 38.0 statuscapability determines its visibility. updownvote connectapi. if a comment has this capability, users can upvote or 41.0 updownvotecapability downvote it. verified connectapi. if a comment has this capability, users with 41.0 verifiedcapability permission can mark it as verified or unverified. see also: connectapi.comment connectapi.commentpage a page of comments. name type description available version comments list<connectapi. collection of comments. 28.0–31.0 comment> important: as of version 32.0, use the items property. currentpagetoken string token identifying the current page. 28.0 currentpageurl string connect rest api url identifying the current page. 28.0 items list<connectapi. collection of comments for this feed element. 32.0 comment> nextpagetoken string token identifying the next |
page, or null if there isn’t a next page. 28.0 if you want to read more of the comments in search results, all the comments in the thread are refreshed, not just the ones that match the search term. avoid using nextpagetoken until the comments are refreshed. nextpageurl string connect rest api url identifying the next page, or null if there isn’t 28.0 a next page. if you want to read more of the comments in search results, all the comments in the thread are refreshed, not just the ones that match the search term. avoid using nextpageurl until the comments are refreshed. previouspagetoken string token identifying the previous page, or null if there isn’t a previous 44.0 page. 1743apex reference guide connectapi output classes name type description available version previouspageurl string connect rest api url identifying the previous page, or null if there 44.0 isn’t a previous page. total integer total number of published comments for the parent feed element. 28.0 see also: connectapi.commentscapability connectapi.commentsummary summary of the comment. subclass of connectapi.useractivitysummary property name type description available version commentid string id of the comment. 42.0 connectapi.commentscapability if a feed element or comment has this capability, the context user can add a comment to it. subclass of connectapi.feedelementcapability. property name type description available version page connectapi. the comments information for this feed element or 32.0 commentpage comment. threaded comments are supported in version 44.0 and later. see also: connectapi.feedelementcapabilities connectapi.commerceactionresult result of executing a commerce action. property name type description available version issuccess boolean specifies whether the action is a success (true) or 53.0 not (false). message string action result message. 53.0 1744apex reference guide connectapi output classes connectapi.commerceaddresscollection a collection of commerce addresses. property name type description available version count integer count of addresses. 54.0 currentpagetoken string token to the current page of addresses. 54.0 currentpageurl string url to the current page of addresses. 54.0 items <slticonnectapi.commerceaddressoutput> address details 54.0 nextpagetoken string token to the next page of addresses. 54.0 nextpageurl string url to the next page of addresses. 54.0 pagesize integer page size for addresses. 54.0 previouspagetoken string token to previous page of addresses. 54.0 previouspageurl string url to the previous page of addresses. 54.0 sortorder connectapi.commerceaddresssort sort order for commerce addresses. 54.0 • 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.commerceaddressoutput address for a commerce account. property name type description available version addressid string id of the address. 54.0 addresstype string type of address (for example, “shipping” or “billing”). 54.0 city string the address city. 54.0 companyname string the address company name. 57.0 country string the address country. 54.0 countrycode string two-character country code. 54.0 fields map<string, record a list of custom address fields, if any. 54.0 field> firstname string the address first name. 57.0 1745apex reference guide connectapi output classes property name type description available version isdefault boolean indicates whether a contact’s address is the preferred 54.0 method of communication (true) or not (false). the default value is false. lastname string the address last name. 57.0 middlename string the address middle name. 57.0 name string name of the contact. 54.0 phonenumber string the address phone number. 57.0 postalcode string zip code or postal code for the address. 54.0 region string the address state. 54.0 regioncode string the address state code. 54.0 street string the address street. 54.0 connectapi.commercesearchindex index information. property name type description available version completiondate datetime completion date and time of |
the index. 52.0 createddate datetime creation date of the index. 52.0 creationtype connectapi. creation type of the index. values are: 52.0 commercesearch • manual indexcreationtype • scheduled id string id of the index. 52.0 indexbuildtype connectapi. build type of the index. values are: 57.0 commercesearch • full indexbuildtype • incremental indexstatus connectapi. status of the index. values are: 52.0 commercesearch • completed indexstatus • failed • inprogress indexusage connectapi. usage of the index. values are: 52.0 commercesearch • live indexusage • outofuse 1746apex reference guide connectapi output classes property name type description available version isincrementable boolean specifies whether the index allows incremental 57.0 indexing (true) or not (false). lastcatalogsnapshottime datetime catalog snapshot time of the index. 57.0 message string detailed message for the index status. 52.0 see also: connectapi.commercesearchindexcollection connectapi.commercesearchindexcollection collection of indexes. property name type description available version indexes list<connectapi. list of up to two indexes. returns the completed, live 52.0 commercesearch index and either the in-progress, out-of-use index or index> the most-recently-failed, out-of-use index. connectapi.commercesearchindexlog search index log information. property name type description available version catalog datetime catalog snapshot time of the index build. 57.0 snapshottime completiondate datetime completion date of the index build. 57.0 createdbyid string id of the user who initiated the index build. 57.0 indexbuildstatus connectapi. status of the index. values are: 57.0 commercesearch • completed indexstatus • failed • inprogress indexbuildtype connectapi. build type of the index. values are: 57.0 commercesearch • full indexbuildtype • incremental indexid string id of the index build. 57.0 message string detailed message for the index build status. 57.0 numberofproducts integer number of new or changed products in the index 57.0 build. 1747apex reference guide connectapi output classes connectapi.commercesearchindexlogcollection collection of search index logs for a webstore. property name type description available version indexlogs list<connectapi. list of up to 100 index logs sorted by most recent 57.0 commercesearch catalog snapshot time of the index. indexlog> connectapi.community experience cloud site. name type description available version allowchatter boolean specifies if guest users can access public groups without logging in. 31.0 accesswithoutlogin allowmembers boolean specifies if members can flag content. 30.0 toflag builderbased boolean specifies whether the service not available page is an auto-generated 52.0 snaenabled experience builder-based page (true) or a static resource page that’s set in workspaces > administration > pages (false). builderurl string experience builder url for the site. 56.0 description string site description. 28.0 guestmember boolean specifies whether guest members can see other members (true) or not 47.0 visibilityenabled (false). id string site id. 28.0 imageoptimization boolean specifies whether images are optimized for guest users on all devices for 56.0 cdnenabled sites using salesforce's cdn for digital experiences (true) or not (false). invitationsenabled boolean specifies whether users can invite other external users. 28.0 knowledgeable boolean specifies whether knowledgeable people and endorsements are available 30.0 enabled for topics (true), or not (false). loginurl string login url for the site. 36.0 membervisibility boolean specifies whether members can see other members (true) or not 45.0 enabled (false). name string site name. 28.0 nicknamedisplay boolean specifies whether nicknames are displayed. 32.0 enabled 1748apex reference guide connectapi output classes name type description available version privatemessages boolean specifies whether members can send and receive private messages to 30.0 enabled and from other members (true) or not (false). reputationenabled boolean specifies whether reputation is calculated and displayed for members. 31.0 sendwelcomeemail boolean specifies whether emails are sent |
to all new users when they join. 28.0 siteascontainer boolean specifies whether the site is an experience builder site (true) or a 41.0 enabled salesforce tabs + visualforce site (false). siteurl string url for the site, which is your experience cloud sites domain plus a url 30.0 prefix. for example, mydomainname.my.site.com/customers. note: if you’re not using enhanced domains, your org’s experience cloud sites url is different. for details, see my domain url formats in salesforce help. status connectapi. status of the experience cloud site. 28.0 communitystatus • live enum • inactive • underconstruction templatename string name of the experience builder template. 46.0 url string connect rest api url to the site. 28.0 urlpathprefix string site-specific url prefix. for example, in the site url 28.0 mydomainname.my.site.com/customers, customers is the urlpathprefix. see also: connectapi.communitypage connectapi.communitypage page of experience cloud sites. name type description available version communities list<connectapi. list of experience cloud sites the context user has access 28.0 community> to. total integer total number of experience cloud sites. 28.0 connectapi.communitysummary summary of an experience cloud site. 1749apex reference guide connectapi output classes property name type description available version id string 18-character id of the site. 41.0 name string localized name of the site. 41.0 see also: connectapi.useractivitysummary connectapi.companyverifysummary company verify summary. subclass of connectapi.userfeedentityactivitysummary no additional properties. connectapi.complexsegment complex segments of field changes. this class is abstract. subclass of connectapi.messagesegment superclass of connectapi.fieldchangesegment name type description available version segments list<connectapi. list of message segments. 28.0 messagesegment> connectapi.compoundrecordfield record field that is a composite of subfields. subclass of connectapi.labeledrecordfield name type description available version fields list<connectapi. collection of subfields that make up the compound field. 29.0 abstract recordfield> connectapi.confirmheldfocapacityoutputrepresentation 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. 1750apex reference guide connectapi output classes property name type description available version confirmheldfo list<connectapi. list of responses to the requests to confirm held 55.0 capacityresponses confirmheldfo fulfillment order capacity at one or more locations. capacityresponse outputrepresentation> connectapi.confirmheldfocapacityresponseoutputrepresentation response to a request to confirm held fulfillment order capacity at one or more locations. property name type description available version capacityresponses list<connectapi. list of responses to the requests to confirm held 55.0 capacityresponse fulfillment order capacity at individual locations. outputrepresentation> connectapi.content a file attached to a feed item. property name type description available version checksum string md5 checksum for the file. 36.0 contenturl string url of the content for links. 36.0 description string description of the attachment. 36.0 downloadurl string url to the content. 36.0 fileextension string extension of the file. 36.0 filesize string size of the file in bytes. if size can’t be determined, 36.0 returns unknown. filetype string type of file, such as pdf. 36.0 haspdfpreview boolean true if the file has a pdf preview available; false 36.0 otherwise. id string 18-character id of the content. 36.0 imagedetails connectapi. image details, or null if the file isn’t an image. 40.0 contentimage filedetails isinmyfilesync boolean true if the file is synced with salesforce files sync. 36.0 note: salesforce files sync was retired on may 25, 2018. mimetype string mime type of the file. 36.0 1751apex reference guide connectapi output classes |
property name type description available version renditionurl string url to the rendition resource for the file. for shared 36.0 files, 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 240 x 180 pixel rendition resource for the 36.0 240by180 file. for shared files, 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 pixel rendition resource for the 36.0 720by480 file. for shared files, 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. sharingoption connectapi. sharing option of the file. values are: 36.0 filesharingoption • allowed—resharing of the file is allowed. • restricted—resharing of the file is restricted. textpreview string text preview of the file if available; null otherwise. 36.0 thumb120by90 string specifies the rendering status of the 120 x 90 preview 36.0 renditionstatus image of the 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. thumb240by180 string specifies the rendering status of the 240 x 180 36.0 renditionstatus preview image of the 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 36.0 renditionstatus preview image of the file. one of these values: • processing—image is being rendered. • failed—rendering process failed. • success—rendering process was successful. 1752apex reference guide connectapi output classes property name type description available version • na—rendering is not available for this image. title string title of the file. 36.0 versionid string version id of the file. 36.0 see also: connectapi.filescapability connectapi.contentcapability if a comment has this capability, it has a file attachment. subclass of connectapi.feedelementcapability. for files attached to a feed post (instead of a comment) in version 36.0 and later, use connectapi.filescapability. if content is deleted from a feed element after it’s posted or if the access to the content is changed to private, the connectapi. contentcapability exists, however most of its properties are null. property name type description available version checksum string md5 checksum for the file. 32.0 contenturl string url of the content for links and google docs. 32.0 description string description of the attachment. 32.0 downloadurl string url to the content. 32.0 fileextension string extension of the file. 32.0 filesize string size of the file in bytes. if size cannot be determined, 32.0 returns unknown. filetype string type of file. 32.0 haspdfpreview boolean true if the file has a pdf preview available, false 32.0 otherwise. id string 18-character id of the content. 32.0 isinmyfilesync boolean true if the file is synced with salesforce files sync; 32.0 false otherwise. note: salesforce files sync was retired on may 25, 2018. mimetype string mime type of the file. 32.0 renditionurl string url to the rendition resource for the file. renditions 32.0 are processed asynchronously and may not be 1753apex reference guide connectapi output classes property name type description available version available immediately after the file has been uploaded. renditionurl240by180 string url to the 240x180 size rendition resource for the 32.0 file. renditions are processed asynchronously and may not be available immediately after the file has been uploaded. renditionurl720by480 string url to the 720x480 size rendition resource for |
the 32.0 file. renditions are processed asynchronously and may not be available immediately after the file has been uploaded. sharingoption connectapi. sharing option of the file. values are: 35.0 filesharingoption • allowed—resharing of the file is allowed. • restricted—resharing of the file is restricted. textpreview string text preview of the file if available, null otherwise. 32.0 the maximum number of characters is 200. thumb120by90 string the status of the rendering of the 120x90 pixel sized 32.0 renditionstatus preview image of the file. should be either processing, failed, success, or na if unavailable. thumb240by180 string the status of the rendering of the 240x180 pixel sized 32.0 renditionstatus preview image of the file. should be either processing, failed, success, or na if unavailable. thumb720by480 string the status of the rendering of the 720x480 pixel sized 32.0 renditionstatus preview image of the file. should be either processing, failed, success, or na if unavailable. title string title of the file. 32.0 versionid string version id of the file. 32.0 see also: connectapi.commentcapabilities connectapi.contenthuballoweditemtypecollection the item types that the context user is allowed to create in a repository folder. property name type description available version alloweditemtypes list<connectapi. a collection of item types that the context user is 39.0 contenthub allowed to create in a repository folder. itemtypesummary> 1754apex reference guide connectapi output classes connectapi.contenthubfielddefinition a field definition. property name type description available version displayname string label or caption of this field. 39.0 ismandatory boolean specifies whether this field is mandatory for the item 39.0 type. maxlength integer maximum length of the value of this field. 39.0 name string name of the field. 39.0 type connectapi. data type of the value of the field. values are: 39.0 contenthub • booleantype variabletype • datetimetype • decimaltype • htmltype • idtype • integertype • stringtype • uritype • xmltype see also: connectapi.contenthubitemtypedetail connectapi.contenthubitemtypedetail the details of an item type associated with a repository folder. subclass of connectapi.abstractcontenthubitemtype property name type description available version fields list<connectapi. a list of fields that the context user is allowed to set 39.0 contenthub in the metadata of this item type. fielddefinition> connectapi.contenthubitemtypesummary the summary of an item type associated with a repository folder. subclass of connectapi.abstractcontenthubitemtype 1755apex reference guide connectapi output classes no additional properties. see also: connectapi.contenthuballoweditemtypecollection connectapi.contenthubpermissiontype a permission type. property name type description available version id string internal id of the permission type in the repository. 39.0 label string label as returned by the repository. 39.0 see also: connectapi.externalfilepermissioninformation connectapi.contenthubprovidertype the type of repository. property name type description available version label string localized label of the provider type. 39.0 type string provider type. one of these values: 39.0 • contenthubbox • contenthubgdrive • contenthubsharepoint • contenthubsharepointoffice365 • contenthubsharepointonedrive • simpleurl see also: connectapi.contenthubrepository connectapi.contenthubrepository a repository. subclass of connectapi.actorwithid 1756apex reference guide connectapi output classes property name type description available version authentication connectapi. repository authentication information. 40.0 contenthub repository authentication features connectapi. repository features. 39.0 contenthub repositoryfeatures label string repository label. 39.0 name string repository name. 39.0 providertype connectapi. repository provider type. 39.0 contenthub providertype rootfolderitemsurl string url to the list of items in the repository root folder. 39.0 see also: connectapi.contenthubrepositorycollection |
connectapi.contenthubrepositoryauthentication authentication information for a repository. property name type description available version authflowurl string 40.0 depends on the authprotocol. • noauthentication—null. • oauth—url to start the oauth flow. • password—url to the authentication settings for external systems. authprotocol connectapi. authentication protocol used for the repository. 40.0 contenthub values are: authentication • noauthentication—repository doesn’t protocol require authentication. • oauth—repository uses oauth authentication protocol. • password—repository uses user name and password authentication protocol. 1757apex reference guide connectapi output classes property name type description available version userhas boolean specifies whether the user has credentials or the 40.0 authsettings administrator configured the external data source to use the same set of credentials for every user (true). otherwise, false. see also: connectapi.contenthubrepository connectapi.contenthubrepositorycollection a collection of repositories. property name type description available version currentpageurl string url to the current page of repositories. 39.0 nextpageurl string url to the next page of repositories, or null if there 39.0 isn’t a next page. previouspageurl string url to the previous page of repositories, or null 39.0 if there isn’t a previous page. repositories list<connectapi. collection of repositories. 39.0 contenthub repository> connectapi.contenthubrepositoryfeatures the features of a repository. property name type description available version canbrowse boolean specifies whether the repository’s folder hierarchy 39.0 can be browsed (true) or not (false). cansearch boolean specifies whether the repository can be searched 39.0 (true) or not (false). see also: connectapi.contenthubrepository connectapi.contentimagefiledetails image file details. 1758apex reference guide connectapi output classes property name type description available version height integer image’s height in pixels. 40.0 imageformat string image’s format. 40.0 orientation string image’s exif orientation value, if present. 40.0 width integer image’s width in pixels. 40.0 see also: connectapi.inlineimagesegment connectapi.contractoutputrepresentation contract list. property name type description available version data list<string> record ids of the contacts. 56.0 connectapi.conversationapplicationdefinitiondetailrespresentation information about the conversation application definition. property name type description available version botinfo connectapi.botinfo basic information of the bot associated with this 54.0 representation conversation application. errormessage string error message for the failed get operation. 54.0 integration connectapi. conversation application integration types. 54.0 application conversation values are: application • api integrationtype • slack integrationname string name of the conversation application. 54.0 issuccess boolean success indicator of the get operation. 54.0 runtimeurl string base url of the bot runtime api. 54.0 connectapi.couponcoderedemptionresult coupon code redemption result. property name type description available version availableredemptions integer number of coupon code redemptions available. 58.0 1759apex reference guide connectapi output classes property name type description available version couponcode string coupon code. 58.0 errormsg string error message when coupon code redemption isn’t 58.0 successful. issuccess boolean specifies whether increasing or decreasing the 58.0 coupon code redemption is successful (true) or not (false). redemptionlimit integer number of coupon code redemptions allowed. 58.0 connectapi.couponcoderedemptioncollection collection of coupon code redemption results. property name type description available version couponcode list<connectapi.coupon list of coupon code redemption results. 58.0 redemptionresults coderedemptionresult> connectapi.createcreditmemooutputrepresentation id of a created credit memo. subclass of connectapi.baseoutputrepresentation. property name type description available version creditmemoid string id of the created credit memo. 48.0 connectapi.changeordersinvoiceoutputrepresentation list of ids of invoices created for change orders |
. subclass of connectapi.baseinvoiceoutputrepresentation. no additional properties. see also: createmultipleinvoices(invoicesinput) connectapi.createmultipleinvoicesfromchangeordersoutputrepresentation connectapi.createmultipleinvoicesfromchangeordersoutputrepresentation list of lists of invoices created from change orders for fees. subclass of connectapi.baseoutputrepresentation. 1760apex reference guide connectapi output classes property name type description available version invoices list<connectapi. list of ids of invoices created from change orders for 56.0 changeordersinvoice fees. include these invoice ids when calling ensure outputrepresentation> refunds for the return that the fees applied to. see also: createmultipleinvoices(invoicesinput) connectapi.createorderpaymentsummaryoutputrepresentation id of the created order payment summary. subclass of connectapi.baseoutputrepresentation. property name type description available version orderpayment string id of the order payment summary. 48.0 summaryid connectapi.credential credential. property name type description available version authentication connectapi. authentication protocol of the external credential. 56.0 protocol credentialauthentication values are: protocol • awssv4 • custom • noauth • oauth authentication connectapi. authentication protocol variant of the external 57.0 protocolvariant credentialauthentication credential. values are: protocolvariant • awssv4_sts—aws signature version 4 with security token service. • jwtbearer—oauth 2.0 json web token bearer flow. • rolesanywhere—aws signature version 4 with identity and access management (iam) roles anywhere. authentication connectapi. status of the credential authentication. values are: 56.0 status credentialauthentication • configured—credential has all required status credentials for at least one principal. 1761apex reference guide connectapi output classes property name type description available version • notconfigured—credential isn’t configured. • unknown—credential status can’t be determined because the authentication protocol is custom. credentials map<string, map of protocol-specific credentials. 56.0 connectapi. credentialvalue> externalcredential string fully qualified developer name of the external 56.0 credential. principalname string name of the external credential named principal. 56.0 principaltype connectapi. type of credential principal. values are: 56.0 credentialprincipal • awsstsprincipal type • namedprincipal • peruserprincipal connectapi.credentialcustomheader credential custom header. property name type description available version headername string header name. 57.0 headervalue string header value that can contain formulas. 57.0 id string id of the customer header parameter. 58.0 sequencenumber integer sequence number of the header. the sequence 57.0 number determines the order of the header. see also: connectapi.externalcredential connectapi.namedcredential connectapi.credentialvalue credential value. property name type description available version encrypted boolean specifies whether the credential value is encrypted 56.0 (true) or not (false). 1762apex reference guide connectapi output classes property name type description available version revision integer revision number of a short-lived credential. 58.0 value string value of the credential. 56.0 see also: connectapi.credential connectapi.currencyrecordfield record field containing a currency value. subclass of connectapi.labeledrecordfield connectapi.customlistaudiencecriteria criteria for the custom list type of custom recommendation audience. subclass of connectapi.audiencecriteria. property name type description available version membercount integer total number of members in the custom 36.0 recommendation audience. members connectapi. members of the custom recommendation audience. 36.0 userreferencepage connectapi.dashboardcomponentsnapshot represents both dashboard component snapshots and alerts you receive when a dashboard component value crosses a threshold. property name type description available version componentid string 18-character id of the dashboard component. 32 |
.0 componentname string the dashboard component name. 32.0 dashboardbodytext string display this text next to the actor in the feed 32.0 element.use this text in place of the default body text. dashboardid string 18-character id of the dashboard. 32.0 dashboardname string the name of the dashboard. 32.0 fullsizeimageurl string the source url to retrieve the full-size image of a 32.0 snapshot. access this url with oauth credentials. lastrefreshdate datetime iso 8601 date specifying when this dashboard 32.0 component was last refreshed. 1763apex reference guide connectapi output classes property name type description available version lastrefresh string display text for the last refresh date, for example, “last 32.0 datedisplaytext refreshed on october 31, 2013.” runninguser connectapi. the running user of the dashboard at the time the 32.0 usersummary snapshot was posted. this value may be null. each dashboard has a running user, whose security settings determine which data to display in a dashboard. thumbnailurl string the source url to retrieve the thumbnail image of a 32.0 snapshot. access this url with oauth credentials. see also: connectapi.dashboardcomponentsnapshotcapability connectapi.datacloudcompanies connectapi.dashboardcomponentsnapshotcapability if a feed element has this capability, it has a dashboard component snapshot. a snapshot is a static image of a dashboard component at a specific point in time. subclass of connectapi.feedelementcapability. property name type description available version dashboardcomponent connectapi. the dashboard component snapshot. 32.0 snapshot dashboardcomponent snapshot see also: connectapi.feedelementcapabilities connectapi.daterecordfield record field containing a date. subclass of connectapi.labeledrecordfield name type description available version datevalue datetime date that a machine can read. 29.0 ignore the trailing 00:00:00.000z characters. connectapi.deleteintent delete intent for a social post. 1764apex reference guide connectapi output classes property name type description available version managedsocialaccount connectapi. managed social account that deletes the social post. 45.0 managedsocialaccount see also: connectapi.deleteintents connectapi.deleteintents list of delete intents for a social post. property name type description available version deletes list<connectapi. list of delete intents for the social post. 45.0 deleteintent> see also: connectapi.socialpostintents connectapi.deletesocialpostintent delete intent for the social post. property name type description available version socialaccountid string id of the social account that deletes the social post. 46.0 socialpostid string id of the social post to delete. 46.0 connectapi.digestjob represents a successfully enqueued api digest job request. property name type description available version period connectapi. time period that’s included in a chatter email digest. 37.0 digestperiod values are: • 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.directmessagecapability if a feed element has this capability, it’s a direct message. 1765apex reference guide connectapi output classes property name type description available version memberchanges connectapi. member activities of the direct message, with the 40.0 directmessage most recent activity first. memberactivitypage members connectapi. members included in the direct message. 39.0 directmessage memberpage originalmembers connectapi. original members of the direct message. 40.0 directmessage memberpage subject string subject of the direct message. 39.0 see also: connectapi.feedelementcapabilities connectapi.directmessagememberactivity direct message member activity. property name type description available version activitydate datetime direct message member activity date. 40.0 actor connectapi. user who changed the direct message membership. 40.0 usersummary membersadded connectapi. members added to the direct message as part of the 40.0 directmessage activity. memberpage membersremoved connectapi. members removed from the direct message as part 40.0 directmessage of |
the activity. memberpage see also: connectapi.directmessagememberactivitypage connectapi.directmessagememberactivitypage a page of direct message member activities. property name type description available version activities list<connectapi. collection of direct message member activities. 40.0 directmessage memberactivity> 1766apex reference guide connectapi output classes 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 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. see also: connectapi.directmessagecapability connectapi.directmessagememberpage a collection of direct message members. property name type description available version currentpagetoken string page token to access the current page of direct 39.0 message members. currentpageurl string url to the current page of direct message members. 39.0 nextpagetoken string page token to access the next page of direct message 39.0 members. nextpageurl string url to the next page of direct message members. 39.0 users list<connectapi. collection of direct message members. 39.0 usersummary> see also: connectapi.directmessagecapability connectapi.directmessagecapability connectapi.directmessagememberactivity connectapi.distancecalculationoutputrepresentation shipping distance data for a set of inventory locations. property name type description available version averagedistance double the average distance from the locations to the order 51.0 recipient. 1767apex reference guide connectapi output classes property name type description available version locations list<connectapi. the list of locations and their distances to the order 51.0 locationoutput recipient. representation> rank integer this result’s rank among all results by average 51.0 distance to the order recipient. connectapi.distinctfacetvalue distinct facet value. this class is a subclass of connectapi.facetvalue. property name type description available version displayname string display name of the facet value. 52.0 nameorid string developer name of the attribute. 52.0 productcount long number of products in the search result that match 52.0 the facet value. see also: connectapi.distinctvaluesearchfacet connectapi.distinctvaluesearchfacet facet with distinct values in product search results. this class is a subclass of connectapi.searchfacet. property name type description available version values list<connectapi. values of the facet found in the search result. sorted 52.0 distinctfacetvalue> by display name in alphabetical order. connectapi.downvotesummary summary of a downvote. subclass of connectapi.userfeedentityactivitysummary no additional properties. connectapi.editcapability if a feed element or comment has this capability, users who have permission can edit it. 1768apex reference guide connectapi output classes property name type description available version iseditrestricted boolean specifies whether editing this feed element or 34.0 comment is restricted. if true, the context user can’t edit this feed element or comment. if false, the context user may or may not have permission to edit this feed element or comment. to determine if the context user can edit a feed element or comment, use the isfeedelementeditablebyme(communityid, feedelementid) or iscommenteditablebyme(communityid, commentid) method. iseditable string the url to check if the context user is able to edit 34.0 bymeurl this feed element or comment. lasteditedby connectapi.actor who last edited this feed element or comment. 34.0 lastediteddate datetime the most recent edit date of this feed element or 34.0 comment. latestrevision integer the most recent revision of this feed element or 34.0 comment. relativelast string relative last edited date, for example, “2h ago.” 34.0 editeddate see also: connectapi.commentcapabilities connectapi.feedelementcapabilities connectapi.emailaddress email address. name type description available version displayname string the display name for the email address. 29.0 emailaddress string |
the email address. 29.0 relatedrecord connectapi. the summary of a related record, for example, a contact or user 36.0 recordsummary summary. see also: connectapi.emailmessagecapability 1769apex reference guide connectapi output classes connectapi.emailattachment an email attachment in an email message. property name type description available version attachment connectapi. record summary of the attachment. 36.0 recordsummary contenttype string type of attachment. 36.0 filename string name of the attachment. 36.0 see also: connectapi.emailmessagecapability connectapi.emailmergefieldcollectioninfo the merge fields for an object. property name type description available version mergefields list<string> list of merge fields for a single object. 39.0 see also: connectapi.emailmergefieldinfo connectapi.emailmergefieldinfo the map for objects and their merge fields. property name type description available version entitytomerge map<string, map for multiple objects and their merge field 39.0 fieldsmap connectapi. collections. emailmergefield collectioninfo> connectapi.emailmessagecapability if a feed element has this capability, it has an email message from a case. subclass of connectapi.feedelementcapability. property name type description available version attachments list<connectapi. attachments in the email message. 36.0 emailattachment> 1770apex reference guide connectapi output classes property name type description available version bccaddresses list<connectapi. bcc addresses for the email message. 36.0 emailaddress> body string body of the email message. 36.0 ccaddresses list<connectapi. cc addresses for the email message. 36.0 emailaddress> direction connectapi. direction of the email message. values are: 32.0 emailmessagedirection • inbound—an inbound message (sent by a customer). • outbound—an outbound message (sent to a customer by a support agent). emailmessageid string id of the email message. 32.0 fromaddress connectapi. from address for the email message. 36.0 emailaddress htmlexpand integer start location of previous email thread. 47.0 emailthread isrichtext boolean indicates whether the body of the email message is 36.0 in rich text format. status connectapi. status of an email message on a case. values are: 47.0 emailmessagestatus • draftstatus • forwardedstatus • newstatus • readstatus • repliedstatus • sentstatus subject string subject of the email message. 32.0 textbody string body of the email message. 32.0–35.0 important: in version 36.0 and later, use the body property. toaddresses list<connectapi. to addresses of the email message. 32.0 emailaddress> totalattachments integer total number of attachments in the email message. 38.0 see also: connectapi.feedelementcapabilities 1771apex reference guide connectapi output classes connectapi.emoji an emoji. property name type description available version category string emoji category. 39.0 shortcut string emoji shortcut. 39.0 unicodecharacter string emoji’s unicode character. 39.0 see also: connectapi.emojicollection connectapi.emojicollection a collection of emoji. property name type description available version emojis list<connectapi. a collection of emoji. 39.0 emoji> see also: connectapi.supportedemojis connectapi.enhancedlinkcapability if a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description. subclass of connectapi.feedelementcapability. property name type description available version description string a description with a 500 character limit. 32.0 icon connectapi.icon a icon. 32.0 linkrecordid string a id associated with the link if the link url refers to 32.0 a salesforce record. linkurl string a link url to a detail page if available content can’t 32.0 display inline. title string a title to a detail page. 32.0 see also: connectapi.feedelementcapabilities 1772apex reference guide connectapi output classes |
connectapi.ensurefundsasyncoutputrepresentation id of the asynchronous background operation. this output only includes the operation id, regardless of whether a call is made to an external payment gateway. it doesn’t include any errors from the operation. subclass of connectapi.baseasyncoutputrepresentation. no additional properties. see also: ensurefundsasync(ordersummaryid, ensurefundsinput) connectapi.ensurerefundsasyncoutputrepresentation id of the asynchronous background operation. this output only includes the operation id, regardless of whether a call is made to an external payment gateway. it doesn’t include any errors from the operation. subclass of connectapi.baseasyncoutputrepresentation. no additional properties. see also: ensurerefundsasync(ordersummaryid, ensurerefundsinput) connectapi.entitylabel an entity's label. property name type description available version label string localized singular label of the entity. 40.0 labelplural string localized plural label of the entity. 40.0 see also: connectapi.recordsummary connectapi.entitylinksegment entity link segment. subclass of connectapi.messagesegment name type description available version motif connectapi.motif a set of small, medium, and large icons that indicate whether 28.0 class the entity is a file, group, record, or user. the motif can also contain the object’s base color. reference connectapi. a reference to the link object if applicable, otherwise, null. 28.0 reference 1773apex reference guide connectapi output classes connectapi.entityrecommendation a chatter, custom, or static recommendation. subclass of connectapi.abstractrecommendation. property name type description available version actonurl string for user, file, group, topic, and record entity 32.0 types, use this connect rest url with a post request to take action on the recommendation. for connectapi.recommendedobject entity types, such as custom recommendations, use the actionurl property of the connectapi.platformaction to take action on the recommendation. action connectapi. specifies the action to take on a recommendation. 32.0 recommendation • follow—follow a file, record, topic, or user. actiontype • join—join a group. • view—view a file, group, article, record, user, custom, or static recommendation. entity connectapi.actor the entity with which the receiver is recommended 32.0 to take action. connectapi.errorresponse base error response. property name type description available version errorcode string error code. 48.0 message string more error detail, if available. 48.0 see also: connectapi.baseoutputrepresentation connectapi.extension an extension. property name type description available version alternative connectapi. alternative representation of the extension. 40.0 representation alternative attachmentid string attachment id of the extension. 41.0 1774apex reference guide connectapi output classes property name type description available version extensionid string id of the extension. 40.0 payload string payload associated with the extension. 40.0 payloadversion string payload version that identifies the structure of the 40.0 payload associated with the extension. see also: connectapi.extensionscapability connectapi.extensiondefinition an extension's definition. property name type description available version canaccess boolean indicates whether users can access the extension 40.0 when it’s associated with a feed element. cancreate boolean indicates whether users can create a feed element 40.0 with the extension in the org. createddate datetime date when the extension was created. 40.0 description string description of the extension. 40.0 iconurl string url to the icon for the extension. 40.0 id string id of the extension. 40.0 information list<connectapi. collection of extension information. 40.0 collection abstractextension information> isenabled boolean indicates whether the extension is enabled in the 40.0 only incommunity site. isenabled boolean indicates whether the extension is enabled in the 40.0 only inlightningpublisher lightning publisher. name string name of the extension. 40.0 position integer position in which the extension is displayed in the 41.0 publisher. see also: connectapi.extensiondefinitions 1775apex reference |
guide connectapi output classes connectapi.extensiondefinitions a collection of extension definitions. 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 extension list<connectapi. collection of extension definitions. 40.0 definitions extensiondefinition> 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. total integer total number of extensions returned. 40.0 connectapi.extensionscapability if a feed element has this capability, it has one or more extension attachments. subclass of connectapi.feedelementcapability. property name type description available version items list<connectapi. list of extensions associated with the feed element. 40.0 extension> see also: connectapi.feedelementcapabilities connectapi.externalcredential external credential, including the named credentials and principals associated with it and the type and status of each principal. if you don’t have the view setup and configuration permission, some properties are empty or show limited information. 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 authenticationprotocol connectapi. authentication protocol of the external credential. 56.0 credentialauthentication values are: protocol • awssv4 • custom • noauth 1776apex reference guide connectapi output classes property name type description available version • oauth authenticationprotocol connectapi. authentication protocol variant of the external 57.0 variant credentialauthentication credential. values are: protocolvariant • awssv4_sts—aws signature version 4 with security token service. • jwtbearer—oauth 2.0 json web token bearer flow. • rolesanywhere—aws signature version 4 with identity and access management (iam) roles anywhere. authenticationstatus connectapi. status of the credential authentication. values are: 56.0 credentialauthentication • configured—credential has all required status credentials for at least one principal. • notconfigured—credential isn’t configured. • unknown—credential status can’t be determined because the authentication protocol is custom. customheaders list<connectapi. list of custom headers. 57.0 credentialcustom header> developername string fully qualified developer name of the external 56.0 credential. id string external credential id. 58.0 masterlabel string external credential label. 56.0 parameters list<connectapi. list of parameters of the external credential. 57.0 externalcredential parameter> principals list<connectapi. list of principals the credential has. 56.0 externalcredential principal> relatednamed list<connectapi. list of named credentials associated to the external 56.0 credentials namedcredential> credential. 1777apex reference guide connectapi output classes property name type description available version url string connect rest api url for the external credential. 58.0 see also: connectapi.externalcredentiallist connectapi.namedcredential connectapi.externalcredentiallist list of external credentials. property name type description available version external list<connectapi. list of external credentials. 56.0 credentials externalcredential> connectapi.externalcredentialparameter external credential parameter. property name type description available version id string parameter id. 58.0 parameterdescription string parameter description. 58.0 parametername string parameter name. if the parametertype is 57.0 authparameter, valid values are: • awsaccountid—valid for awssv4. • awsprofilearn—valid for awssv4 with rolesanywhere. • awsregion—valid for awssv4. • awsservice—valid for awssv4. • awsstsduration—valid for awssv4 with sts or rolesanywhere. • awss |
tsexternalid—valid for awssv4 with sts. • awstrustanchorarn—valid for awssv4 with rolesanywhere. • scope—valid for oauth. other parameter types can be any value. parametertype connectapi. parameter type of the external credential. values are: 57.0 externalcredential • authparameter parametertype • authprovider 1778apex reference guide connectapi output classes property name type description available version • authproviderurl • authproviderurlqueryparameter • jwtbodyclaim • jwtheaderclaim • signingcertificate parametervalue string parameter value. if the parametertype is 57.0 jwtbodyclaim or jwtheaderclaim, the parameter value can contain formulas. if the parametertype is authprovider or signingcertificate, the parameter value is the fully qualified entity name of the corresponding entity. see also: connectapi.externalcredential connectapi.externalcredentialprincipal external credential principal. if you don’t have the view setup and configuration permission, some properties are empty or show limited information. property name type description available version authenticationstatus connectapi. status of the credential authentication. values are: 56.0 credentialauthentication • configured—credential has all required status credentials for at least one principal. • notconfigured—credential isn’t configured. • unknown—credential status can’t be determined because the authentication protocol is custom. id string id of the external credential principal. 58.0 parameters list<connectapi. list of external credential parameters. 58.0 externalcredential parameter> principalaccess list<connectapi. list of access entities associated with the external 58.0 externalcredential credential principal. principalaccess> principalname string name of the external credential named principal. 56.0 1779apex reference guide connectapi output classes property name type description available version principaltype connectapi. type of credential principal. values are: 56.0 credentialprincipal • awsstsprincipal type • namedprincipal • peruserprincipal sequencenumber integer sequence number of the external credential principal. 58.0 see also: connectapi.externalcredential connectapi.externalcredentialprincipalaccess external credential principal access. property name type description available version developername string developer name of the associated access entity. 58.0 id string id of the associated access entity. 58.0 type connectapi. access type of the external credential principal. values 58.0 externalcredential are: principalaccesstype • permissionset • permissionsetgroup • profile see also: connectapi.externalcredentialprincipal connectapi.externalfilepermissioninformation external file permission information. property name type description available version external list<connectapi. available permission types for the parent folder of 39.0 filepermission contenthub the external file, or null for non-external files or types permissiontype> when includeexternalfilepermissionsinfo is false. external boolean true if the retrieval of external file information failed 39.0 filepermissions or if failure includeexternalfilepermissionsinfo is false; false otherwise. 1780apex reference guide connectapi output classes property name type description available version external string explanation of the failure if a failure occurred and 39.0 filepermissions includeexternalfilepermissionsinfo infofailurereason is true; null otherwise. external connectapi. sharing status for the external file. values are: 39.0 filesharing contenthub • domainsharing—file is shared with the status externalitem domain. sharingtype • privatesharing—file is private or shared only with individuals. • publicsharing—file is publicly shared. value is null for non-external files or when includeexternalfilepermissionsinfo is false. repository list<connectapi. available public groups in the external repository or 39.0 publicgroups repositorygroupsummary> null for non-external files or when includeexternalfilepermissionsinfo is false. see also: connectapi.abstractrepositoryfile connectapi.externalmanagedaccountaddressoutput default shipping address for an externally managed account. property name type description available version city string city of the |
external managed account record. 53.0 country string country of the external managed account record. 53.0 geolocationaccuracy string geolocation accuracy of the external managed 53.0 account record. latitude string latitude of the external managed account record. 53.0 longitude string longitude of the external managed account record. 53.0 state string state of the external managed account record. 53.0 street string street of the external managed account record. 53.0 zip string postal code of the external managed account record. 53.0 see also: connectapi.externalmanagedaccountoutput 1781apex reference guide connectapi output classes connectapi.externalmanagedaccountcollectionoutput collection of externally managed accounts. property name type description available version externalmanaged list<connectapi. collection of externally managed accounts. 49.0 accounts externalmanaged accountoutput> totalexternal integer total number of externally managed accounts. 49.0 managedaccounts connectapi.externalmanagedaccountoutput externally managed account. property name type description available version accountid string id of the account managed by another account. 49.0 accountname string name of the external managed account record. 53.0 address connectapi. default shipping address of the external managed 53.0 externalmanagedaccount account. addressoutput externalmanaged string id of the external managed account record. 49.0 accountid ismyaccount boolean specifies whether the account is the context user’s 53.0 account (true) or not (false). see also: connectapi.externalmanagedaccountcollectionoutput connectapi.facetvalue facet value. this class is abstract and is a superclass of connectapi.distinctfacetvalue. property name type description available version type connectapi. search facet type. value is: 52.0 commercesearch • distinctvalue facettype connectapi.features features available to the context user in the org. 1782 |
apex reference guide connectapi output classes property type description available version activityreminder boolean reserved for future use. 37.0 notifications enabled chatter boolean specifies whether chatter is enabled. 28.0 chatteractivity boolean specifies whether user details include information about chatter activity. 28.0 chatteranswers boolean specifies whether chatter answers is enabled. 29.0 note: with the spring ’18 release, salesforce no longer supports chatter answers. users of chatter answers can post, answer, comment, or view existing chatter answers data, but support and updates are scheduled to end. we recommend transitioning to chatter questions. for more information, see end of support for chatter answers in spring ’18. chatter boolean specifies whether user details include global chatter activity. 28.0 globalinfluence chattergroup boolean specifies whether chatter groups can have records associated with them. 30.0 records chattergroup boolean specifies whether chatter records are implicitly shared among group 30.0 recordsharing members when records are added to groups. chatter boolean specifies whether chatter messages are enabled. 28.0 messages chattertopics boolean specifies whether topics are enabled. 28.0 communities boolean specifies whether digital experiences is enabled. 31.0 enabled community boolean specifies whether moderation is enabled. 29.0 moderation community boolean specifies whether reputation is enabled. 32.0 reputation dashboard boolean specifies whether the user can post dashboard component snapshots. 28.0 component snapshots default string iso code of the default currency. applicable only when 28.0 currency multicurrency is false. isocode einstein boolean reserved for future use. 46.0 voiceenabled 1783apex reference guide connectapi output classes property type description available version einstein boolean reserved for future use. 46.0 voiceinpilot enabled einstein boolean reserved for future use. 46.0 voicelogging enabled einstein integer reserved for future use. 46.0 voiceproviderid favorites boolean specifies whether favorites in lightning are enabled. 41.0 enabled feedpolling boolean reserved for future use. 28.0 feedstream boolean specifies whether chatter feed streams are enabled. 39.0 enabled files boolean specifies whether files can act as resources for connect rest api. 28.0 filesoncomments boolean specifies whether files can be attached to comments. 28.0 forecasting3 boolean specifies whether aggregated forecasting is enabled for mobile clients. 38.0 aggregated enabled forecasting boolean specifies whether forecasting is enabled. 38.0 enabled forecasting integer range of the forecasting period. 38.0 periodrange forecasting integer start index for the forecasting period. 38.0 periodstart forecasting connectapi. time period used for forecasting. values are: 38.0 periodtype periodtype • month • quarter • week • year groupscanfollow boolean reserved for future use. 28.0–29.0 ideas boolean specifies whether ideas is enabled. 29.0 liveagent string live agent host name configured for the org. 41.0 hostname managedtopics boolean specifies whether managed topics are enabled. 32.0 enabled 1784apex reference guide connectapi output classes property type description available version maxentity integer specifies the maximum number of feed-enabled entities that can be 39.0 subscriptions subscribed to in a chatter stream. perstream maxfiles integer specifies the maximum number of files that can be added to a feed item. 36.0 perfeeditem maxstreams integer specifies the maximum number of chatter streams that a user can have. 39.0 perperson mobile boolean reserved for future use. 29.0 notifications enabled multicurrency boolean specifies whether the org uses multiple currencies (true) or not 28.0 (false). when false, the defaultcurrencyisocode indicates the iso code of the default currency. offlineedit boolean specifies whether the offline object permissions are enabled for salesforce 37.0 enabled for android and salesforce for ios mobile clients. publisheractions boolean specifies whether actions in the publisher are enabled. 28.0 storedata boolean specifies whether the salesforce for android and salesforce for ios can 30.0 ondevices use secure, persistent storage on mobile devices to cache data. enabled thanksallowed boolean reserved for future use. 28.0 trendingtopics boolean specifies whether trending topics are enabled |
. 28.0 usernav boolean specifies whether users can customize the navigation bar in lightning. 41.0 itemsenabled viralinvites boolean specifies whether existing chatter users can invite people in their 28.0 allowed company to use chatter. wave boolean specifies whether crm analytics is enabled. 36.0 see also: getsettings() connectapi.organizationsettings connectapi.feed chatter feed. 1785apex reference guide connectapi output classes name type description available version feedelement string connect rest api url to post feed elements to this subject. 31.0 posturl feedelements connectapi. page of feed elements for the feed specified in 40.0 feedelement redirectedfeedtype. otherwise, null. page feedelementsurl string connect rest api url to feed elements. 31.0 feeditemsurl string connect rest api url to feed items. 28.0–31.0 ismodifedurl string connect rest api url with a since request parameter that contains 28.0 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. pinnedfeed string url to pinned feed items. 41.0 elementsurl redirected connectapi. filter for the feed specified in redirectedfeedtype. otherwise, 42.0 feedfilter feedfilter null. redirected connectapi. sort order for the feed specified in redirectedfeedtype. 42.0 feedsort feedsort otherwise, null. order redirected connectapi. specifies which feed is returned if pagesize is specified. otherwise, 40.0 feedtype feedtype null. respectsmute boolean indicates whether the feed respects the mute feature. if true, the feed 35.0 shows the ability to mute or unmute each element, depending on the value of ismutedbyme; null if the mute feature is disabled for the organization. connectapi.feedbody feed body. subclass of connectapi.abstractmessagebody no additional properties. see also: connectapi.comment connectapi.feedelement connectapi.feedentitysummary 1786apex reference guide connectapi output classes connectapi.feeddirectory directory of feeds and favorites. name type description available version favorites list<connectapi.feed a list of feed favorites 30.0 favorite> feeds list<connectapi.feeddirectoryitem> a list of feeds 30.0 connectapi.feeddirectoryitem definition of a feed. name type description available version feedelementsurl string connect rest api resource url for the feed elements. feeditemsurl string connect rest api resource url for the feed items of a specific feed. 30.0–31.0 feedtype connectapi the feed type. one of these values: 30.0 .feedtype • bookmarks—contains all feed items saved as bookmarks by the enum 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. • 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. 1787apex reference guide connectapi output classes name type description available version • 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. feedurl string connect rest api resource url for a specific feed 30.0 keyprefix string a key prefix is the first three characters of a record id, which specifies the 30.0 object type. for filter feeds, this value is the key prefix associated with the object type used to filter this feed. all feed items in this feed have a parent whose object type matches this key prefix value. for non-filter feeds, this value is null. 1788apex reference guide connectapi output classes name type description available version label string localized label of the feed 30.0 see also: connectapi.feeddirectory connectapi.feedelement feed elements are the top-level items that a feed contains. feeds are feed element containers. this class is abstract. superclass of: • connectapi.feeditem • connectapi.genericfeedelement property name type description available version body connectapi. information about the feed element. 22.0 feedbody important: use the header.text property as the default value for rendering text because the body.text property can be null. capabilities connectapi. a container for all capabilities that can be included 31.0 feedelement with a feed element. capabilities createddate datetime iso 8601 format date string, for example, 31.0 2011-02-25t18:24:31.000z. feedelementtype connectapi. feed elements are the top-level objects that a feed 31.0 feedelementtype contains. the feed element type describes the characteristics of that feed element. one of these values: • 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. 1789apex reference guide connectapi output classes property name type description available version • 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. header connectapi. the header is the title of the post. this property 31.0 messagebody contains renderable plain text for all the segments of the message. if a client doesn’t know how to render a feed element type, it should render this text. id string 18-character id of the feed element. 22.0 modifieddate datetime iso 8601 format date string, for example, 31.0 2011-02-25t18:24:31.000z. parent connectapi. feed element’s |
parent 28.0 actorwithid relativecreated string the created date formatted as a relative, localized 31.0 date string, for example, “17m ago” or “yesterday.” url string connect rest api url to this feed element. 22.0 see also: connectapi.announcement connectapi.feedelementpage connectapi.pinnedfeedelements connectapi.questionandanswerssuggestions connectapi.feedelementcapabilities a container for all capabilities that can be included with a feed element. property name type description available version approval connectapi. if a feed element has this capability, it includes 32.0 approvalcapability information about an approval. associated connectapi. if a feed element has this capability, it has platform 33.0 actions associatedactions actions associated with it. capability banner connectapi. if a feed element has this capability, it has a banner 31.0 bannercapability motif and style. bookmarks connectapi. if a feed element has this capability, the context user 31.0 bookmarks can bookmark it. capability 1790apex reference guide connectapi output classes property name type description available version bundle connectapi. if a feed element has this capability, it has a container 31.0 bundlecapability of feed elements called a bundle. callcollaboration connectapi. if a feed element has this capability, it has a recording 51.0 callcollaboration comment. capability canvas connectapi.canvas if a feed element has this capability, it renders a 32.0 capability canvas app. casecomment connectapi.case if a feed element has this capability, it has a case 32.0 commentcapability comment on the case feed. chatterlikes connectapi. if a feed element has this capability, the context user 31.0 chatterlikes can like it. exposes information about existing likes. capability close connectapi. if a feed element has this capability, users with 43.0 closecapability permission can close it. comments connectapi. if a feed element or comment has this capability, the 31.0 commentscapability context user can add a comment to it. content connectapi. if a comment has this capability, it has a file 32.0–35.0 contentcapability attachment. most connectapi.contentcapability properties are null if the content has been deleted from the feed element or if the access has changed to private. important: in version 36.0 and later, use the files property. dashboardcomponent connectapi. if a feed element has this capability, it has a 32.0 snapshot dashboardcomponent dashboard component snapshot. a snapshot is a snapshotcapability static image of a dashboard component at a specific point in time. directmessage connectapi. if a feed element has this capability, it’s a direct 39.0 directmessage message. capability edit connectapi. if a feed element has this capability, users who have 34.0 editcapability permission can edit it. emailmessage connectapi. if a feed element has this capability, it has an email 32.0 emailmessage message from a case. capability enhancedlink connectapi. if a feed element has this capability, it has a link that 32.0 enhancedlink may contain supplemental information like an icon, capability a title, and a description. 1791apex reference guide connectapi output classes property name type description available version extensions connectapi. if a feed element has this capability, it has one or 40.0 extensionscapability more extension attachments. feedentityshare connectapi. if a feed element or comment has this capability, a 39.0 feedentity feed entity is shared with it. sharecapability files connectapi. if a feed element has this capability, it has one or 36.0 filescapability more file attachments. interactions connectapi. if a feed element has this capability, it has information 37.0 interactions about user interactions. capability link connectapi. if a feed element has this capability, it has a link. 32.0 linkcapability mediareferences connectapi. if a feed element has this capability, it has one or 41.0 mediareference more media references. capability moderation connectapi. if a feed element has this capability, users in an 31.0 moderation experience cloud site can flag it for |
moderation. capability mute connectapi. if a feed element has this capability, users can mute 35.0 mutecapability it. origin connectapi. if a feed element has this capability, it was created 33.0 origincapability by a feed action. pin connectapi. if a feed element has this capability, users who have 41.0 pincapability permission can pin it to a feed. poll connectapi. if a feed element has this capability, it includes a poll. 31.0 pollcapability questionandanswers connectapi. if a feed element has this capability, it has a question 31.0 questionandanswers and comments on the feed element are answers to capability the question. readby connectapi. if a feed element has this capability, the context user 40.0 readbycapability can mark it as read. recommendations connectapi. if a feed element has this capability, it has a 32.0 recommendations recommendation. capability recordsnaphot connectapi. if a feed element has this capability, it contains all the 32.0 recordsnapshot snapshotted fields of a record for a single create capability record event. 1792apex reference guide connectapi output classes property name type description available version socialpost connectapi. if a feed element has this capability, it can interact 36.0 socialpostcapability with a social post on a social network. status connectapi. if a feed post or comment has this capability, it has 37.0 statuscapability a status that determines its visibility. topics connectapi. if a feed element has this capability, the context user 31.0 topicscapability can add topics to it. topics help users organize and discover conversations. trackedchanges connectapi. if a feed element has this capability, it contains all 32.0 trackedchanges changes to a record for a single tracked change event. capability updownvote connectapi. if a feed post or comment has this capability, users 41.0 updownvotecapability can upvote or downvote it. see also: connectapi.feedelement connectapi.feeditemsummary connectapi.feedelementcapability a feed element capability, which defines the characteristics of a feed element. in api version 30.0 and earlier, most feed items can have comments, likes, topics, and so on. in version 31.0 and later, every feed item (and feed element) can have a unique set of capabilities. if a capability property exists on a feed element, that capability is available, even if the capability property doesn’t have a value. for example, if the chatterlikes capability property exists on a feed element (with or without a value), the context user can like that feed element. if the capability property doesn’t exist, it isn’t possible to like that feed element. a capability can also contain associated data. for example, the moderation capability contains data about moderation flags. this class is abstract. this class is a superclass of: • connectapi.associatedactionscapability • connectapi.approvalcapability • connectapi.bannercapability • connectapi.bookmarkscapability • connectapi.bundlecapability • connectapi.callcollaborationcapability • connectapi.canvascapability • connectapi.casecommentcapability • connectapi.chatterlikescapability • connectapi.closecapability • connectapi.commentscapability 1793apex reference guide connectapi output classes • connectapi.contentcapability • connectapi.dashboardcomponentsnapshotcapability • connectapi.directmessagecapability • connectapi.emailmessagecapability • connectapi.enhancedlinkcapability • connectapi.extensionscapability • connectapi.feedentitysharecapability • connectapi.filescapability • connectapi.interactionscapability • connectapi.linkcapability • connectapi.mediareferencecapability • connectapi.moderationcapability • connectapi.mutecapability • connectapi.origincapability • connectapi.pincapability • connectapi.pollcapability • connectapi.questionandanswerscapability • connectapi.readbycapability • connectapi.recommendationscapability • connectapi.recordcapability • connectapi.recordsnapshot |
capability • connectapi.socialpostcapability • connectapi.statuscapability • connectapi.topicscapability • connectapi.trackedchangescapability • connectapi.updownvotecapability • connectapi.verifiedcapability this class doesn’t have any properties. connectapi.feedelementpage a paged collection of connectapi.feedelement objects. property name type description available version currentpagetoken string token identifying the current page. 31.0 currentpageurl string connect rest api url identifying the current page. 31.0 elements list<connectapi. collection of feed elements. 31.0 feedelement> ismodifiedtoken string opaque polling token to use in the since 31.0 parameter of the chatterfeeds.ismodified 1794apex reference guide connectapi output classes property name type description available version 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 31.0 parameter 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. nextpagetoken string token identifying the next page, or null if there 31.0 isn’t a next page. nextpageurl string connect rest api url identifying the next page, or 31.0 null if there isn’t a next page. updatestoken string a token to use in a request to the 31.0 connectapi.chatterfeeds.getfeedelementsupdatedsince method. updatesurl string connect rest api feed resource containing the feed 31.0 elements that have been updated since the feed was refreshed. if the feed doesn’t support this feature, the value is null. see also: connectapi.bundlecapability connectapi.feed connectapi.feedenabledentity an entity that can have feeds associated with it. property name type description available version id string the 18-character id of the record. 39.0 motif connectapi.motif small, medium, and large icons indicating the 39.0 record's type. 1795apex reference guide connectapi output classes property name type description available version name string the localized name of the record. 39.0 type string the type of the record. 39.0 url string url to the record. 39.0 see also: connectapi.chatterstream connectapi.feedentityiseditable indicates if the context user can edit a feed element or comment. property name type description available version areattachments boolean true if the context user can add and remove 36.0 editablebyme attachments on the feed element or comment, false otherwise. feedentityurl string url of the feed element or comment. 34.0 iseditablebyme boolean true if the context user can edit the feed element 34.0 or comment, false otherwise. connectapi.feedentitynotavailablesummary a summary when the feed entity isn’t available. subclass of connectapi.feedentitysummary. no additional properties. connectapi.feedentityreadsummary summary of the feed post or comment that was read. subclass of connectapi.userfeedentityactivitysummary. no additional properties. connectapi.feedentitysharecapability if a feed element or comment has this capability, a feed entity is shared with it. subclass of connectapi.feedelementcapability. 1796apex reference guide connectapi output classes property name type description available version feedentity connectapi. the summary of the feed entity that is shared with 39.0 feedentity the feed element or comment. summary see also: connectapi.feedelementcapabilities connectapi.feedentitysummary the summary of a feed entity that is shared with a feed element. this class is abstract. superclass of: • connectapi.feeditemsummary • connectapi.feedentitynotavailablesummary property name type description available version actor connectapi.actor entity that created the feed entity. 39.0 body connectapi. information about the feed entity. 39.0 |
feedbody createddate datetime iso 8601 date string, for example, 39.0 2011-02-25t18:24:31.000z, when the entity was created. feedelementtype connectapi. type of feed entity. 39.0 feedelementtype • 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. id string 18-character id of the feed entity. 39.0 1797apex reference guide connectapi output classes property name type description available version isentityavailable boolean specifies whether the entity is available. if false, 39.0 either the user doesn’t have access to the entity or the entity was deleted. parent connectapi. parent of the feed entity. 39.0 actorwithid relativecreateddate string relative created date, for example, “2h ago.” 39.0 url string url to the feed entity. 39.0 see also: connectapi.feedentitysharecapability connectapi.feedfavorite feed favorite. name type description available version community connectapi.reference information about the experience cloud site that 28.0 contains the favorite. createdby connectapi.user favorite’s creator. 28.0 summary feedurl string connect rest api url identifying the feed item for 28.0 this favorite. id string favorite’s 18–character id. 28.0 lastviewdate datetime iso 8601 date string, for example, 28.0 2011-02-25t18:24:31.000z. name string favorite’s name. 28.0 searchtext string if the favorite is from a search, contains the search text, 28.0 otherwise, an empty string. target connectapi.reference a reference to the topic if applicable, null otherwise. 28.0 type connectapi. an empty string or one of the following values: 28.0 feedfavoritetype enum • listview • search • topic url string connect rest api url to this favorite. 28.0 1798apex reference guide connectapi output classes name type description available version user connectapi.user information about the user who saved this favorite. 28.0 summary see also: connectapi.feeddirectory connectapi.feedfavorites connectapi.feedfavorites feed favorites. name type description available version favorites list<connectapi.feed complete list of favorites. 28.0 favorite> total integer total number of favorites. 28.0 connectapi.feeditem subclass of connectapi.feedelement class as of 31.0. name type description available version actor connectapi.actor the entity that created the feed item. 28.0 attachment connectapi.feeditem information about the attachment. if there is no 28.0–31.0 attachment attachment, returns null. important: as of version 32.0, use the inherited capabilities property. canshare boolean indicates whether the feed item can be shared. 28.0–38.0 if a feed item has multiple file attachments and at least one attachment has been deleted or is inaccessible, the feed item can’t be shared. the canshare value is incorrectly set to true in these cases. important: as of version 39.0, use the issharable property. clientinfo connectapi.clientinfo information about the connected app used to 28.0 authenticate the connection. 1799apex reference guide connectapi output classes name type description available version comments connectapi.commentpage first page of comments for this feed item. 28.0–31.0 important: as of version 32.0, use the inherited capabilities.comments.page property. event boolean true if feed item is created due to an event change, 22.0 false otherwise. hasverified boolean true if |
the feed item has a verified comment, 41.0 comment otherwise false. isbookmarked boolean true if the context user has bookmarked this feed 28.0–31.0 bycurrentuser item, otherwise, false. important: as of version 32.0, use the inherited capabilities.bookmarks.isbookmarkedbycurrentuser property. isdelete boolean if this property is true the comment cannot be 28.0 restricted deleted by the context user. if it is false, it might be possible for the context user to delete the comment, but it is not guaranteed. islikedby boolean true if the context user has liked this feed item, 28.0–31.0 currentuser otherwise, false. important: as of version 32.0, use the inherited capabilities.chatterlikes.islikedbycurrentuser property. issharable boolean indicates whether the feed item can be shared. 39.0 likes connectapi.chatterlike first page of likes for this feed item. 28.0–31.0 page important: as of version 32.0, use the inherited capabilities.chatterlikes.page property. likesmessage connectapi.messagebody a message body the describes who likes the feed item. 28.0–31.0 important: as of version 32.0, use the inherited capabilities.chatterlikes.likesmessage property. 1800apex reference guide connectapi output classes name type description available version moderationflags connectapi. information about the moderation flags on a feed 29.0–30.0 moderationflags item. if connectapi.features.communitymoderation is false, this property is null. important: as of version 31.0, use the inherited capabilities.moderation.moderationflags property. mylike connectapi.reference if the context user has liked the feed item, this 28.0–31.0 property is a reference to the specific like, otherwise, null. important: as of version 32.0, use the inherited capabilities.chatterlikes.mylike property. originalfeeditem connectapi.reference a reference to the original feed item if this feed item 28.0 is a shared feed item, otherwise, null. originalfeed connectapi.actor if this feed item is a shared feed item, returns 28.0 itemactor information about the original poster of the feed item, otherwise, returns null. photourl string url of the photo associated with the feed item 28.0 preamble connectapi.messagebody a collection of message segments, including the 28.0-30.0 unformatted text of the message that you can use as the title of a feed item. message segments include name, link, and motif icon information for the actor that created the feed item. important: for api versions 29.0 and 30.0, use the connectapi.feeditem.preamble.text property as the default case to render text. for api versions 31.0 and later, use the connectapi.feedelement.header.text property as the default case to render text. topics connectapi.feeditemtopicpage topics for this feed item. 28.0–31.0 important: as of version 31.0, use the inherited capabilities.topics.items property. 1801apex reference guide connectapi output classes name type description available version type connectapi.feeditemtype type of feed item. 28.0 important: as of api version 32.0, use the capabilities property to determine what can be done with a feed item. see working with feeds and feed elements. one of these values: • 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. 1802apex reference guide connectapi output classes name type description available version • 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. • 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. visibility connectapi.feeditem type of users who can see a feed item. 28.0 visibilitytype • allusers—visibility is not limited to internal users. 1803apex reference guide connectapi output classes name type description available version • internalusers—visibility is limited to internal users. connectapi.feeditemsummary a feed item summary. subclass of connectapi.feedentitysummary. property name type description available version capabilities connectapi. container for all capabilities that can be included 39.0 feedelement with a feed item. capabilities header connectapi. title of the post. this property contains renderable 39.0 messagebody plain text for all the message segments. if a client doesn’t know how to render a feed element type, it should render this text. modifieddate datetime when the feed item was modified in the form of an 39.0 iso 8601 date string, for example, 2011-02-25t18:24:31.000z. originalfeeditem connectapi. reference to the original feed item if this feed item 39.0 reference is a shared feed item; otherwise, null. originalfeed connectapi.actor if this feed item is a shared feed item, information 39.0 itemactor about the original poster of the feed item; otherwise, null. photourl string url of the photo associated with the feed item. 39.0 visibility connectapi. specifies who can see a feed item. 39.0 feeditemvisibility • allusers—visibility is not limited to internal users. • internalusers—visibility is limited to internal users. connectapi.feedmodifiedinfo important: this feature is available through a feed polling pilot program. this pilot program is closed and not accepting new participants. 1804apex reference guide connectapi output classes name type description available version ismodified boolean true if the news feed has been modified since the last time it was 28.0 polled; false otherwise. returns null if the feed is not a news feed. ismodified |
token string opaque polling token to use in the since parameter of the 28.0 chatterfeeds.ismodified method. the token describes when the feed was last modified. nextpollurl string connect rest api url with a since request parameter that contains 28.0 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. connectapi.feedpollchoice feed poll choice. name type description available version id string poll choice id. 28.0 position integer the location in the poll where this poll choice exists. the first poll 28.0 choice starts at 1. text string label text associated with the poll choice. 28.0 votecount integer total number of votes for this poll choice. 28.0 votecountratio double the ratio of total number of votes for this poll choice to all votes cast 28.0 in the poll. multiply the ratio by 100 to get the percentage of votes cast for this poll choice. see also: connectapi.pollcapability connectapi.feedpostsummary summary of the post. subclass of connectapi.useractivitysummary. property name type description available version feeditemid string id of the post. 42.0 connectapi.feedreadsummary summary of the feed that was read. 1805apex reference guide connectapi output classes subclass of connectapi.useractivitysummary. property name type description available version containerid string id of the parent of the feed. 42.0 feedtype connectapi.feedtype type of feed. 42.0 • 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. • 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. 1806apex reference guide connectapi output classes property name type description available version 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.fieldchangesegment field change segment. subclass of connectapi.complexsegment. no additional properties. see also: connectapi.morechangessegment 1807apex reference guide connectapi output classes connectapi.fieldchangenamesegment field change name segment. subclass of connectapi.messagesegment. no additional properties. connectapi.fieldchangevaluesegment field change value segment. subclass of connectapi.messagesegment. name type description available version valuetype connectapi. value type of a field change. 28.0 fieldchange • newvalue—a new value valuetype enum • oldvalue—an old value url string url value if the field change is to a url field (such as 28.0 a web address) connectapi.fieldvalue field's value in product search results. property name type description available version value string value of the field. 52.0 see also: connectapi.productsummary connectapi.file file. this class is abstract. subclass of connectapi.actorwithid. superclass of connectapi.filesummary. name type description available version checksum string md5 checksum for the file. 28.0 content datetime iso 8601 format date string, for example, 32.0 modifieddate 2011-02-25t18:24:31.000z. file-specific modified date, which is updated only for direct file operations, such as rename. 1808apex reference guide connectapi output classes name type description available version modifications to the file from outside of salesforce can update this date. contentsize integer size of the file in bytes. 28.0 contenturl string if the file is a link, returns the url, otherwise, the string null. 28.0 createddate datetime iso 8601 date string when the file was created. 41.0 description string description of the file. 28.0 downloadurl string url to the file, that can be used for downloading the file. 28.0 fileextension string extension of the file. 28.0 filetype string type of file, such as pdf, powerpoint. 28.0 flashrendition string specifies if a flash preview version of the file has been 28.0 status rendered. note: flash renditions were retired on july 16, 2021. isfileasset boolean specifies whether the file is an asset. 46.0 isinmyfilesync boolean true if the file is synced with salesforce files sync; false 28.0 otherwise. note: salesforce files sync was retired on may 25, 2018. ismajorversion boolean true if the file is a major version; false if the file is a 31.0 minor version. major versions can’t be replaced. mimetype string file’s mime type. 28.0 moderationflags connectapi. information about the moderation flags on a file. if 30.0 moderationflags connectapi.features.communitymoderation is false, this property is null. modifieddate datetime iso 8601 format date string, for example, 28.0 2011-02-25t18:24:31.000z. modifications to the file from within salesforce update this date. name string name of the file. 28.0 origin string specifies the file source. valid values are: 28.0 • chatter—file came from chatter • content—file came from content owner connectapi.user file’s owner. 28.0 summary pdfrendition string specifies if a pdf preview version of the file has been 28.0 status rendered. 1809apex reference guide connectapi output classes name type description available version publishstatus connectapi. specifies the publish status of the file. 28.0 filepublishstatus • pendingaccess—file is pending publishing. • privateaccess—file is private. • publicaccess—file is public. renditionurl string url to the rendition for the file. 28.0 renditionurl string url to the 240 x 180 rendition resource for the file.for shared 29.0 240by180 files, rend |
itions 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 29.0 720by480 files, 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. sharingoption connectapi. sharing option of the file. values are: 35.0 filesharingoption • allowed—resharing of the file is allowed. • restricted—resharing of the file is restricted. sharingprivacy connectapi. sharing privacy of a file. values are: 41.0 filesharingprivacy • none—file is visible to anyone with record access. • privateonrecords—file is private on records. sharingrole connectapi. sharing role of the file. 28.0 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. systemmodstamp datetime iso 8601 date string indicating when a user or any automated 41.0 system process, such as a trigger, updated the file. textpreview string text preview of the file if available; null otherwise. 30.0 thumb120by90 string specifies the rendering status of the 120 x 90 preview image 28.0 renditionstatus of the file. one of these values: • processing—image is being rendered. • failed—rendering process failed. 1810apex reference guide connectapi output classes name type description available version • success—rendering process was successful. • na—rendering is not available for this image. thumb240by180 string specifies the rendering status of the 240 x 180 preview image 28.0 renditionstatus of the 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 28.0 renditionstatus of the 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 versionnumber string file’s version number. 28.0 connectapi.fileasset an asset file. property name type description available version baseasseturl string base download url of the asset. 45.0 baseunauthenticated string base download url of the asset for unauthenticated 45.0 asseturl users if isvisiblebyexternalusers is true, otherwise null. id string id of the asset. 45.0 isvisibleby boolean indicates whether unauthenticated users can see the 45.0 externalusers asset file (true) or not (false). masterlabel string label of the asset. 45.0 name string unique name of the asset. 45.0 namespaceprefix string namespace prefix of the package containing the 45.0 asset. 1811apex reference guide connectapi output classes property name type description available version type string type of asset. 45.0 see also: connectapi.recommendation connectapi.nbanativerecommendation connectapi.filepreview a file preview. property name type description available version format connectapi. the format of the preview. values are: 39.0 filepreviewformat • jpg—preview format is jpg. • 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. previewurlcount integer the total number of preview urls for this preview 39.0 format. previewurls list<connectapi. a |
list of file preview urls. 39.0 filepreviewurl> status connectapi. the availability status of the preview. values are: 39.0 filepreviewstatus • available—preview is available. • inprogress—preview is being processed. • notavailable—preview is unavailable. • notscheduled—generation of the preview isn’t scheduled yet. url string the url for the file preview. 39.0 see also: connectapi.filepreviewcollection connectapi.filepreviewcollection a collection of file previews. 1812apex reference guide connectapi output classes property name type description available version fileid string id of the file. 39.0 previews list<connectapi. previews supported for the file. 39.0 filepreview> url string url to the current page of file previews. 39.0 versionnumber string version number of the file. 40.0 see also: connectapi.inlineimagesegment connectapi.filepreviewurl a url to a file preview. property name type description available version pagenumber integer preview page number starting from zero, or null 39.0 for pdf files. previewurl string file preview url. 39.0 see also: connectapi.filepreview connectapi.filescapability if a feed element has this capability, it has one or more file attachments. subclass of connectapi.feedelementcapability. property name type description available version items list<connectapi. collection of files. 36.0 content> see also: connectapi.feedelementcapabilities connectapi.filesummary a file summary. subclass of connectapi.file. no additional properties. 1813apex reference guide connectapi output classes connectapi.findrouteswithfewestsplitsoutputrepresentation a list of inventory location combinations that can fulfill an order without exceeding the maximum number of shipments. subclass of connectapi.baseoutputrepresentation. property name type description available version targetlocations list<connectapi. each element of the list is a set of inventory locations 51.0 availablelocation that together can fulfill the order being routed. outputrepresentation> see also: findrouteswithfewestsplits(findrouteswithfewestsplitsinputrepresentation) connectapi.findrouteswithfewestsplitsusingocioutputrepresentation a list of order fulfillment routes with inventory availability information. subclass of connectapi.baseoutputrepresentation. property name type description available version results list<connectapi. each element of the list is the response for one 54.0 findrouteswithfewest element of the input list. splitswithinventory outputrepresentation> see also: findrouteswithfewestsplitsusingoci(findrouteswithfewestsplitsusingociinput) connectapi.findrouteswithfewestsplitswithinventoryoutputrepresentation sets of inventory locations that can combine to fulfill an order, with availability data for those locations. subclass of connectapi.baseoutputrepresentation. property name type description available version inventory connectapi. inventory availability data for the location groups and 54.0 ocigetinventoryavailability locations specified in the input. outputrepresentation 1814apex reference guide connectapi output classes property name type description available version targetlocations list<connectapi. each entry in the list is a set of inventory locations 54.0 availablelocation that can combine to fulfill an order. outputrepresentation> see also: findrouteswithfewestsplitsusingoci(findrouteswithfewestsplitsusingociinput) connectapi.findrouteswithfewestsplitsusingocioutputrepresentation connectapi.followerpage name type description available version currentpageurl string connect rest api url identifying the current page. 28.0 followers list<connectapi. list of subscriptions. 28.0 subscription> 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 followers across all pages. 28.0 connectapi.followingcounts name type description available version people integer number of people user is following. 28.0 records integer number of |
records user is following. 28.0 topics are a type of record that can be followed as of version 29.0. total integer total number of items user is following. 28.0 see also: connectapi.userdetail connectapi.followingpage name type description available version currentpageurl string connect rest api url identifying the current page. 28.0 1815apex reference guide connectapi output classes name type description available version following list<connectapi. list of subscriptions. 28.0 subscription> nextpageurl string connect rest api url identifying the next page, or 28.0 null if there isn’t a next page. previouspageurl string connect rest api url identifying the previous page, 28.0 or null if there isn’t a previous page. total integer total number of records being followed across all 28.0 pages. connectapi.followintents a list of follow intents for a social persona. property name type description available version follows list<connectapi. list of follow intents for the social persona. 45.0 followsocial personaintent> see also: connectapi.socialpostintents connectapi.followsocialpersonaintent follow intent on a social persona. property name type description available version managedsocialaccount connectapi. managed social account that follows the social 45.0 managedsocialaccount persona. socialpersonaid string id of the social persona to follow. 45.0 see also: connectapi.followintents connectapi.form marketing integration form. property name type description available version dataextensionid string id of the data extension associated with the 53.0 marketing integration form. 1816apex reference guide connectapi output classes property name type description available version formfieldslist connectapi. list of form fields associated with the marketing 53.0 formfields integration form. formid string id of the marketing integration form. 53.0 formname string name of the marketing integration form. 53.0 connectapi.formfield marketing integration form field. property name type description available version name string name of the marketing integration form field. 53.0 type connectapi. type of marketing integration form field. values are: 53.0 formfieldtype • boolean • date • emailaddress • number • text see also: connectapi.formfields connectapi.formfields list of marketing integration form fields. property name type description available version formfields list<connectapi. list of form fields associated with the marketing 53.0 formfield> integration form. see also: connectapi.form connectapi.formsubmission marketing integration form submission. property name type description available version formsubmissionid string id of the form submission, representing the 53.0 submission data that was saved. 1817apex reference guide connectapi output classes connectapi.formulascope formula scope for a target. property name type description available version contextvalues map<string, string> map of context values for the scope. 50.0–51.0 note: in version 52.0 and later, use the contextvaluesmap property. contextvaluesmap map<string, object> map of context values for the scope. 52.0 fields list<string> list of fields of the scope. 50.0 formula string formula of the scope. 50.0 see also: connectapi.target connectapi.fulfillmentgroupoutputrepresentation information about one fulfillmentorder from a request to create fulfillment orders from multiple orderdeliverygroupsummaries. if the fulfillmentorder was created, then its id is returned. if it failed, then data from the input is returned so you can resubmit it. subclass of connectapi.baseoutputrepresentation. property name type description available version fulfilledfromlocationid string (creation failed) the input fulfilledfromlocationid. 50.0 fulfillmentorderid string the fulfillmentorderid from the successfully created 50.0 fulfillmentorder. fulfillmenttype string (creation failed) the input fulfillmenttype. 50.0 orderdeliverygroup string (creation failed) the input 50.0 summaryid orderdeliverygroupsummaryid. orderitemsummaries list<connectapi. (creation failed) the input list of 50.0 orderitemsummary orderitemsummaries. |
outputrepresentation> ordersummaryid string (creation failed) the input ordersummaryid. 50.0 referenceid string the referenceid from the fulfillmentgroup input 50.0 representation. use this value to troubleshoot a failure. connectapi.fulfillmentordercancellineitemsoutputrepresentation wraps the base output. 1818apex reference guide connectapi output classes subclass of connectapi.baseoutputrepresentation. no additional properties. connectapi.fulfillmentorderinvoiceoutputrepresentation id of the created invoice. subclass of connectapi.baseoutputrepresentation. property name type description available version invoiceid string id of the created invoice. 48.0 connectapi.fulfillmentorderoutputrepresentation a list of ids of the created fulfillmentorders. subclass of connectapi.baseoutputrepresentation. property name type description available version fulfillment list<string> a list of ids of created fulfillment orders. 48.0 orderids connectapi.gatewaylogresponse gateway log output. property name type description available version createddate datetime date when the gateway log was created. 50.0 gatewayresultcode string result codes that show the status of a transaction as 50.0 it is passed to the financial institution and then returned to the client. id string id of the gateway log record. 50.0 interactionstatus string gateway interaction status. it can be success, 50.0 failed, or timeout. connectapi.genericbundlecapability if a feed element has this capability, the feed element has a group of other feed elements condensed into one feed element. this group is called a bundle. subclass of connectapi.bundlecapability. connectapi.genericfeedelement a concrete implementation of the abstract connectapi.feedelement class. 1819apex reference guide connectapi output classes subclass of connectapi.feedelement connectapi.getfocapacityvaluesoutputrepresentation response to a request for fulfillment order capacity values for one or more locations. subclass of connectapi.baseoutputrepresentation. property name type description available version locations list<connectapi. list of fulfillment order capacity values for one or 55.0 locationcapacity more locations. outputrepresentation> connectapi.globalinfluence chatter influence. name type description available version percentile string percentile value for the user’s influence rank within the org or 28.0 experience cloud site. rank integer number indicating the user’s influence rank, relative to all other 28.0 users within the org or experience cloud site. see also: connectapi.userdetail connectapi.groupchattersettings a user’s chatter settings for a specific group. name type description available version emailfrequency connectapi. the frequency with which a group member receives 28.0 groupemailfrequency email from a group. enum connectapi.groupinformation describes the information section of the group. if the group is private, this section is visible only to members. name type description available version text string the text of the “information” section of the group. 28.0 1820apex reference guide connectapi output classes name type description available version title string the title of the “information” section of the group. 28.0 see also: connectapi.chattergroupdetail connectapi.groupmember member of a group. name type description available version id string user’s 18-character id. 28.0 lastfeed datetime the date and time at which the group member last 31.0 accessdate accessed the group feed. role connectapi. type of membership the user has with the group. 28.0 groupmembership • groupowner type enum • groupmanager • notamember • notamemberprivaterequested • standardmember url string connect rest api url to this membership. 28.0 user connectapi.user information about the user who is subscribed to this 28.0 summary group. see also: connectapi.groupmemberpage connectapi.groupmemberpage page of group members. name type description available version currentpageurl string connect rest api url identifying the current page. 28.0 members list<connectapi. list of group members. 28.0 groupmember> mymembership connect |
api. if the context user is a member of this group, returns 28.0 reference information about that membership, otherwise, null. 1821apex reference guide connectapi output classes name type description available version nextpageurl string connect rest api url identifying the next page, or null if 28.0 there isn’t a next page. previouspageurl string connect rest api url identifying the previous page, or null 28.0 if there isn’t a previous page. totalmembercount integer total number of group members across all pages. 28.0 connectapi.groupmembershiprequest request to become a group member. name type description available version createddate datetime iso 8601 date string, for example, 2011-02-25t18:24:31.000z. 28.0 id string id for the group membership request object. 28.0 lastupdatedate datetime iso 8601 date string, for example, 2011-02-25t18:24:31.000z. 28.0 requestedgroup connectapi. information about the group the context user is requesting 28.0 reference to join. responsemessage string a message for the user if their membership request is 28.0 declined. the value of this property is used only when the value of the status property is declined. the maximum length is 756 characters. status connectapi. status of a request to join a private group. values are: 28.0 groupmembership • accepted requeststatus • declined enum • pending url string url of the group membership request object. 28.0 user connectapi.user information about the user requesting membership in a 28.0 summary group. see also: connectapi.groupmembershiprequests connectapi.groupmembershiprequests requests to become group members. 1822apex reference guide connectapi output classes name type description available version requests list<connectapi.group information about group membership requests. 28.0 membershiprequest> total integer the total number of requests. 28.0 connectapi.grouprecord a record associated with a group. property type description available version id string record’s 18-character id. 33.0 record connectapi. information about the record associated with the group. 33.0 actorwithid url string record url. 33.0 see also: connectapi.grouprecordpage connectapi.grouprecordpage a paginated list of connectapi.grouprecord objects. property type description available version currentpageurl string connect rest api url identifying the current page. 33.0 nextpageurl string connect rest api url identifying the next page, or null if 33.0 there isn’t a next page. previous string connect rest api url identifying the previous page, or null 33.0 pageurl if there isn’t a previous page. records list<connectapi. list of records on the current page. 33.0 grouprecord> totalrecord integer total number of records associated with the group. 33.0 count connectapi.hashtagsegment subclass of connectapi.messagesegment. 1823apex reference guide connectapi output classes name type description available version tag string text of the topic without the hash symbol (#). 28.0 topicurl string connect rest api topics resource that searches for the topic: 28.0 /services/data/v58.0/chatter /topics?exactmatch=true&q=topic url string connect rest api feed items resource url that searches for the topic 28.0 in all feed items in an organization: /services/data/v58.0/chatter/feed-items?q=topic connectapi.hidesocialpostintent hide intent for a social post. property name type description available version ishidden boolean specifies whether the managed social account hid 45.0 the social post (true) or not (false). managedsocialaccount connectapi. managed social account that hides the social post. 45.0 managedsocialaccount see also: connectapi.socialpostintents connectapi.holdfocapacityoutputrepresentation response to a request to hold fulfillment order capacity at one or more locations. can correspond to one action call. subclass of connectapi.baseoutputrepresentation. property name type description available version holdfocapacity list<connectapi. list of responses to the requests to hold fulfillment 55.0 responses holdf |
ocapacity order capacity at one or more locations. responseoutput representation> connectapi.holdfocapacityresponseoutputrepresentation response to a request to hold fulfillment order capacity at one or more locations. 1824apex reference guide connectapi output classes property name type description available version capacityresponses list<connectapi. list of responses to the requests to hold fulfillment 55.0 capacityresponse order capacity at individual locations. outputrepresentation> connectapi.icon icon. property type description available version height integer the height of the icon in pixels. 28.0 width integer the width of the icon in pixels. 28.0 url string the url of the icon. this url is available to unauthenticated users. this 28.0 url does not expire. see also: connectapi.canvascapability connectapi.enhancedlinkcapability connectapi.socialpostcapability connectapi.inlineimagesegment an inline image in the feed body. subclass of connectapi.messagesegment property name type description available version alttext string alt text for the inline image. 35.0 contentsize integer size of the file in bytes. 35.0 fileextension string extension of the file, such as gif. 37.0 thumbnails connectapi.file information about the available thumbnails for the 35.0 previewcollection image. url string url to the latest version of the inline image. 35.0 connectapi.interactionscapability if a feed element has this capability, it has information about user interactions. subclass of connectapi.feedelementcapability. 1825apex reference guide connectapi output classes property name type description available version count long the number of individual views, likes, and comments 37.0 on a feed post. note: this count appears in the ui under the feed post as the number of views, for example, “5 views.” see also: connectapi.feedelementcapabilities connectapi.relatedquestion connectapi.invitation an invitation. property name type description available version email string email address of the user. 39.0 status connectapi. specifies the status of an invitation to join a group. 39.0 groupviral values are: 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. • 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. userid string id of the user. 39.0 see also: connectapi.invitations 1826apex reference guide connectapi output classes connectapi.invitations a collection of invitations. property name type description available version invitations list<connectapi. collection of invitations. 39.0 invitation> connectapi.knowledgearticleversion a knowledge article version. property name type description available version articletype string type of the knowledge article. 36.0 id string id of the knowledge article version. 36.0 knowledgearticleid string id of the corresponding knowledge article. 36.0 lastpublisheddate datetime last published date of the knowledge article. 36.0 summary string summary of the knowledge article contents. 36.0 title string title of the knowledge article. 36.0 urlname string url name of the knowledge article. 36.0 see also: connectapi.knowledgearticleversioncollection connectapi.knowledgearticleversioncollection a collection of knowledge article versions. property name type description available version items list<connectapi. a collection of knowledge article versions. 36.0 knowledgearticle version> connectapi.labeledrecordfield this class is abstract. subclass of connectapi.abstractrecordfield. superclass of: • connectapi.compoundrecordfield • connectapi.currencyrecordfield 1827apex reference guide connectapi output classes • connectapi.daterecordfield • connectapi.percentrecordfield • connectapi.picklistrecordfield |
• connectapi.recordfield • connectapi.referencerecordfield • connectapi.referencewithdaterecordfield record field containing a label and a text value. important: the composition of a feed can change between releases. write your code to handle instances of unknown subclasses. name type description available version label string localized string describing the record field. 29.0 text string text value of the record field. all record fields have a text value. to 29.0 ensure that all clients can consume new content, inspect the record field’s type property. if it isn’t recognized, render the text value as the default case. connectapi.lightningextensioninformation lightning extension information. subclass of connectapi.abstractextensioninformation. property name type description available version compositioncomponent string component to use in compose state. 40.0 headertextlabel string label for the extension’s header. 40.0 hovertextlabel string label for hovering over the extension. 40.0 rendercomponent string component to use in render or preview state. 40.0 see also: connectapi.extensiondefinition connectapi.likeintent like intent for a social post. property name type description available version isliked boolean specifies whether the managed social account liked 45.0 the social post (true) or not (false). 1828apex reference guide connectapi output classes property name type description available version managedsocialaccount connectapi. managed social account that likes the social post. 45.0 managedsocialaccount see also: connectapi.likeintents connectapi.likeintents list of like intents for a social post. property name type description available version likes list<connectapi. list of like intents for the social post. 45.0 likeintent> see also: connectapi.socialpostintents connectapi.likesocialpostintent like intent on a social post. property name type description available version socialaccountid string id of the social account that likes the social post. 46.0 socialpostid string id of the social post to like. 46.0 connectapi.likesummary summary of a like. subclass of connectapi.userfeedentityactivitysummary property name type description available version likeid string id of the like. 42.0 connectapi.linkcapability if a feed element has this capability, it has a link. subclass of connectapi.feedelementcapability. 1829apex reference guide connectapi output classes property name type description available version url string link url. the url can be to an external site. 32.0 urlname string description of the link. 32.0 see also: connectapi.feedelementcapabilities connectapi.linkmetadata metadata for a link. property name type description available version description string description of the link. 42.0 framesource string html required to display the resource. 42.0 height integer height required to display the html. 42.0 originalurl string original url that was used to request the metadata. 42.0 providerurl string url of the provider that the information is retrieved 42.0 from. source connectapi. source of the link metadata. values are: 42.0 linkmetadatasource • none—link metadata wasn’t retrieved. • sfdc—salesforce is the source. thumbnailurl string thumbnail of the resource. 42.0 title string title of the link. 42.0 type connectapi. type of link that the metadata represents. values are: 42.0 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. url string url of the image to display, if one is available. 42.0 1830apex reference guide connectapi output classes property name type description available version width integer width required to display the html. 42.0 see also: connectapi.linkmetadatacollection connectapi.linkmetadatacollection collection of link metadata. property name type description available version linkmetadatalist list<connectapi. list of metadata for links. 42.0 |
linkmetadata> connectapi.linksegment link segment. subclass of connectapi.messagesegment. name type description available version url string the link url. 28.0 connectapi.locationoutputrepresentation an inventory location’s distance to an order recipient. property name type description available version distance double the distance from the location to the order recipient. 51.0 locationidentifier string the location identifier. 51.0 connectapi.locationcapacityoutputrepresentation fulfillment order capacity values for a location. property name type description available version assigned integer value of the location’s assigned fulfillment order 55.0 count. capacity integer value of the location’s fulfillment order capacity. 55.0 this property represents the location’s maximum capacity. 1831apex reference guide connectapi output classes property name type description available version error connectapi. error returned by the request, if any. 55.0 errorresponse heldcapacity integer number of fulfillment orders that the location is 55.0 holding capacity for. locationid string id of the location. 55.0 connectapi.maintenanceinfo information about the upcoming scheduled maintenance for the organization. property name type description available version description string description of the maintenance. 34.0 maintenancetitle string title of the maintenance. 34.0 maintenancetype connectapi. type of maintenance. values are: 34.0 maintenancetype • downtime—downtime maintenance. • generallyavailable—maintenance with generally available mode. • maintenancewithdowntime—scheduled maintenance with downtime. • readonly—maintenance with read-only mode. message datetime effective time when users start seeing the 34.0 effectivetime maintenance message. message datetime expiration time of the maintenance message. 34.0 expirationtime scheduledend datetime scheduled end of downtime. null for 34.0 downtime generallyavailable and readonly maintenance types. scheduledend datetime scheduled end of maintenance. null for 34.0 maintenancetime downtime maintenance type. scheduledstart datetime scheduled start of downtime. null for 34.0 downtime generallyavailable and readonly maintenance types. scheduledstart datetime scheduled start time of maintenance. null for 34.0 maintenancetime downtime maintenance type. see also: connectapi.organizationsettings 1832 |
apex reference guide connectapi output classes connectapi.managedcontentassociations content topics associated with managed content. property name type description available version topics list<connectapi. a collection of topics associated with the managed 47.0 topicsummary> content. see also: connectapi.managedcontentversion connectapi.managedcontentchannel managed content channel. property name type description available version cachecontrolmaxage long http cache control max age response header for 55.0 content delivered from the channel. channelid string id of the managed content channel. 48.0 channelname string name of the managed content channel. 48.0 channeltype connectapi. type of managed content channel. values are: 48.0 managedcontent • cloudtocloud channeltype • community • connectedapp • publicunauthenticated domain string id or name of the domain assigned to the channel. 52.0 domainid string id of the domain assigned to the channel. 50.0–51.0 in version 52.0 and later, this information is returned in the domain property. domainname string name of the domain assigned to the channel. 50.0 ischannelsearchable boolean specifies whether the text contents of the channel 48.0 are searchable (true) or not (false). isdomainlocked boolean specifies whether the domain is locked and can’t be 50.0 changed (true) or not (false). 1833apex reference guide connectapi output classes property name type description available version mediacachecontrol long http cache control max age response header for 57.0 maxage media delivered from the channel. see also: connectapi.managedcontentchannelcollection connectapi.managedcontentchannelcollection collection of managed content channels. property name type description available version channels list<connectapi. list of managed content channels. 48.0 managedcontent channel> currentpageurl string connect rest api url identifying the current page. 48.0 nextpageurl string connect rest api url identifying the next page, or 48.0 null if there isn’t a next page. previouspageurl string connect rest api url identifying the previous page, 48.0 or null if there isn’t a previous page. totalchannels integer total number of managed content channels. 48.0 connectapi.managedcontentchanneldetail managed content channel detail. property name type description available version channelid string id of the managed content channel. 54.0 channelname string name of the managed content channel. 54.0 channeltype connectapi. type of managed content channel. values are: 54.0 managedcontent • cloudtocloud channeltype • community • connectedapp • publicunauthenticated domain string domain assigned to the managed content channel. 54.0 domainname string name of the domain assigned to the managed 54.0 content channel. 1834apex reference guide connectapi output classes property name type description available version ischannelsearchable boolean specifies whether the text of the channel's contents 54.0 is searchable (true) or not (false). isdomainlocked boolean specifies whether the channel’s domain is locked and 54.0 can’t be changed (true) or not (false). connectapi.managedcontentchannelsummary managed content channel. property name type description available version domainurl string domain url of the channel. 55.0 name string name of the managed content channel. 54.0 resourceurl string resource url to complete information of the 54.0 channel. target connectapi. target site associated with the channel. 54.0 managedcontent channeltarget summary see also: connectapi.managedcontentdeliverydocument connectapi.managedcontentcollectionitems connectapi.managedcontentdeliverydocumentcollection connectapi.managedcontentchanneltargetsummary target site associated with the channel. property name type description available version id string id of the site associated with the channel. 54.0 see also: connectapi.managedcontentchannelsummary connectapi.managedcontentcollectionitem managed content collection item. 1835apex reference guide connectapi output classes property name type description available version body map<string, object> map of properties of the collection item with their 56.0 values. contenttype connectapi. type of collection item. 56.0 managedcontent collectionitem typesummary id string id of the collection item. 56.0 name string |
name or title for collection item. 56.0 see also: connectapi.managedcontentcollectionitems connectapi.managedcontentcollectionitems managed content collection items. property name type description available version channelinfo connectapi. information about the managed content channel. 56.0 managedcontent channelsummary collectionkey string unique identifier for the collection. 56.0 collectiontype connectapi. type of collection. 56.0 managedcontent typesummary id string id of the collection. 56.0 items list<connectapi. list of collection items. 56.0 managedcontent collectionitem> language string language locale of the collection. 56.0 publisheddate datetime most recent publish date of the collection. 56.0 title string title of the collection. 56.0 total integer total number of items in the current collection detail 56.0 page. urlname string url name of the collection. 56.0 connectapi.managedcontentcollectionitemtypesummary summary of a collection item type. 1836apex reference guide connectapi output classes property name type description available version fullyqualifiedname string fully qualified name of the collection item type. 56.0 name string name of the collection item type. 56.0 see also: connectapi.managedcontentcollectionitem connectapi.managedcontentdateandtimenodevalue managed content node of date and time type. subclass of connectapi.managedcontentnodevalue property name type description available version datetimevalue datetime utc date and time value of the managed content 48.0 node. timezone string time zone in which the date and time is authored. 48.0 connectapi.managedcontentdatenodevalue managed content node of date type. subclass of connectapi.managedcontentnodevalue property name type description available version value datetime date value of the managed content node. 48.0 connectapi.managedcontentdeliverydocument managed content in delivery scope. subclass of connectapi.abstractmanagedcontentdeliverydocument in version 55.0 and later. properties with an available version of 54.0 only are included in connectapi.abstractmanagedcontentdeliverydocument in version 55.0 and later. property name type description available version channelinfo connectapi. information about the managed content channel. 54.0 managedcontent channelsummary contentbody map<string, object> map of properties of the managed content with their 54.0 values. contentkey string globally unique identifier (guid) for the managed 54.0 only content. 1837apex reference guide connectapi output classes property name type description available version contenttype connectapi. type of managed content. 54.0 only managedcontent typesummary language string language locale of the managed content. 54.0 only managedcontentid string id of the managed content. 54.0 only publisheddate datetime most recent publish date of the managed content. 54.0 only references map<string, map of references with contentkey as the key. 54.0 connectapi. abstractmanaged contentreference> referenceslist list<connectapi. list of references. 54.0 abstractmanaged contentreference> title string title of the managed content. 54.0 only unauthenticatedurl string public url for the managed content. 54.0 only urlname string url name of the managed content. 54.0 only see also: connectapi.managedcontentdeliverydocumentcollection connectapi.managedcontentdeliverydocumentcollection managed content delivery document collection. property name type description available version channelinfo connectapi. information about the managed content channel. 55.0 managedcontent channelsummary contents list<connectapi. list of managed content delivery documents. 55.0 abstractmanaged contentdelivery document> currentpageurl string url to the current page of managed content records. 55.0 nextpageurl string url to the next page of managed content records. 55.0 previouspageurl string url to the previous page of managed content 55.0 records. references map<string, map of references with contentkey as the key. 55.0 connectapi. 1838apex reference guide connectapi output classes property name type description available version abstractmanaged contentreference> referenceslist list<connectapi. list of references. 55.0 abstractmanaged contentreference> connectapi.managedcontentdeliverydocumentsummary managed content delivery document summary. subclass |
of connectapi.abstractmanagedcontentdeliverydocument no additional properties. connectapi.managedcontentmedianodevalue managed content node of media type. subclass of connectapi.managedcontentnodevalue property name type description available version alttext string alternative text for the managed content node. 47.0 alturl string alternative url to the managed content node. 47.0–48.0 in version 49.0 and later, this information is returned in the thumbnailurl property. contentkey string content key of the managed content. 51.0 filename string file name of the managed content node. 48.0 mediatype connectapi. type of managed content media. value is image. 47.0 managedcontent mediatype mimetype string mime type of the managed content node. 47.0 resourceurl string resource url to the image. 48.0 in version 48.0, the resource url is available if referencing asset files and is null if referencing media. in version 49.0 and later, the resource url is available if referencing asset files or media. thumbnailurl string url to the thumbnail of the media. 49.0 title string title of the managed content node. 47.0 unauthenticatedurl string unauthenticated url to the image or null if the 48.0 image isn’t visible to external users. 1839apex reference guide connectapi output classes property name type description available version url string url to the image. 47.0 connectapi.managedcontentmediasourcenodevalue source of managed content media. property name type description available version filename string file name of the media source. 49.0 isexternal boolean specifies whether the media source is referenced via 49.0 an external url (true) or uploaded (false). mediatype connectapi. type of managed content media. values are: 49.0 managedcontent • document mediatype • image mimetype string mime type of the media source. 49.0 referenceid string reference id of the uploaded media source. 49.0 resourceurl string resource url of the media source. 49.0 unauthenticatedurl string url to the media source for unauthenticated users, 49.0 or null if the media source isn’t available to external users. url string url to the media source for authenticated users. 49.0 connectapi.managedcontentnodetype managed content node type. property name type description available version label string label of the managed content node type. 47.0 name string developer name of the managed content node type. 47.0 1840apex reference guide connectapi output classes property name type description available version nodetype connectapi. type of managed content node. values are: 47.0 managedcontent • date nodetypeenum • datetime • media • mediasource • multilinetext • namefield • richtext • text • url see also: connectapi.managedcontenttype connectapi.managedcontentnodevalue managed content node. this class is abstract. superclass of: • connectapi.managedcontentdateandtimenodevalue • connectapi.managedcontentdatenodevalue • connectapi.managedcontentmedianodevalue • connectapi.managedcontentmediasourcenodevalue • connectapi.managedcontenttextnodevalue 1841apex reference guide connectapi output classes property name type description available version nodetype connectapi. type of managed content node. values are: 47.0 managedcontent • date nodetype • datetime • media • mediasource • multilinetext • namefield • richtext • text • url see also: connectapi.managedcontentversion connectapi.managedcontentreference managed content reference. subclass of connectapi.abstractmanagedcontentreference property name type description available version contentbody map<string, object> map of properties of the managed content reference 54.0 with their values. title string title of the managed content reference. 54.0 see also: connectapi.managedcontentreferencesummary connectapi.managedcontentreferencesummary summary of the managed content reference. subclass of connectapi.abstractmanagedcontentreference property name type description available version title string title of the managed content reference. 54.0 connectapi.managedcontentspace managed content space. 1842apex reference guide connecta |
pi output classes property name type description available version createdby string id of the user who created the managed content 55.0 space. createddate datetime date when the managed content space was created. 55.0 defaultlanguage string default language of the managed content space. 55.0 description string description of the managed content space. 55.0 id string id of the managed content space. 55.0 lastmodifiedby string id of the user who last modified the managed 55.0 content space. lastmodifieddate datetime date when the managed content space was last 55.0 modified. name string name of the managed content space. 55.0 rootfolderid string id of the root folder of the managed content space. 55.0 connectapi.managedcontenttextnodevalue managed content node of text type. subclass of connectapi.managedcontentnodevalue property name type description available version value string text value of the managed content node. 47.0 connectapi.managedcontenttype managed content type. property name type description available version label string label of the managed content type. 47.0 name string developer name of the managed content type. 47.0 nodetypes map<string, map of node types for the managed content type. 47.0 connectapi. managedcontent nodetype> see also: connectapi.managedcontentversioncollection 1843apex reference guide connectapi output classes connectapi.managedcontenttypesummary managed content type. property name type description available version fullyqualified string fully qualified name of the managed content type. 54.0 name name string reserved for future use. 55.0 see also: connectapi.managedcontentdeliverydocument connectapi.managedcontentcollectionitems connectapi.managedcontentversion managed content version. property name type description available version associations connectapi. content topics associated with the managed content. 47.0 managedcontent associations contentkey string content key of the managed content. 51.0 contentnodes map<string, map of content nodes. 47.0 connectapi. managedcontent nodevalue> contenturlname string content url name of the managed content version. 48.0 language string language of the managed content version. 48.0 managedcontentid string id of the managed content. 47.0 publisheddate datetime date when the managed content version was last 47.0 published. title string title of the managed content version. 47.0 type string type of managed content version. 47.0 typelabel string type label of the managed content type. 47.0 unauthenticatedurl string unauthenticated delivery url. 50.0 see also: connectapi.managedcontentversioncollection 1844apex reference guide connectapi output classes connectapi.managedcontentversioncollection collection of managed content versions. property name type description available version currentpageurl string connect rest api url identifying the current page. 47.0 items list<connectapi. list of managed content versions. 47.0 managedcontent version> managedcontent map<string, map of managed content types. 47.0 types connectapi. managedcontenttype> nextpageurl string connect rest api url identifying the next page, or 47.0 null if there isn’t a next page. total integer total number of managed content versions. 47.0 totaltypes integer total number of managed content types. 47.0 connectapi.managedsocialaccount information describing a managed social account or fan page of a social network. subclass of connectapi.basemanagedsocialaccount no additional properties. connectapi.managedsocialaccounts a list of managed social accounts. property name type description available version managedsocial list<connectapi. list of managed social accounts. 44.0 accounts managedsocialaccount> connectapi.managedtopic represents a managed topic in an experience cloud site. property name type description available version children list<connectapi. children managed topics of the managed topic; 35.0 managedtopic> null if the depth request parameter isn’t specified or is 1. id string id of managed topic. 32.0 1845apex reference guide connectapi output classes property name type description available version managedtopictype connectapi.managed type of managed topic. 32.0 topictype • 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. parent connectapi. parent managed topic of the managed topic. 35.0 reference topic connectapi.topic information about the topic. 32.0 url string connect rest api url to the managed topic. 32.0 see also: connectapi.managedtopiccollection connectapi.managedtopiccollection a collection of managed topics. property name type description available version currentpageurl string connect rest api url identifying the current page. 32.0 managedtopics list<connectapi. list of managed topics. 32.0 managedtopic> nextpageurl string connect rest api url identifying the next page, or 44.0 null if there isn’t a next page. connectapi.markupbeginsegment the beginning of rich text markup. subclass of connectapi.messagesegment property name type description available version alttext string alternative text for the segment, if available. 45.0 htmltag string the html tag for this markup. 35.0 markuptype connectapi. type of rich text markup. 35.0 markuptype • bold—bold tag. • code—code tag. 1846apex reference guide connectapi output classes property name type description available version • hyperlink—hyperlink anchor tag. • italic—italic tag. • listitem—list item tag. • orderedlist—ordered list tag. • paragraph—paragraph tag. • strikethrough—strikethrough tag. • underline—underline tag. • unorderedlist—unordered list tag. url string url to the segment, if available. 45.0 connectapi.markupendsegment the end of rich text markup. subclass of connectapi.messagesegment property name type description available version htmltag string the html tag for this markup. 35.0 markuptype connectapi. type of rich text markup. 35.0 markuptype • 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—strikethrough tag. • underline—underline tag. • unorderedlist—unordered list tag. connectapi.mediareference a media reference. property name type description available version mediaurl string url to stream or download the media. 41.0 1847apex reference guide connectapi output classes property name type description available version thumbnailurl string if one exists, url of the media’s thumbnail. 41.0 see also: connectapi.feedelementcapabilities connectapi.mediareferencecapability connectapi.mediareferencecapability if a feed element has this capability, it has one or more media references. subclass of connectapi.feedelementcapability. property name type description available version media list<connectapi. collection of media references. 41.0 mediareference> connectapi.mentioncompletion information about a record that could be used to @mention a user or group. name type description available version additionallabel string if one exists, an additional label for the record represented by this 29.0 completion, for example, “(customer)” or “(acme corporation)”. description string a description of the record represented by this completion. 29.0 name string the name of the record represented by this completion. the name 29.0 is localized, if possible. outofoffice connectapi. if the record represented by this completion is a user, an additional 40.0 outofoffice out-of-office message, if one exists, for the user. photourl string a url to the photo or icon of the record represented by this 29.0 completion. recordid string the id of the record represented by this completion. 29.0 1848apex reference guide connectapi output classes name type description available version usertype connectapi. if the record represented by this completion is a user, this value is 30.0 usertype the user type associated with that user; otherwise the value is null. enum one of these values: • 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.mentioncompletionpage connectapi.mentioncompletionpage paginated list of mention completion response bodies. name type description available version currentpageurl string connect rest api url identifying the current page. 29.0 mentioncompletions list<connectapi. a list of mention completion proposals. use these proposals 29.0 mentioncompletion> to build a feed post body. nextpageurl string connect rest api url identifying the next page, or null 29.0 if there isn’t a next page. previouspageurl string connect rest api url identifying the previous page, or 29.0 null if there isn’t a previous page. connectapi.mentionsegment mention segment. subclass of connectapi.messagesegment. name type description available version accessible boolean specifies whether the mentioned user or group can see 28.0 the post in which they are mentioned (true) or not (false). name string name of the mentioned user or group. 28.0 1849apex reference guide connectapi output classes name type description available version record connectapi. information about the mentioned user or group. 29.0 actorwithid user connectapi.user information about the mentioned user. 28.0 only summary important: in versions 29.0 and later, use the in versions before record property. 29.0, if the mention is not a user, the mention is in a connectapi.textsegment object. connectapi.mentionvalidation information about whether a proposed mention is valid for the context user. name type description available version recordid string the id of the mentioned record. 29.0 validationstatus connectapi. type of validation error for a proposed mention, if any. 29.0 mentionvalidation • disallowed—the proposed mention is invalid status enum 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. see also: connectapi.mentionvalidations connectapi.mentionvalidations information about whether a set of mentions is valid for the context user. name type description available version haserrors boolean indicates whether at least one of the proposed 29.0 mentions has an error (true), or not (false). for example, context users can’t mention private groups 1850apex reference guide connectapi output classes name type description available version they don’t belong to. if such a group is included in the list of mention validations, haserrors is true and the group has a validationstatus of disallowed in its mention validation. mentionvalidations list<connectapi. list of mention validation information in the same 29.0 mentionvalidation> order as the provided record ids. connectapi.messagebody message body. subclass of connectapi.abstractmessagebody no additional properties. see also: connectapi.chatterlikescapability connectapi.chattermessage connectapi.comment connectapi.feedelement connectapi.feeditemsummary connectapi.messagesegment message segment. this class is abstract. superclass of: • connectapi.complexsegment • connectapi.entitylinksegment • connectapi.fieldchangesegment • connectapi.fieldchangenamesegment • connectapi.fieldchangevaluesegment • connectapi.hashtagsegment • connectapi.inlineimagesegment • connectapi.linksegment • connectapi.markupbeginsegment • connectapi.markupendsegment • connectapi.mentionsegment • connectapi. |
morechangessegment • connectapi.resourcelinksegment • connectapi.textsegment 1851apex reference guide connectapi output classes 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. name type description available version text string text-only rendition of this segment. if a client encounters an 28.0 unknown message segment type, it can render this value. type connectapi. the message segment type. one of these values: 28.0 messagesegment • entitylink type enum • fieldchange • fieldchangename • fieldchangevalue • hashtag • inlineimage • link • markupbegin • markupend • mention • morechanges • resourcelink • text see also: connectapi.abstractmessagebody connectapi.moderationcapability if a feed element has this capability, users in an experience cloud site can flag it for moderation. subclass of connectapi.feedelementcapability. property name type description available version moderationflags connectapi. the moderation flags for this feed element. 31.0 moderationflags moderators can view and take action on flagged items. see also: connectapi.feedelementcapabilities 1852apex reference guide connectapi output classes connectapi.moderationflagitemdetail flag details on a feed item, comment, or file. property name type description available version createdby string id of the user who flagged the item. 40.0 createddate datetime date when the item was flagged. 40.0 id string id of the moderation flag. 40.0 moderationtype connectapi. type of moderation flag. values are: 40.0 communityflagtype • flagasinappropriate—flag for inappropriate content. • flagasspam—flag for spam. note string note from user who flagged the item. 40.0 visibility connectapi. visibility behavior of a flag for various user types. 40.0 communityflag values are: visibility • 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. see also: connectapi.moderationflagscollection connectapi.moderationflags information about the moderation flags on a feed item, comment, or file. name type description available version flagcount integer number of moderation flags on this feed item, comment, or file. if 29.0 the context user is not a moderator, the property is null. flagcount map<connectapi. number of moderation flags categorized by reason. values for 40.0 byreason communityflag connectapi.communityflagreasontype are: reasontype, • flaggedbyrule—moderation rule flagged the item. integer> • flaggedbysystem—einstein flagged the item. • flaggedbyuserasinappropriate—user flagged the item as inappropriate. • flaggedbyuserasspam—user flagged the item as spam. 1853apex reference guide connectapi output classes name type description available version flaggedbyme boolean true if the context user flagged the feed item, comment, or file 29.0 for moderation; false otherwise. flags connectapi. collection of flags. 40.0 moderationflags collection see also: connectapi.comment connectapi.file connectapi.moderationcapability connectapi.moderationflagscollection a collection of flags on a feed item, comment, or file. 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 flags list<connectapi. list of flag details. 40.0 moderationflag itemdetail> 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. pagesize integer number of items per page. 40.0 see also: connectapi.moderationflags connectapi.morechangessegment in feed items with a large number of tracked changes, the message is formatted as: “changed a, b, and made x more changes.” the morechangessegment contains the “x more changes.” subclass of connectapi.messagesegment. 1854apex reference guide connectapi output classes name type description available version morechanges list<connectapi. complete list of tracked changes. 29.0 fieldchange segment> morechangescount integer number of additional changes. 28.0 connectapi.motif the motif properties contain urls for small, medium, and large icons that indicate the salesforce record type. common record types are files, users, and groups, but all record types have a set of motif icons. custom object records use their tab style icon. all icons are available to unauthenticated users so that, for example, you can display the motif icons in an email. the motif can also contain the record type’s base color. the motif images are icons, not user uploaded images or photos. for example, every user has the same set of motif icons. custom object records use their tab style icon, for example, the following custom object uses the “boat” tab style: "motif": { "color: "8c004c", "largeiconurl": "/img/icon/custom51_100/boat64.png", "mediumiconurl": "/img/icon/custom51_100/boat32.png", "smalliconurl": "/img/icon/custom51_100/boat16.png", "svgiconurl": null }, users use the following icons: "motif": { "color: "1797c0", "largeiconurl": "/img/icon/profile64.png", "mediumiconurl": "/img/icon/profile32.png", "smalliconurl": "/img/icon/profile16.png", "svgiconurl": null }, groups use the following icons: "motif": { "color: "1797c0", "largeiconurl": "/img/icon/groups64.png", "mediumiconurl": "/img/icon/groups32.png", "smalliconurl": "/img/icon/groups16.png", "svgiconurl": null }, files use the following icons: "motif": { "color: "1797c0", "largeiconurl": "/img/content/content64.png", "mediumiconurl": "/img/content/content32.png", "smalliconurl": "/img/icon/files16.png", "svgiconurl": null }, 1855apex reference guide connectapi output classes note: to view the icons in the previous examples, preface the url with https://instance_name. for example, https://instance_name/img/icon/profile64.png. name type description available version color string a hex value representing the base color of the record type, or null. 29.0 largeiconurl string a large icon indicating the record type. 28.0 mediumiconurl string a medium icon indicating the record type. 28.0 smalliconurl string a small icon indicating the record type. 28.0 svgiconurl string an icon in svg format indicating the record type, or null if the icon 34.0 doesn’t exist. connectapi.multipleasyncoutputrepresentation ids of the asynchronous background operations. this output only includes the operation ids, regardless of whether calls are made to an external payment gateway. it doesn’t include any errors from the operations. subclass of connectapi.baseoutputrepresentation. property name type description available version asyncoutputs list<connectapi. list of ids of background operations. 56.0 asyncoutput representation> see also: multipleensurefundsasync(multipleensurefundsinput) connectapi.multiplefulfillmentorderinvoicesoutputrepresentation ids of the created invoices. subclass of connectapi.baseoutputrepresentation. property name type description available version invoiceids list<string> list of ids of the |
created invoices. 52.0 connectapi.multiplefulfillmentorderoutputrepresentation list of responses for the individual fulfillmentorder creation attempts from a create multiple fulfillment orders request. subclass of connectapi.baseoutputrepresentation. 1856apex reference guide connectapi output classes property name type description available version fulfillmentorders list<connectapi. a list of response data for created and failed 50.0 fulfillmentgroup fulfillmentorders. outputrepresentation> connectapi.mutecapability if a feed element has this capability, users can mute it. muted feed elements are visible in the muted feed, and invisible in all other feeds that respect mute. subclass of connectapi.feedelementcapability. property name type description available version ismutedbyme boolean indicates whether the context user muted the feed 35.0 element. see also: connectapi.feedelementcapabilities connectapi.mutesummary summary of a mute. subclass of connectapi.userfeedentityactivitysummary no additional properties. connectapi.namedcredential named credential associated with an external credential. 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 calloutoptions connectapi. callout options for the named credential. 58.0 namedcredential calloutoptions callouturl string url of the named credential in a callout. 58.0 customheaders list<connectapi. custom http headers for the named credential. 58.0 credentialcustom header> developername string fully qualified developer name of the named 56.0 credential. 1857apex reference guide connectapi output classes property name type description available version externalcredentials list<connectapi. external credentials used by the named credential. 58.0 externalcredential> id string named credential id. 58.0 masterlabel string named credential label. 56.0 networkconnection connectapi. privateconnect outbound network connection for 58.0 networkconnection the named credential. parameters list<connectapi. named credential parameters. 58.0 namedcredential parameter> type connectapi. type of named credential. values are: 58.0 namedcredentialtype • privateendpoint • securedendpoint url string connect rest api url of the named credential. 58.0 see also: connectapi.externalcredential connectapi.namedcredentiallist connectapi.namedcredentialcalloutoptions named credential callout options. property name type description available version allowmergefields boolean specifies whether to allow merge fields in the http 58.0 inbody body (true) or not (false). allowmergefields boolean specifies whether to allow merge fields in the http 58.0 inheader header (true) or not (false). generate boolean specifies whether to generate an authorization 58.0 authorizationheader header (true) or not (false). see also: connectapi.namedcredential connectapi.namedcredentiallist list of named credentials. 1858apex reference guide connectapi output classes property name type description available version namedcredentials list<connectapi. list of named credentials. 58.0 namedcredential> connectapi.namedcredentialparameter named credential parameter. property name type description available version id string id of the parameter. 58.0 parametername string name of the parameter. 58.0 parametertype connectapi. type of named credential parameter. values are: 58.0 namedcredential • allowedmanagedpackagenamespaces parametertype • clientcertificate parametervalue string value of the parameter. 58.0 see also: connectapi.namedcredential connectapi.navigationmenuitem navigation menu item. property name type description available version actiontype connectapi. event, url type, or modal navigation menu item. 52.0 navigationmenuitem values are: actiontype • event—event-based navigation. note: event is internal only and can’t be used in custom components. • externallink—url outside of your experience cloud site. • internallink—relative url inside your experience cloud site. |
• modal—modal, such as account switcher. actionvalue string for event action type, the event fully qualified 52.0 name for the navigation menu item. for externallink and internallink action types, the route url for the navigation menu item. 1859apex reference guide connectapi output classes property name type description available version for modal action type, the component fully qualified name for the navigation menu item. imageurl string url to the image of the navigation menu item. 52.0 label string label for the navigation menu item. 52.0 submenu list<connectapi. submenu for the navigation menu item. 52.0 navigationmenuitem> target connectapi. target for the navigation menu item. values are: 52.0 navigationmenuitem • currentwindow—navigation menu item opentarget opens in the current window. • newwindow—navigation menu item opens in a new window. see also: connectapi.navigationmenuitemcollection connectapi.navigationmenuitemcollection collection of navigation menu items. property name type description available version menuitems list<connectapi. collection of navigation menu items. 52.0 navigationmenuitem> connectapi.nbaactionparameter a parameter for an action. property name type description available version name string name of the parameter. 45.0 type string type of the parameter. 45.0 value string value of the parameter. 45.0 connectapi.nbaflowaction a recommended flow. subclass of connectapi.abstractnbaaction. 1860apex reference guide connectapi output classes property name type description available version flowlabel string label of the recommended flow. 47.0 flowtype connectapi. type of recommended flow. values are: 47.0 nbaflowtype • autolaunchedflow—autolaunched flow that runs in the background. • flow—screen flow that accepts user inputs. id string id of the flow. 45.0 name string name of the flow. 45.0 connectapi.nbanativerecommendation a record the user is recommended to take action on. subclass of connectapi.abstractnbatarget. property name type description available version id string id of the recommendation. 45.0 name string name of the recommendation. 45.0 url string url to the recommendation. 45.0 connectapi.nbarecommendation a recommendation returned by a recommendation strategy. property name type description available version aimodel string reserved for future use. 47.0 acceptancelabel string text indicating user acceptance of the 45.0 recommendation. 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. imageurl string url to the asset file to display. 45.0 recommendation string reserved for future use. 46.0 mode recommendation double reserved for future use. 46.0 score rejectionlabel string text indicating user rejection of the recommendation. 45.0 1861apex reference guide connectapi output classes property name type description available version target connectapi. target to act on. 45.0 abstractnbatarget targetaction connectapi. action to recommend. 45.0 abstractnbaaction see also: connectapi.nbarecommendations connectapi.nbarecommendations recommendations returned by a recommendation strategy. property name type description available version debug string runtime debug information recorded during 45.0 recommendation strategy execution. errors string runtime errors that occurred during recommendation 45.0 strategy execution. executionid string id of the recommendation strategy execution. 45.0 onbehalfofid string id of the user or entity for which the 45.0 recommendation strategy was executed. recommendations list<connectapi. list of recommendations returned by a 45.0 nbarecommendation> recommendation strategy. trace connectapi. trace information for the recommendation strategy 45.0 strategytrace execution, if requested. connectapi.networkconnection external network connection. 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 developername string name of the network connection. 58.0 id string id of the network connection. 58.0 |
masterlabel string label of the network connection. 58.0 1862apex reference guide connectapi output classes property name type description available version namespaceprefix string namespace prefix of the network connection. 58.0 see also: connectapi.namedcredential connectapi.newuseraudiencecriteria criteria for the new members type of custom recommendation audience. subclass of connectapi.audiencecriteria. property name type description available version maxdaysincommunity double the maximum number of days since a user became 36.0 a site member. connectapi.oauthcredentialauthurl oauth authentication url for a credential. property name type description available version authenticationurl string authentication url for the user external credential. 56.0 authentication urls have encoded and escaped special characters. before using the url, undo the encoded and escaped characters. external string fully qualified developer name of the external 56.0 credential credential. principalname string name of the external credential named principal. 56.0 principaltype connectapi. type of credential principal. values are: 56.0 credentialprincipal • awsstsprincipal type • namedprincipal • peruserprincipal connectapi.oauthproviderinfo name type description available version authorizationurl string the url used for authorization. 37.0 1863apex reference guide connectapi output classes name type description available version name string the name of the oauth service provider. 37.0 see also: connectapi.useroauthinfo connectapi.ocibaseoutputrepresentation base omnichannel inventory output class. this class is abstract. superclass of: • connectapi.ocigetinventoryavailabilityoutputrepresentation • connectapi.ocipublishlocationstructureoutputrepresentation • connectapi.ocipublishlocationstructurestatusoutputrepresentation • connectapi.ociuploadinventoryavailabilityoutputrepresentation • connectapi.ociuploadinventoryavailabilitystatusoutputrepresentation property name type description available version errors list<connectapi. any errors that were returned. 51.0 errorresponse> success boolean indicates whether the request was successful. 51.0 connectapi.ocicreatereservationerroroutputrepresentation error returned from an attempt to create an omnichannel inventory reservation. property name type description available version errorcode string the error code. 51.0 message string details of the error, if available. 51.0 connectapi.ocicreatereservationoutputrepresentation result of an omnichannel inventory reservation creation request. property name type description available version details list<connectapi. details for each product in the reservation. 51.0 ocicreatereservation singleoutputrepresentation> 1864apex reference guide connectapi output classes property name type description available version errors list<connectapi. any errors returned by the reservation request. 51.0 ocicreatereservation erroroutputrepresentation> expirationtime string the time at which the reservation would expire. 51.0 reservationtime string the time when the reservation was recorded. 51.0 success boolean indicates whether the reservation was successfully 51.0 created. connectapi.ocicreatereservationsingleoutputrepresentation details of an inventory reservation for one product. property name type description available version errorcode string the error code, if any. 51.0 locationgroupidentifier string identifier of the location group where the inventory 51.0 is reserved. locationidentifier string identifier of the location where the inventory is 51.0 reserved. quantity double the reserved quantity of the product. 51.0 stockkeepingunit string the sku of the reserved product. 51.0 connectapi.ocifulfillreservationerroroutputrepresentation response to a request to fulfill one inventory reservation. property name type description available version details connectapi. details of the fulfilled reservation, if successful. 51.0 ocifulfillreservation singleoutputrepresentation errorcode string error code, if any. 51.0 message string details of the error, if available. 51.0 connectapi.ocifulfillreservationoutputrepresentation response to a request to fulfill one or more inventory reservations. 1865apex reference guide connectapi output classes property name type description available version errors list<connectapi. responses for the individual reservations in the 51.0 ocifulfillreservation fulfillment request. erroroutputrepresent |
ation> success boolean indicates whether the request was successful. 51.0 connectapi.ocifulfillreservationsingleoutputrepresentation details of a single fulfilled reservation. property name type description available version actionrequestid string the uuid that identifies the original fulfill reservation 51.0 request. externalrefid string the external reference id of the location that fulfilled 51.0 the reservation. locationidentifier string the identifier of the location that fulfilled the 51.0 reservation. quantity double the fulfilled quantity. 51.0 stockkeepingunit string the sku of the fulfilled product. 51.0 connectapi.ocifutureinventoryoutputrepresentation an expected future inventory restock. property name type description available version expecteddate datetime date when the future inventory is expected. 51.0 quantity double quantity of the future inventory. 51.0 connectapi.ocigetinventoryavailabilityoutputrepresentation response to a request for inventory availability data. subclass of connectapi.ocibaseoutputrepresentation. property name type description available version locationgroups list<connectapi. a list of inventory availability data for individual 51.0 ocilocationgroup location groups. availabilityoutputrepresentation> 1866apex reference guide connectapi output classes property name type description available version locations list<connectapi. a list of inventory availability data for individual 51.0 ocilocationavailability locations. outputrepresentation> see also: getinventoryavailability(inventoryavailabilityinputrepresentation) findrouteswithfewestsplitsusingoci(findrouteswithfewestsplitsusingociinput) connectapi.findrouteswithfewestsplitsusingocioutputrepresentation connectapi.ociinventoryrecordoutputrepresentation inventory availability data for a product. property name type description available version availabletofulfill double the available to fulfill quantity. 51.0 availabletoorder double the available to order quantity. 51.0 effectivedate datetime the effective date of the inventory. 51.0 futures list<connectapi. a list of any expected future inventory restocks. 51.0 ocifutureinventory outputrepresentation> onhand double the on hand quantity. 51.0 reserved double the reserved quantity. 51.0 safetystockcount double the safety stock count. 51.0 stockkeepingunit string the sku of the product. 51.0 connectapi.ocilocationavailabilityoutputrepresentation a set of inventory availability data for one inventory location. property name type description available version inventoryrecords list<connectapi. a list of availability data for individual products at this 51.0 ociinventoryrecord location. outputrepresentation> locationidentifier string the identifier of the location. 51.0 connectapi.ocilocationgroupavailabilityoutputrepresentation a set of inventory availability data for one inventory location group. 1867apex reference guide connectapi output classes property name type description available version inventoryrecords list<connectapi. a list of availability data for individual products. the 51.0 ociinventoryrecord data combines the quantities for all locations outputrepresentation> belonging to this location group. locationgroup string the identifier of the location group. 51.0 identifier connectapi.ocipublishlocationstructureoutputrepresentation response to a publish location structure request. subclass of connectapi.ocibaseoutputrepresentation. property name type description available version uploadid string identifier of the publish job. use this value to retrieve 51.0 the status of the job. connectapi.ocipublishlocationstructurestatusoutputrepresentation detailed status of a publish location structure job. subclass of connectapi.ocibaseoutputrepresentation. property name type description available version endtimeutc string the utc time when the job finished. (for example: 51.0 "2020-07-06t22:54:08.012z") recordsprocessedcount integer the number of records processed by the job. 51.0 recordsreadcount integer the number of records read by the job. 51.0 recordsskippedcount integer the number of records skipped by the job. 51.0 starttimeutc string the utc time when the job started. (for example: 51.0 "2020-07-06t22:53:06.788z") status string 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.ocireleasereservationerroroutputrepresentation response to a request to release one inventory reservation. 1868apex reference guide connectapi output classes property name type description available version details connectapi. details of the released reservation, if successful. 51.0 ocireleasereservation singleoutputrepresentation errorcode string error code, if any. 51.0 message string details of the error, if available. 51.0 connectapi.ocireleasereservationoutputrepresentation response to a request to release one or more inventory reservations. property name type description available version errors list<connectapi. responses for the individual reservations in the 51.0 ocireleasereservation release request. erroroutputrepresentation> success boolean indicates whether the request was successful. 51.0 connectapi.ocireleasereservationsingleoutputrepresentation details of a single released reservation. property name type description available version actionrequestid string the uuid that identifies the original release 51.0 reservation request. externalrefid string the external reference id of the location that released 51.0 the reservation. locationgroupidentifier string the identifier of the location group that released the 51.0 reservation. locationidentifier string the identifier of the location that released the 51.0 reservation. quantity double the released quantity. 51.0 stockkeepingunit string the sku of the released product. 51.0 connectapi.ocitransferreservationerroroutputrepresentation response to a request to fulfill one inventory reservation. 1869apex reference guide connectapi output classes property name type description available version details connectapi. details of the transferred reservation, if successful. 51.0 ocitransferreservation singleoutputrepresentation errorcode string error code, if any. 51.0 message string details of the error, if available. 51.0 connectapi.ocitransferreservationoutputrepresentation response to a request to transfer one or more inventory reservations. property name type description available version errors list<connectapi. responses for the individual reservations in the 51.0 ocitransferreservation transfer request. erroroutputrepresentation> success boolean indicates whether the request was successful. 51.0 connectapi.ocitransferreservationsingleoutputrepresentation details of a single transferred reservation. property name type description available version actionrequestid string the uuid that identifies the original transfer 51.0 reservation request. externalrefid string the external reference id of the location that received 51.0 the reservation. fromlocationgroupidentifier string the identifier of the location group that sent the 51.0 reservation. fromlocationidentifier string the identifier of the location that sent the reservation. 51.0 ignoreavailabilitycheck boolean whether this call ignored availability data at the 52.0 location that received the reservation. quantity double the quantity of transferred inventory. 51.0 stockkeepingunit string the sku of the transferred product. 51.0 tolocationgroupidentifier string the identifier of the location group that received the 51.0 reservation. tolocationidentifier string the identifier of the location that received the 51.0 reservation. 1870apex reference guide connectapi output classes connectapi.ociuploadinventoryavailabilityoutputrepresentation response to an upload inventory availability job. subclass of connectapi.ocibaseoutputrepresentation. property name type description available version uploadid string identifier of the upload job. use this value to retrieve 51.0 the status of the job. connectapi.ociuploadinventoryavailabilitystatusoutputrepresentation detailed status of an upload inventory availability job. subclass of connectapi.ocibaseoutputrepresentation. property name type description available version endtimeutc string the utc time when the job finished. (for example: 51.0 "2020-07-06t22:54:08.012z") recordsprocessedcount integer the number of records processed by the job. 51.0 recordsreadcount integer the number of records read by the job. 51.0 recordsskippedcount integer the number of records skipped by the job. 51.0 starttimeutc string the utc time when the job started. (for example: 51.0 "2020-07-06t22:53:06.788z") status string |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.