Title: | An Implementation of 'Salesforce' APIs Using Tidy Principles |
---|---|
Description: | Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, Bulk 1.0, Bulk 2.0, Metadata, Reports and Dashboards) <https://trailhead.salesforce.com/content/learn/modules/api_basics/api_basics_overview>. "API" is an acronym for "application programming interface". Most all calls from these APIs are supported as they use CSV, XML or JSON data that can be parsed into R data structures. For more details please see the 'Salesforce' API documentation and this package's website <https://stevenmmortimer.github.io/salesforcer/> for more information, documentation, and examples. |
Authors: | Steven M. Mortimer [aut, cre], Takekatsu Hiramura [ctb], Jennifer Bryan [ctb, cph], Joanna Zhao [ctb, cph] |
Maintainer: | Steven M. Mortimer <[email protected]> |
License: | MIT + file LICENSE |
Version: | 1.0.2 |
Built: | 2024-11-07 13:49:38 UTC |
Source: | CRAN |
This function looks for instances of elements in a list that have the same name
and then combine them all into a single comma separated character string
(referenceTo) or tbl_df
(picklistValues).
collapse_list_with_dupe_names(x)
collapse_list_with_dupe_names(x)
x |
list; a list, typically returned from the API that we would parse through |
A list
containing one row per field for the requested object.
The tibble only contains the fields that the user can view, as defined by the user's field-level security settings.
## Not run: obj_dat <- sf_describe_objects(object_names = "Contact", api_type = "SOAP")[[1]] obj_fields_list <- obj_dat[names(obj_dat) == "fields"] %>% map(collapse_list_with_dupe_names) ## End(Not run)
## Not run: obj_dat <- sf_describe_objects(object_names = "Contact", api_type = "SOAP")[[1]] obj_fields_list <- obj_dat[names(obj_dat) == "fields"] %>% map(collapse_list_with_dupe_names) ## End(Not run)
A function to create a variety of objects that are part of the Metadata API service Below is a list of objects and their required components to be created with this function:
metadata_type_validator(obj_type, obj_data)
metadata_type_validator(obj_type, obj_data)
obj_type |
a string from one of the object types described above |
obj_data |
a |
AccessMapping
a character
a character
a character
a character
AccountSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
AccountSharingRuleSettings
a character
a character
a character
ActionLinkGroupTemplate
a character (inherited from Metadata)
a ActionLinkTemplate
a PlatformActionGroupCategory - which is a character taking one of the following values:
Primary
Overflow
a ActionLinkExecutionsAllowed - which is a character taking one of the following values:
Once
OncePerUser
Unlimited
an integer
a character either 'true' or 'false'
a character
ActionLinkTemplate
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a ActionLinkType - which is a character taking one of the following values:
API
APIAsync
Download
UI
a ActionLinkHttpMethod - which is a character taking one of the following values:
HttpDelete
HttpHead
HttpGet
HttpPatch
HttpPost
HttpPut
an integer
a character
a character
a ActionLinkUserVisibility - which is a character taking one of the following values:
Creator
Everyone
EveryoneButCreator
Manager
CustomUser
CustomExcludedUser
ActionOverride
a character
a character
a character
a FormFactor - which is a character taking one of the following values:
Small
Medium
Large
a character either 'true' or 'false'
a ActionOverrideType - which is a character taking one of the following values:
Default
Standard
Scontrol
Visualforce
Flexipage
LightningComponent
ActivitiesSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
AddressSettings
a character (inherited from Metadata)
a CountriesAndStates
AdjustmentsSettings
a character either 'true' or 'false'
a character either 'true' or 'false'
AgentConfigAssignments
a AgentConfigProfileAssignments
a AgentConfigUserAssignments
AgentConfigButtons
a character
AgentConfigProfileAssignments
a character
AgentConfigSkills
a character
AgentConfigUserAssignments
a character
AnalyticsCloudComponentLayoutItem
a character
a character
a character
a character
an integer
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
AnalyticSnapshot
a character (inherited from Metadata)
a character
a character
a AnalyticSnapshotMapping
a character
a character
a character
a character
AnalyticSnapshotMapping
a ReportSummaryType - which is a character taking one of the following values:
Sum
Average
Maximum
Minimum
None
a character
a ReportJobSourceTypes - which is a character taking one of the following values:
tabular
summary
snapshot
a character
ApexClass
a character formed using base64encode
(inherited from MetadataWithContent)
a numeric
a PackageVersion
a ApexCodeUnitStatus - which is a character taking one of the following values:
Inactive
Active
Deleted
ApexComponent
a character formed using base64encode
(inherited from MetadataWithContent)
a numeric
a character
a character
a PackageVersion
ApexPage
a character formed using base64encode
(inherited from MetadataWithContent)
a numeric
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a PackageVersion
ApexTestSuite
a character (inherited from Metadata)
a character
ApexTrigger
a character formed using base64encode
(inherited from MetadataWithContent)
a numeric
a PackageVersion
a ApexCodeUnitStatus - which is a character taking one of the following values:
Inactive
Active
Deleted
AppActionOverride
a character (inherited from ActionOverride)
a character (inherited from ActionOverride)
a character (inherited from ActionOverride)
a FormFactor (inherited from ActionOverride)
a character either 'true' or 'false' (inherited from ActionOverride)
a ActionOverrideType (inherited from ActionOverride)
a character
AppBrand
a character
a character
a character
an integer
a character either 'true' or 'false'
AppComponentList
a character
a character
AppMenu
a character (inherited from Metadata)
a AppMenuItem
AppMenuItem
a character
a character
AppPreferences
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
AppProfileActionOverride
a character (inherited from ProfileActionOverride)
a character (inherited from ProfileActionOverride)
a FormFactor (inherited from ProfileActionOverride)
a character (inherited from ProfileActionOverride)
a character (inherited from ProfileActionOverride)
a ActionOverrideType (inherited from ProfileActionOverride)
a character
ApprovalAction
a WorkflowActionReference
ApprovalEntryCriteria
a character
a FilterItem
a character
ApprovalPageField
a character
ApprovalProcess
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a ApprovalSubmitter
a ApprovalPageField
a ApprovalStep
a character
a character
a character either 'true' or 'false'
a ApprovalEntryCriteria
a ApprovalAction
a character either 'true' or 'false'
a ApprovalAction
a character either 'true' or 'false'
a ApprovalAction
a character
a NextAutomatedApprover
a character
a ApprovalAction
a RecordEditabilityType - which is a character taking one of the following values:
AdminOnly
AdminOrCurrentApprover
a character either 'true' or 'false'
ApprovalStep
a character either 'true' or 'false'
a ApprovalAction
a ApprovalStepApprover
a character
a ApprovalEntryCriteria
a StepCriteriaNotMetType - which is a character taking one of the following values:
ApproveRecord
RejectRecord
GotoNextStep
a character
a character
a ApprovalStepRejectBehavior
a ApprovalAction
ApprovalStepApprover
a Approver
a RoutingType - which is a character taking one of the following values:
Unanimous
FirstResponse
ApprovalStepRejectBehavior
a StepRejectBehaviorType - which is a character taking one of the following values:
RejectRequest
BackToPrevious
ApprovalSubmitter
a character
a ProcessSubmitterType - which is a character taking one of the following values:
group
role
user
roleSubordinates
roleSubordinatesInternal
owner
creator
partnerUser
customerPortalUser
portalRole
portalRoleSubordinates
allInternalUsers
Approver
a character
a NextOwnerType - which is a character taking one of the following values:
adhoc
user
userHierarchyField
relatedUserField
queue
AppWorkspaceConfig
a WorkspaceMapping
ArticleTypeChannelDisplay
a ArticleTypeTemplate
ArticleTypeTemplate
a Channel - which is a character taking one of the following values:
AllChannels
App
Pkb
Csp
Prm
a character
a Template - which is a character taking one of the following values:
Page
Tab
Toc
AssignmentRule
a character (inherited from Metadata)
a character either 'true' or 'false'
a RuleEntry
AssignmentRules
a character (inherited from Metadata)
a AssignmentRule
AssistantRecommendationType
a character (inherited from Metadata)
a character
a character
a PlatformActionList
a character
a character
Attachment
a character formed using base64encode
a character
AuraDefinitionBundle
a character (inherited from Metadata)
a character formed using base64encode
a numeric
a character formed using base64encode
a character
a character formed using base64encode
a character formed using base64encode
a character formed using base64encode
a character formed using base64encode
a character formed using base64encode
a PackageVersion
a character formed using base64encode
a character formed using base64encode
a character formed using base64encode
a AuraBundleType - which is a character taking one of the following values:
Application
Component
Event
Interface
Tokens
AuthProvider
a character (inherited from Metadata)
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a AuthProviderType - which is a character taking one of the following values:
Janrain
Salesforce
OpenIdConnect
MicrosoftACS
GitHub
Custom
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
AutoResponseRule
a character (inherited from Metadata)
a character either 'true' or 'false'
a RuleEntry
AutoResponseRules
a character (inherited from Metadata)
a AutoResponseRule
BrandingSet
a character (inherited from Metadata)
a BrandingSetProperty
a character
a character
a character
BrandingSetProperty
a character
a character
BusinessHoursEntry
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
a character formatted as 'hh:mm:ssZ
BusinessHoursSettings
a character (inherited from Metadata)
a BusinessHoursEntry
a Holiday
BusinessProcess
a character (inherited from Metadata)
a character
a character either 'true' or 'false'
a PicklistValue
CallCenter
a character (inherited from Metadata)
a character
a character
a character
a character
a character
a CallCenterSection
a character
CallCenterItem
a character
a character
a character
CallCenterSection
a CallCenterItem
a character
a character
CampaignInfluenceModel
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
CaseSettings
a character (inherited from Metadata)
a character
a character
a character
a character
a FeedItemSettings
a character either 'true' or 'false'
a character
a character
a character
a character
a EmailToCaseSettings
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a WebToCaseSettings
CaseSubjectParticle
a character (inherited from Metadata)
an integer
a character
a CaseSubjectParticleType - which is a character taking one of the following values:
ProvidedString
Source
MessageType
SocialHandle
SocialNetwork
Sentiment
RealName
Content
PipeSeparator
ColonSeparator
HyphenSeparator
Certificate
a character formed using base64encode
(inherited from MetadataWithContent)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character formatted as 'yyyy-mm-ddThh:mm:ssZ'
an integer
a character
a character either 'true' or 'false'
ChannelLayout
a character (inherited from Metadata)
a character
a character
a ChannelLayoutItem
a character
ChannelLayoutItem
a character
ChartSummary
a ReportSummaryType - which is a character taking one of the following values:
Sum
Average
Maximum
Minimum
None
a ChartAxis - which is a character taking one of the following values:
x
y
y2
r
a character
ChatterAnswersReputationLevel
a character
an integer
ChatterAnswersSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
ChatterExtension
a character (inherited from Metadata)
a character
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a ChatterExtensionType - which is a character taking one of the following values:
Lightning
ChatterMobileSettings
a character either 'true' or 'false'
CleanDataService
a character (inherited from Metadata)
a CleanRule
a character
a character
a character
CleanRule
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a FieldMapping
a character
a character
a character
a CleanRuleStatus - which is a character taking one of the following values:
Inactive
Active
a character
CodeLocation
an integer
an integer
an integer
a numeric
Community
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a ReputationLevels
a character either 'true' or 'false'
a character
CommunityCustomThemeLayoutType
a character
a character
CommunityRoles
a character
a character
a character
CommunityTemplateBundleInfo
a character
a character
an integer
a character
a CommunityTemplateBundleInfoType - which is a character taking one of the following values:
Highlight
PreviewImage
CommunityTemplateDefinition
a character (inherited from Metadata)
a CommunityBaseTemplate - which is a character taking one of the following values:
c
a CommunityTemplateBundleInfo
a CommunityTemplateCategory - which is a character taking one of the following values:
IT
Marketing
Sales
Service
a character
a character
a character
a character either 'true' or 'false'
a character
a NavigationLinkSet
a CommunityTemplatePageSetting
CommunityTemplatePageSetting
a character
a character
CommunityThemeDefinition
a character (inherited from Metadata)
a CommunityCustomThemeLayoutType
a character
a character either 'true' or 'false'
a character
a CommunityThemeSetting
CommunityThemeSetting
a character
a character
a CommunityThemeLayoutType - which is a character taking one of the following values:
Login
Home
Inner
CompactLayout
a character (inherited from Metadata)
a character
a character
CompanySettings
a character (inherited from Metadata)
a FiscalYearSettings
ComponentInstance
a ComponentInstanceProperty
a character
a UiFormulaRule
ComponentInstanceProperty
a character
a ComponentInstancePropertyTypeEnum - which is a character taking one of the following values:
decorator
a character
ConnectedApp
a character (inherited from Metadata)
a ConnectedAppAttribute
a ConnectedAppCanvasConfig
a character
a character
a character
a character
a character
a ConnectedAppIpRange
a character
a character
a ConnectedAppMobileDetailConfig
a character
a ConnectedAppOauthConfig
a character
a ConnectedAppSamlConfig
a character
ConnectedAppAttribute
a character
a character
ConnectedAppCanvasConfig
a AccessMethod - which is a character taking one of the following values:
Get
Post
a character
a character
a CanvasLocationOptions - which is a character taking one of the following values:
None
Chatter
UserProfile
Visualforce
Aura
Publisher
ChatterFeed
ServiceDesk
OpenCTI
AppLauncher
MobileNav
PageLayout
a CanvasOptions - which is a character taking one of the following values:
HideShare
HideHeader
PersonalEnabled
a SamlInitiationMethod - which is a character taking one of the following values:
None
IdpInitiated
SpInitiated
ConnectedAppIpRange
a character
a character
a character
ConnectedAppMobileDetailConfig
a character formed using base64encode
a character
a character
an integer
a character
a character
a character
a DevicePlatformType - which is a character taking one of the following values:
ios
android
a DeviceType - which is a character taking one of the following values:
phone
tablet
minitablet
a character
a character either 'true' or 'false'
a character
ConnectedAppOauthConfig
a character
a character
a character
a character
a ConnectedAppOauthAccessScope - which is a character taking one of the following values:
Basic
Api
Web
Full
Chatter
CustomApplications
RefreshToken
OpenID
Profile
Address
Phone
OfflineAccess
CustomPermissions
Wave
Eclair
a character
ConnectedAppSamlConfig
a character
a character
a character
a SamlEncryptionType - which is a character taking one of the following values:
AES_128
AES_256
Triple_Des
a character
a character
a SamlIdpSLOBinding - which is a character taking one of the following values:
RedirectBinding
PostBinding
a SamlNameIdFormatType - which is a character taking one of the following values:
Unspecified
EmailAddress
Persistent
Transient
a character
a character
a SamlSubjectType - which is a character taking one of the following values:
Username
FederationId
UserId
SpokeId
CustomAttribute
PersistentId
Container
an integer
a character either 'true' or 'false'
a character
a SidebarComponent
a character
a character
an integer
ContentAsset
a character formed using base64encode
(inherited from MetadataWithContent)
a ContentAssetFormat - which is a character taking one of the following values:
Original
ZippedVersions
a character
a character
a character
a ContentAssetRelationships
a ContentAssetVersions
ContentAssetLink
a ContentAssetAccess - which is a character taking one of the following values:
VIEWER
COLLABORATOR
INFERRED
a character either 'true' or 'false'
a character
ContentAssetRelationships
a ContentAssetLink
a ContentAssetLink
a ContentAssetLink
a ContentAssetLink
ContentAssetVersion
a character
a character
a character
ContentAssetVersions
a ContentAssetVersion
ContractSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
CorsWhitelistOrigin
a character (inherited from Metadata)
a character
CountriesAndStates
a Country
Country
a character either 'true' or 'false'
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a State
a character either 'true' or 'false'
CspTrustedSite
a character (inherited from Metadata)
a character
a character
a character either 'true' or 'false'
CustomApplication
a character (inherited from Metadata)
a AppActionOverride
a AppBrand
a ServiceCloudConsoleConfig
a character
a character
a FormFactor - which is a character taking one of the following values:
Small
Medium
Large
a character either 'true' or 'false'
a character
a character
a NavType - which is a character taking one of the following values:
Standard
Console
a AppPreferences
a AppProfileActionOverride
a character
a character
a character
a UiType - which is a character taking one of the following values:
Aloha
Lightning
a character
a AppWorkspaceConfig
CustomApplicationComponent
a character (inherited from Metadata)
a character
a character
a character
an integer
an integer
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
an integer
CustomApplicationTranslation
a character
a character
CustomConsoleComponents
a PrimaryTabComponents
a SubtabComponents
CustomDataType
a character (inherited from Metadata)
a CustomDataTypeComponent
a character
a character
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
CustomDataTypeComponent
a character
a character either 'true' or 'false'
a character
an integer
an integer
an integer
a SortOrder - which is a character taking one of the following values:
Asc
Desc
an integer
a FieldType - which is a character taking one of the following values:
AutoNumber
Lookup
MasterDetail
Checkbox
Currency
Date
DateTime
Number
Percent
Phone
Picklist
MultiselectPicklist
Text
TextArea
LongTextArea
Html
Url
EncryptedText
Summary
Hierarchy
File
MetadataRelationship
Location
ExternalLookup
IndirectLookup
CustomDataType
Time
CustomDataTypeComponentTranslation
a character
a character
CustomDataTypeTranslation
a CustomDataTypeComponentTranslation
a character
a character
a character
CustomExperience
a character (inherited from Metadata)
a character either 'true' or 'false'
a CustomExperienceBranding
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a CustomExperienceTabSet
a character
a character
CustomExperienceBranding
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
CustomExperienceTabSet
a character
a character
a character
CustomFeedFilter
a character (inherited from Metadata)
a FeedFilterCriterion
a character
a character either 'true' or 'false'
a character
CustomField
a character (inherited from Metadata)
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a DeleteConstraint - which is a character taking one of the following values:
Cascade
Restrict
SetNull
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a FieldManageability - which is a character taking one of the following values:
DeveloperControlled
SubscriberControlled
Locked
a character
a TreatBlanksAs - which is a character taking one of the following values:
BlankAsBlank
BlankAsZero
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
an integer
a LookupFilter
a EncryptedFieldMaskChar - which is a character taking one of the following values:
asterisk
X
a EncryptedFieldMaskType - which is a character taking one of the following values:
all
creditCard
ssn
lastFour
sin
nino
a character
a character either 'true' or 'false'
an integer
a character
a character
a character
a character
an integer
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
an integer
a SecurityClassification - which is a character taking one of the following values:
AccountInformation
ConfigurationAndUsageData
DataIntendedToBePublic
BusinessSetupDataBusinessDataAndAggregates
AssociativeBusinessOrPersonalData
AuthenticationData
an integer
a character either 'true' or 'false'
a character
a FilterItem
a character
a SummaryOperations - which is a character taking one of the following values:
count
sum
min
max
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a FieldType - which is a character taking one of the following values:
AutoNumber
Lookup
MasterDetail
Checkbox
Currency
Date
DateTime
Number
Percent
Phone
Picklist
MultiselectPicklist
Text
TextArea
LongTextArea
Html
Url
EncryptedText
Summary
Hierarchy
File
MetadataRelationship
Location
ExternalLookup
IndirectLookup
CustomDataType
Time
a character either 'true' or 'false'
a ValueSet
an integer
a character either 'true' or 'false'
CustomFieldTranslation
a ObjectNameCaseValue
a Gender - which is a character taking one of the following values:
Neuter
Masculine
Feminine
AnimateMasculine
a character
a character
a LookupFilterTranslation
a character
a PicklistValueTranslation
a character
a StartsWith - which is a character taking one of the following values:
Consonant
Vowel
Special
CustomLabel
a character (inherited from Metadata)
a character
a character
a character either 'true' or 'false'
a character
a character
CustomLabels
a character (inherited from Metadata)
a CustomLabel
CustomLabelTranslation
a character
a character
CustomMetadata
a character (inherited from Metadata)
a character
a character
a character either 'true' or 'false'
a CustomMetadataValue
CustomMetadataValue
a character
a character that appears similar to any of the other accepted types (integer, numeric, date, datetime, boolean)
CustomNotificationType
a character (inherited from Metadata)
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
CustomObject
a character (inherited from Metadata)
a ActionOverride
a character either 'true' or 'false'
a ArticleTypeChannelDisplay
a BusinessProcess
a character
a CompactLayout
a character
a character
a CustomSettingsType - which is a character taking one of the following values:
List
Hierarchy
a character
a character
a DeploymentStatus - which is a character taking one of the following values:
InDevelopment
Deployed
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a PlatformEventType - which is a character taking one of the following values:
HighVolume
StandardVolume
a character
a character
a character
a SharingModel - which is a character taking one of the following values:
Private
Read
ReadSelect
ReadWrite
ReadWriteTransfer
FullAccess
ControlledByParent
a FieldSet
a CustomField
a Gender - which is a character taking one of the following values:
Neuter
Masculine
Feminine
AnimateMasculine
a HistoryRetentionPolicy
a character either 'true' or 'false'
a Index
a character
a ListView
a CustomField
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a RecordType
a SearchLayouts
a SharingModel - which is a character taking one of the following values:
Private
Read
ReadSelect
ReadWrite
ReadWriteTransfer
FullAccess
ControlledByParent
a SharingReason
a SharingRecalculation
a StartsWith - which is a character taking one of the following values:
Consonant
Vowel
Special
a ValidationRule
a SetupObjectVisibility - which is a character taking one of the following values:
Protected
Public
a WebLink
CustomObjectTranslation
a character (inherited from Metadata)
a ObjectNameCaseValue
a FieldSetTranslation
a CustomFieldTranslation
a Gender - which is a character taking one of the following values:
Neuter
Masculine
Feminine
AnimateMasculine
a LayoutTranslation
a character
a QuickActionTranslation
a RecordTypeTranslation
a SharingReasonTranslation
a StandardFieldTranslation
a StartsWith - which is a character taking one of the following values:
Consonant
Vowel
Special
a ValidationRuleTranslation
a WebLinkTranslation
a WorkflowTaskTranslation
CustomPageWebLink
a character (inherited from Metadata)
a WebLinkAvailability - which is a character taking one of the following values:
online
offline
a character
a WebLinkDisplayType - which is a character taking one of the following values:
link
button
massActionButton
a Encoding - which is a character taking one of the following values:
UTF-8
ISO-8859-1
Shift_JIS
ISO-2022-JP
EUC-JP
ks_c_5601-1987
Big5
GB2312
Big5-HKSCS
x-SJIS_0213
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
an integer
a character either 'true' or 'false'
a WebLinkType - which is a character taking one of the following values:
url
sControl
javascript
page
flow
a character
a WebLinkWindowType - which is a character taking one of the following values:
newWindow
sidebar
noSidebar
replace
onClickJavaScript
a character
a WebLinkPosition - which is a character taking one of the following values:
fullScreen
none
topLeft
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
an integer
CustomPageWebLinkTranslation
a character
a character
CustomPermission
a character (inherited from Metadata)
a character
a character
a character
a CustomPermissionDependencyRequired
CustomPermissionDependencyRequired
a character
a character either 'true' or 'false'
CustomShortcut
a character (inherited from DefaultShortcut)
a character either 'true' or 'false' (inherited from DefaultShortcut)
a character (inherited from DefaultShortcut)
a character
a character
CustomSite
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a character
a SiteClickjackProtectionLevel - which is a character taking one of the following values:
AllowAllFraming
SameOriginOnly
NoFraming
a character either 'true' or 'false'
a character either 'true' or 'false'
a SiteWebAddress
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a SiteRedirectMapping
a character
a SiteType - which is a character taking one of the following values:
Siteforce
Visualforce
User
a character
a character
CustomTab
a character (inherited from Metadata)
a ActionOverride
a character
a character either 'true' or 'false'
a character
a character
an integer
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a Encoding - which is a character taking one of the following values:
UTF-8
ISO-8859-1
Shift_JIS
ISO-2022-JP
EUC-JP
ks_c_5601-1987
Big5
GB2312
Big5-HKSCS
x-SJIS_0213
CustomTabTranslation
a character
a character
CustomValue
a character (inherited from Metadata)
a character
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character
Dashboard
a character (inherited from Metadata)
a character
a ChartBackgroundDirection - which is a character taking one of the following values:
TopToBottom
LeftToRight
Diagonal
a character
a ChartTheme - which is a character taking one of the following values:
light
dark
a ChartColorPalettes - which is a character taking one of the following values:
Default
gray
colorSafe
unity
justice
nightfall
sunrise
bluegrass
tropic
heat
dusk
pond
watermelon
fire
water
earth
accessible
a ChartTheme - which is a character taking one of the following values:
light
dark
a ChartColorPalettes - which is a character taking one of the following values:
Default
gray
colorSafe
unity
justice
nightfall
sunrise
bluegrass
tropic
heat
dusk
pond
watermelon
fire
water
earth
accessible
a DashboardFilter
a DashboardGridLayout
a character
a character
a DashboardType - which is a character taking one of the following values:
SpecifiedUser
LoggedInUser
MyTeamUser
a character
a character
a character either 'true' or 'false'
a DashboardComponentSection
a DashboardComponentSection
an integer
a DashboardComponentSection
a character
a character
a character
a character
an integer
DashboardComponent
a character either 'true' or 'false'
a ChartRangeType - which is a character taking one of the following values:
Auto
Manual
a numeric
a numeric
a ChartSummary
a ChartTheme - which is a character taking one of the following values:
light
dark
a DashboardComponentType - which is a character taking one of the following values:
Bar
BarGrouped
BarStacked
BarStacked100
Column
ColumnGrouped
ColumnStacked
ColumnStacked100
Line
LineGrouped
Pie
Table
Metric
Gauge
LineCumulative
LineGroupedCumulative
Scontrol
VisualforcePage
Donut
Funnel
ColumnLine
ColumnLineGrouped
ColumnLineStacked
ColumnLineStacked100
Scatter
ScatterGrouped
FlexTable
a DashboardFilterColumn
a DashboardTableColumn
a ChartUnits - which is a character taking one of the following values:
Auto
Integer
Hundreds
Thousands
Millions
Billions
Trillions
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a DashboardFlexTableComponentProperties
a character
a numeric
a numeric
a character
a character
a numeric
a numeric
a character
a character
a character
a ChartLegendPosition - which is a character taking one of the following values:
Right
Bottom
OnChart
an integer
a character
a character
an integer
a character
a character
an integer
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a DashboardComponentFilter - which is a character taking one of the following values:
RowLabelAscending
RowLabelDescending
RowValueAscending
RowValueDescending
a character
a character either 'true' or 'false'
DashboardComponentColumn
a numeric
a numeric
an integer
an integer
an integer
an integer
a character
a character either 'true' or 'false'
a DashboardComponentColumnType - which is a character taking one of the following values:
NA
DashboardComponentSection
a DashboardComponentSize - which is a character taking one of the following values:
Narrow
Medium
Wide
a DashboardComponent
DashboardComponentSortInfo
a character
a character
DashboardFilter
a DashboardFilterOption
a character
DashboardFilterColumn
a character
DashboardFilterOption
a DashboardFilterOperation - which is a character taking one of the following values:
equals
notEqual
lessThan
greaterThan
lessOrEqual
greaterOrEqual
contains
notContain
startsWith
includes
excludes
between
a character
DashboardFlexTableComponentProperties
a DashboardComponentColumn
a DashboardComponentSortInfo
a character either 'true' or 'false'
DashboardFolder
a FolderAccessTypes (inherited from Folder)
a FolderShare (inherited from Folder)
a character (inherited from Folder)
a PublicFolderAccess (inherited from Folder)
a SharedTo (inherited from Folder)
DashboardGridComponent
an integer
an integer
a DashboardComponent
an integer
an integer
DashboardGridLayout
a DashboardGridComponent
an integer
an integer
DashboardMobileSettings
a character either 'true' or 'false'
DashboardTableColumn
a ReportSummaryType - which is a character taking one of the following values:
Sum
Average
Maximum
Minimum
None
a character either 'true' or 'false'
a character
an integer
a character either 'true' or 'false'
a DashboardComponentFilter - which is a character taking one of the following values:
RowLabelAscending
RowLabelDescending
RowValueAscending
RowValueDescending
DataCategory
a DataCategory
a character
a character
DataCategoryGroup
a character (inherited from Metadata)
a character either 'true' or 'false'
a DataCategory
a character
a character
a ObjectUsage
DataPipeline
a character formed using base64encode
(inherited from MetadataWithContent)
a numeric
a character
a DataPipelineType - which is a character taking one of the following values:
Pig
DefaultShortcut
a character
a character either 'true' or 'false'
a character
DelegateGroup
a character (inherited from Metadata)
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
DeployDetails
a DeployMessage
a DeployMessage
a RetrieveResult
a RunTestsResult
DeployOptions
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a TestLevel - which is a character taking one of the following values:
NoTestRun
RunSpecifiedTests
RunLocalTests
RunAllTestsInOrg
DescribeMetadataObject
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
Document
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
DocumentFolder
a FolderAccessTypes (inherited from Folder)
a FolderShare (inherited from Folder)
a character (inherited from Folder)
a PublicFolderAccess (inherited from Folder)
a SharedTo (inherited from Folder)
DuplicateRule
a character (inherited from Metadata)
a DupeActionType - which is a character taking one of the following values:
Allow
Block
a DupeActionType - which is a character taking one of the following values:
Allow
Block
a character
a character
a DuplicateRuleFilter
a DuplicateRuleMatchRule
a character either 'true' or 'false'
a character
a character
a character
a DupeSecurityOptionType - which is a character taking one of the following values:
EnforceSharingRules
BypassSharingRules
an integer
DuplicateRuleFilter
a character
a DuplicateRuleFilterItem
DuplicateRuleFilterItem
a character (inherited from FilterItem)
a FilterOperation (inherited from FilterItem)
a character (inherited from FilterItem)
a character (inherited from FilterItem)
an integer
a character
DuplicateRuleMatchRule
a character
a character
a ObjectMapping
EclairGeoData
a character formed using base64encode
(inherited from MetadataWithContent)
a EclairMap
a character
EclairMap
a numeric
a numeric
a numeric
a numeric
a character
a character
a character
EmailFolder
a FolderAccessTypes (inherited from Folder)
a FolderShare (inherited from Folder)
a character (inherited from Folder)
a PublicFolderAccess (inherited from Folder)
a SharedTo (inherited from Folder)
EmailServicesAddress
a character
a character
a character either 'true' or 'false'
a character
a character
EmailServicesFunction
a character (inherited from Metadata)
a character
a EmailServicesAttOptions - which is a character taking one of the following values:
None
TextOnly
BinaryOnly
All
NoContent
a EmailServicesErrorAction - which is a character taking one of the following values:
UseSystemDefault
Bounce
Discard
Requeue
a EmailServicesErrorAction - which is a character taking one of the following values:
UseSystemDefault
Bounce
Discard
Requeue
a character
a EmailServicesAddress
a character
a EmailServicesErrorAction - which is a character taking one of the following values:
UseSystemDefault
Bounce
Discard
Requeue
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a EmailServicesErrorAction - which is a character taking one of the following values:
UseSystemDefault
Bounce
Discard
Requeue
EmailTemplate
a character formed using base64encode
(inherited from MetadataWithContent)
a numeric
a character
a Attachment
a character either 'true' or 'false'
a character
a Encoding - which is a character taking one of the following values:
UTF-8
ISO-8859-1
Shift_JIS
ISO-2022-JP
EUC-JP
ks_c_5601-1987
Big5
GB2312
Big5-HKSCS
x-SJIS_0213
a character
a character
a PackageVersion
a character
a EmailTemplateStyle - which is a character taking one of the following values:
none
freeForm
formalLetter
promotionRight
promotionLeft
newsletter
products
a character
a character
a EmailTemplateType - which is a character taking one of the following values:
text
html
custom
visualforce
a EmailTemplateUiType - which is a character taking one of the following values:
Aloha
SFX
SFX_Sample
EmailToCaseRoutingAddress
a EmailToCaseRoutingAddressType - which is a character taking one of the following values:
EmailToCase
Outlook
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character
EmailToCaseSettings
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a EmailToCaseOnFailureActionType - which is a character taking one of the following values:
Bounce
Discard
Requeue
a character either 'true' or 'false'
a EmailToCaseRoutingAddress
a EmailToCaseOnFailureActionType - which is a character taking one of the following values:
Bounce
Discard
Requeue
EmbeddedServiceBranding
a character (inherited from Metadata)
a character
a character
a character
a character
a character
a character
a character
a character
EmbeddedServiceConfig
a character (inherited from Metadata)
a character
a character
EmbeddedServiceFieldService
a character (inherited from Metadata)
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
EmbeddedServiceLiveAgent
a character (inherited from Metadata)
a character
a character
a character
a EmbeddedServiceQuickAction
a character either 'true' or 'false'
a EmbeddedServiceFontSize - which is a character taking one of the following values:
Small
Medium
Large
a character
a character
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character
a EmbeddedServiceScenario - which is a character taking one of the following values:
Sales
Service
Basic
a character
a character
EmbeddedServiceQuickAction
a character
an integer
a character
EntitlementProcess
a character (inherited from Metadata)
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a FilterItem
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a EntitlementProcessMilestoneItem
a character
a character
a character
a character
an integer
EntitlementProcessMilestoneItem
a character
a character
a FilterItem
a character
a character
a character
an integer
a WorkflowActionReference
a EntitlementProcessMilestoneTimeTrigger
a character either 'true' or 'false'
EntitlementProcessMilestoneTimeTrigger
a WorkflowActionReference
an integer
a MilestoneTimeUnits - which is a character taking one of the following values:
Minutes
Hours
Days
EntitlementSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
EntitlementTemplate
a character (inherited from Metadata)
a character
an integer
a character
a character either 'true' or 'false'
an integer
a character
EscalationAction
a character
a character
a AssignToLookupValueType - which is a character taking one of the following values:
User
Queue
an integer
a character either 'true' or 'false'
a character
a character
a character
EscalationRule
a character (inherited from Metadata)
a character either 'true' or 'false'
a RuleEntry
EscalationRules
a character (inherited from Metadata)
a EscalationRule
EventDelivery
a character (inherited from Metadata)
a EventParameterMap
a character
a character
a EventDeliveryType - which is a character taking one of the following values:
StartFlow
ResumeFlow
EventParameterMap
a character
a character
EventSubscription
a character (inherited from Metadata)
a character either 'true' or 'false'
a EventParameterMap
a character
a character
ExtendedErrorDetails
a ExtendedErrorCode - which is a character taking one of the following values:
ACTIONCALL_DUPLICATE_INPUT_PARAM - Errors with this extended error code have the following properties: actionCallName, parameterName
ACTIONCALL_DUPLICATE_OUTPUT_PARAM - Errors with this extended error code have the following properties: actionCallName, parameterName
ACTIONCALL_MISSING_NAME - Errors with this extended error code have the following properties:
ACTIONCALL_MISSING_REQUIRED_PARAM - Errors with this extended error code have the following properties: actionCallName, parameterName
ACTIONCALL_MISSING_REQUIRED_TYPE - Errors with this extended error code have the following properties: actionCallName
ACTIONCALL_NOT_FOUND_WITH_NAME_AND_TYPE - Errors with this extended error code have the following properties:
ACTIONCALL_NOT_SUPPORTED_FOR_PROCESSTYPE - Errors with this extended error code have the following properties: processType
APEXCALLOUT_INPUT_DUPLICATE - Errors with this extended error code have the following properties: apexClassName, parameterName
APEXCALLOUT_INPUT_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: apexClassName, parameterName
APEXCALLOUT_INVALID - Errors with this extended error code have the following properties: apexClassName
APEXCALLOUT_MISSING_CLASSNAME - Errors with this extended error code have the following properties: apexClassName
APEXCALLOUT_NOT_FOUND - Errors with this extended error code have the following properties: apexClassName
APEXCALLOUT_OUTPUT_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: apexClassName, parameterName
APEXCALLOUT_OUTPUT_NOT_FOUND - Errors with this extended error code have the following properties: apexClassName, parameterName
APEXCALLOUT_REQUIRED_INPUT_MISSING - Errors with this extended error code have the following properties: apexClassName, parameterName
APEXCLASS_MISSING_INTERFACE - Errors with this extended error code have the following properties: apexClassName, parentScreenFieldName
ASSIGNMENTITEM_ELEMENT_MISSING_DATATYPE - Errors with this extended error code have the following properties: assignmentName, operatorName, elementName
ASSIGNMENTITEM_ELEMENT_NOT_SUPPORTED - Errors with this extended error code have the following properties: elementName, assignmentName, elementType
ASSIGNMENTITEM_FIELD_INVALID_DATATYPE - Errors with this extended error code have the following properties: fieldValue, dataType, incompatibleDataType
ASSIGNMENTITEM_FIELD_INVALID_DATATYPE_WITH_ELEMENT - Errors with this extended error code have the following properties: elementName, acceptedDataType, dataType, fieldValue
ASSIGNMENTITEM_INCOMPATIBLE_DATATYPES - Errors with this extended error code have the following properties: assignmentName, operatorName, leftElementName, leftElementType, rightElementName, rightElementType
ASSIGNMENTITEM_INVALID_COLLECTION - Errors with this extended error code have the following properties: assignmentName, operatorName, leftElementName, rightElementName
ASSIGNMENTITEM_INVALID_DATATYPE_IN_ELEMENT - Errors with this extended error code have the following properties: elementName, dataType, incompatibleDataType
ASSIGNMENTITEM_INVALID_REFERENCE - Errors with this extended error code have the following properties: parameterName, operatorName
ASSIGNMENTITEM_LEFT_DATATYPE_INVALID_FOR_OPERATOR - Errors with this extended error code have the following properties: assignmentName, operatorName, dataType, elementName
ASSIGNMENTITEM_MODIFIES_NONVARIABLE - Errors with this extended error code have the following properties: assignmentName
ASSIGNMENTITEM_NONEXISTENT_REFERENCE - Errors with this extended error code have the following properties: parameterName, operatorName
ASSIGNMENTITEM_REQUIRED - Errors with this extended error code have the following properties: assignmentName
ASSIGNMENTITEM_RIGHT_DATATYPE_INVALID_FOR_OPERATOR - Errors with this extended error code have the following properties: elementName
AUTOLAUNCHED_CHOICELOOKUP_NOT_SUPPORTED - Errors with this extended error code have the following properties: choiceLookupName
AUTOLAUNCHED_CHOICE_NOT_SUPPORTED - Errors with this extended error code have the following properties: choiceName
AUTOLAUNCHED_SCREEN_NOT_SUPPORTED - Errors with this extended error code have the following properties:
AUTOLAUNCHED_STEP_NOT_SUPPORTED - Errors with this extended error code have the following properties:
AUTOLAUNCHED_SUBFLOW_INCOMPATIBLE_FLOWTYPE - Errors with this extended error code have the following properties: subflowType
AUTOLAUNCHED_WAIT_NOT_SUPPORTED - Errors with this extended error code have the following properties:
CHOICEFIELD_DEFAULT_CHOICE_NOT_FOUND - Errors with this extended error code have the following properties: screenFieldName
CHOICEFIELD_MISSING_CHOICE - Errors with this extended error code have the following properties: questionName
CHOICELOOKUP_DATATYPE_INCOMPATIBLE_WITH_CHOICEFIELD - Errors with this extended error code have the following properties: choiceName, parentScreenFieldName
CHOICE_DATATYPE_INCOMPATIBLE_WITH_CHOICEFIELD - Errors with this extended error code have the following properties: choiceName, parentScreenFieldName
CHOICE_NOT_SUPPORTED_FOR_SCREENFIELDTYPE - Errors with this extended error code have the following properties: elementName, screenFieldName
CHOICE_USED_MULTIPLE_TIMES_IN_SAME_FIELD - Errors with this extended error code have the following properties: choiceName
CONDITION_DATATYPE_INCOMPATIBLE - Errors with this extended error code have the following properties: leftElementName, leftElementType, operatorName, rightElementName, rightElementType, ruleName
CONDITION_DATATYPE_INCOMPATIBLE_WITH_ELEMENT - Errors with this extended error code have the following properties: elementName, dataType, operatorName, parameterName, ruleName
CONDITION_ELEMENT_DATATYPES_INCOMPATIBLE - Errors with this extended error code have the following properties: elementName, leftElementType, operatorName, rightElementType, ruleName
CONDITION_INVALID_LEFTOPERAND - Errors with this extended error code have the following properties: ruleName
CONDITION_INVALID_LEFT_ELEMENT - Errors with this extended error code have the following properties: elementName, dataType, operatorName, parameterName, ruleName
CONDITION_LOGIC_EXCEEDS_LIMIT - Errors with this extended error code have the following properties: elementName, characterLimit
CONDITION_LOGIC_INVALID - Errors with this extended error code have the following properties: elementName
CONDITION_LOGIC_MISSING - Errors with this extended error code have the following properties: elementName
CONDITION_MISSING_DATATYPE - Errors with this extended error code have the following properties: elementName, dataType, operatorName, parameterName, ruleName
CONDITION_MISSING_OPERATOR - Errors with this extended error code have the following properties: ruleName
CONDITION_REFERENCED_ELEMENT_NOT_FOUND - Errors with this extended error code have the following properties: ruleName
CONDITION_RIGHTOPERAND_NULL - Errors with this extended error code have the following properties: ruleName
CONNECTOR_MISSING_TARGET - Errors with this extended error code have the following properties: elementName
CONSTANT_INCLUDES_REFERENCES - Errors with this extended error code have the following properties: constantName
CUSTOMEVENTS_NOT_ENABLED - Errors with this extended error code have the following properties:
CUSTOMEVENT_MISSING_PROCESSMETADATAVALUES - Errors with this extended error code have the following properties:
CUSTOMEVENT_OBJECTTYPE_NOT_FOUND - Errors with this extended error code have the following properties: objectType
CUSTOMEVENT_OBJECTTYPE_NOT_SUPPORTED - Errors with this extended error code have the following properties: objectType
CUSTOMEVENT_PROCESSMETADATAVALUES_MISSING_NAME - Errors with this extended error code have the following properties: metadataValue
CUSTOMEVENT_PROCESSMETADATAVALUES_MORE_THAN_ONE_NAME - Errors with this extended error code have the following properties: metadataValue
DATATYPE_INVALID - Errors with this extended error code have the following properties: elementName, dataType
DATATYPE_MISSING - Errors with this extended error code have the following properties: elementName
DECISION_DEFAULT_CONNECTOR_MISSING_LABEL - Errors with this extended error code have the following properties: flowDecision
DECISION_MISSING_OUTCOME - Errors with this extended error code have the following properties: flowDecision
ELEMENT_CONNECTS_TO_SELF - Errors with this extended error code have the following properties: elementName
ELEMENT_COORDINATES_INVALID - Errors with this extended error code have the following properties: coordinateLimit, coordinateName
ELEMENT_INVALID_CONNECTOR - Errors with this extended error code have the following properties: elementName
ELEMENT_INVALID_REFERENCE - Errors with this extended error code have the following properties: elementName
ELEMENT_MISSING_CONNECTOR - Errors with this extended error code have the following properties: elementName
ELEMENT_MISSING_LABEL - Errors with this extended error code have the following properties: characterLimit, elementName
ELEMENT_MISSING_NAME - Errors with this extended error code have the following properties: characterLimit
ELEMENT_MISSING_REFERENCE - Errors with this extended error code have the following properties: elementName
ELEMENT_MORE_THAN_ONE_FIELD - Errors with this extended error code have the following properties: elementName
ELEMENT_NAME_INVALID - Errors with this extended error code have the following properties:
ELEMENT_NEVER_USED - Errors with this extended error code have the following properties: elementName
ELEMENT_SCALE_SMALLER_THAN_DEFAULTVALUE - Errors with this extended error code have the following properties: elementName
EXTERNAL_OBJECTS_NOT_SUPPORTED - Errors with this extended error code have the following properties: objectName
EXTERNAL_OBJECT_FIELDS_NOT_SUPPORTED - Errors with this extended error code have the following properties: fieldReference
FIELDASSIGNMENT_FIELD_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: fieldName, elementName
FIELDASSIGNMENT_INVALID_DATATYPE - Errors with this extended error code have the following properties: fieldName, elementName, assignmentName
FIELDASSIGNMENT_INVALID_ELEMENT - Errors with this extended error code have the following properties: fieldName, elementName, elementType
FIELDASSIGNMENT_INVALID_REFERENCE - Errors with this extended error code have the following properties: fieldName, parameterName
FIELDASSIGNMENT_MULTIPLE_REFERENCES_SAME_FIELD - Errors with this extended error code have the following properties: fieldName
FIELDASSIGNMENT_PICKLISTFIELD_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: fieldName, dataType
FIELDASSIGNMENT_REFERENCED_ELEMENT_MISSING_DATATYPE - Errors with this extended error code have the following properties: fieldName, elementName, elementType
FIELDSERVICE_UNSUPPORTED_FIELD_TYPE - Errors with this extended error code have the following properties: elementName
FIELD_INVALID_VALUE - Errors with this extended error code have the following properties: fieldName, parameterName
FIELD_NOT_FOUND - Errors with this extended error code have the following properties: objectName, fieldName
FIELD_RELATIONSHIP_NOT_SUPPORTED - Errors with this extended error code have the following properties: fieldRelationshipName
FLEXIPAGE_COMPONENT_ATTRIBUTE_EXPRESSION_EXCEPTION - Errors with this extended error code have the following properties: componentName, propertyName, propertyType, errorCode, invalidTokens
FLEXIPAGE_COMPONENT_ATTRIBUTE_GENERIC_EXCEPTION - Errors with this extended error code have the following properties: componentName, propertyName, propertyType, errorIdentifier, errorParams
FLEXIPAGE_COMPONENT_ATTRIBUTE_MISSING_REQUIRED - Errors with this extended error code have the following properties: componentName, propertyName, propertyType
FLEXIPAGE_COMPONENT_ATTRIBUTE_TOO_LONG - Errors with this extended error code have the following properties: componentName, propertyName, propertyType, maxLength
FLEXIPAGE_COMPONENT_MAX_LIMIT_EXCEPTION - Errors with this extended error code have the following properties:
FLEXIPAGE_COMPONENT_RULE_VALIDATION_EXCEPTION - Errors with this extended error code have the following properties: componentName, criterionIndex
FLEXIPAGE_PICKLIST_INVALID_VALUE_EXCEPTION - Errors with this extended error code have the following properties: componentName, propertyName, propertyType, invalidValue
FLOW_INCLUDES_STEP - Errors with this extended error code have the following properties: elementName
FLOW_NAME_USED_IN_OTHER_CLIENT - Errors with this extended error code have the following properties: flowName
FLOW_STAGE_INCLUDES_REFERENCES - Errors with this extended error code have the following properties: stageName
FORMULA_EXPRESSION_INVALID - Errors with this extended error code have the following properties: formulaExpression
INPUTPARAM_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: parameterName
INPUTPARAM_INCOMPATIBLE_WITH_COLLECTION_VARIABLE - Errors with this extended error code have the following properties: parameterName
INPUTPARAM_INCOMPATIBLE_WITH_NONCOLLECTION_VARIABLE - Errors with this extended error code have the following properties: parameterName
INPUTPARAM_MISMATCHED_OBJECTTYPE - Errors with this extended error code have the following properties: parameterName
INVALID_FLOW - Errors with this extended error code have the following properties:
INVALID_SURVEY_VARIABLE_NAME_OR_TYPE - Errors with this extended error code have the following properties: surveyName
LOOP_ASSIGNNEXTVALUETO_MISMATCHED_DATATYPE - Errors with this extended error code have the following properties: elementName
LOOP_ASSIGNNEXTVALUETO_MISMATCHED_OBJECTTYPE - Errors with this extended error code have the following properties: elementName
LOOP_ASSIGNNEXTVALUETO_MISSING - Errors with this extended error code have the following properties: elementName
LOOP_ASSIGNNEXTVALUETO_MISSING_VARIABLE - Errors with this extended error code have the following properties: elementName
LOOP_ASSIGNNEXTVALUETO_REFERENCE_NOT_FOUND - Errors with this extended error code have the following properties: fieldRelationshipName
LOOP_COLLECTION_ELEMENT_NOT_FOUND - Errors with this extended error code have the following properties: elementName
LOOP_COLLECTION_NOT_FOUND - Errors with this extended error code have the following properties: elementName
LOOP_COLLECTION_NOT_SUPPORTED_FOR_FIELD - Errors with this extended error code have the following properties: fieldName
LOOP_MISSING_COLLECTION - Errors with this extended error code have the following properties:
OBJECTTYPE_INVALID - Errors with this extended error code have the following properties: objectType
OBJECT_CANNOT_BE_CREATED - Errors with this extended error code have the following properties: objectName
OBJECT_CANNOT_BE_DELETED - Errors with this extended error code have the following properties: objectName
OBJECT_CANNOT_BE_QUERIED - Errors with this extended error code have the following properties: objectName
OBJECT_CANNOT_BE_UPDATED - Errors with this extended error code have the following properties: objectName
OBJECT_ENCRYPTED_FIELDS_NOT_SUPPORTED - Errors with this extended error code have the following properties: fieldName
OBJECT_NOT_FOUND - Errors with this extended error code have the following properties: objectName
OUTPUTPARAM_ASSIGNTOREFERENCE_NOTFOUND - Errors with this extended error code have the following properties: parameterName
OUTPUTPARAM_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: parameterName
OUTPUTPARAM_MISMATCHED_OBJECTTYPE - Errors with this extended error code have the following properties: parameterName
OUTPUTPARAM_MISMATCHED_WITH_COLLECTION_VARIABLE - Errors with this extended error code have the following properties: parameterName
OUTPUTPARAM_MISSING_ASSIGNTOREFERENCE - Errors with this extended error code have the following properties: parameterName
OUTPUTPARAM_MISTMATCHED_WITH_NONCOLLECTION_VARIABLE - Errors with this extended error code have the following properties: parameterName
PARAM_DATATYPE_NOT_SUPPORTED - Errors with this extended error code have the following properties: parameterName
PROCESSMETADATAVALUES_NOT_SUPPORTED_FOR_PROCESSTYPE - Errors with this extended error code have the following properties: processType, metadataValue
PROCESSMETADATAVALUE_NONEXISTENT_ELEMENT - Errors with this extended error code have the following properties: metadataValue
PROCESSTYPE_ELEMENT_NOT_SUPPORTED - Errors with this extended error code have the following properties: processType, elementType
PROCESSTYPE_NOT_SUPPORTED - Errors with this extended error code have the following properties: processType
RECORDFILTER_ENCRYPTED_FIELDS_NOT_SUPPORTED - Errors with this extended error code have the following properties: fieldName
RECORDFILTER_GEOLOCATION_FIELDS_NOT_SUPPORTED - Errors with this extended error code have the following properties: fieldName, objectName
RECORDFILTER_INVALID_DATATYPE - Errors with this extended error code have the following properties: fieldName, elementName, elementType, operatorName
RECORDFILTER_INVALID_ELEMENT - Errors with this extended error code have the following properties: fieldName, assignmentName, elementName, elementType
RECORDFILTER_INVALID_OPERATOR - Errors with this extended error code have the following properties: fieldName, operatorName
RECORDFILTER_INVALID_REFERENCE - Errors with this extended error code have the following properties: fieldName, operatorName
RECORDFILTER_MISSING_DATATYPE - Errors with this extended error code have the following properties: fieldName, elementName, elementType, operatorName
RECORDFILTER_MULTIPLE_QUERIES_SAME_FIELD - Errors with this extended error code have the following properties: fieldName
RECORDLOOKUP_IDASSIGNMENT_VARIABLE_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: elementName
RECORDLOOKUP_IDASSIGNMENT_VARIABLE_NOT_FOUND - Errors with this extended error code have the following properties: elementName
RECORDUPDATE_MISSING_FILTERS - Errors with this extended error code have the following properties: objectName
REFERENCED_ELEMENT_NOT_FOUND - Errors with this extended error code have the following properties: elementName, mergeFieldReference
RULE_MISSING_CONDITION - Errors with this extended error code have the following properties: elementName, ruleName
SCREENFIELD_BOOLEAN_ISREQUIRED_IS_FALSE - Errors with this extended error code have the following properties: fieldName
SCREENFIELD_DEFAULTVALUE_NOT_SUPPORTED - Errors with this extended error code have the following properties: elementName
SCREENFIELD_EXTENSION_COMPONENT_NOT_GLOBAL - Errors with this extended error code have the following properties: elementName
SCREENFIELD_EXTENSION_DUPLICATE_INPUT_PARAM - Errors with this extended error code have the following properties: elementName, extensionName, parameterName
SCREENFIELD_EXTENSION_DUPLICATE_OUTPUT_PARAM - Errors with this extended error code have the following properties: elementName, extensionName, parameterName
SCREENFIELD_EXTENSION_IMPLEMENTATION_INVALID - Errors with this extended error code have the following properties: elementName, extensionName
SCREENFIELD_EXTENSION_INPUT_ATTRIBUTE_INVALID - Errors with this extended error code have the following properties: elementName, extensionName, parameterName
SCREENFIELD_EXTENSION_NAME_INVALID - Errors with this extended error code have the following properties: elementName, extensionName
SCREENFIELD_EXTENSION_NAME_MISSING - Errors with this extended error code have the following properties: elementName, fieldType
SCREENFIELD_EXTENSION_NAME_NOT_SUPPORTED - Errors with this extended error code have the following properties: elementName, fieldType
SCREENFIELD_EXTENSION_OUTPUT_ATTRIBUTE_INVALID - Errors with this extended error code have the following properties: elementName, extensionName, parameterName
SCREENFIELD_EXTENSION_REQUIRED_INPUT_MISSING - Errors with this extended error code have the following properties: elementName, extensionName, parameterName
SCREENFIELD_INPUTS_NOT_SUPPORTED - Errors with this extended error code have the following properties: elementName, fieldType
SCREENFIELD_INVALID_DATATYPE - Errors with this extended error code have the following properties: dataType, fieldType
SCREENFIELD_MULTISELECTCHOICE_SEMICOLON_NOT_SUPPORTED - Errors with this extended error code have the following properties: choiceName
SCREENFIELD_OUTPUTS_NOT_SUPPORTED - Errors with this extended error code have the following properties: elementName, fieldType
SCREENFIELD_TYPE_NOT_SUPPORTED - Errors with this extended error code have the following properties: elementName, fieldType
SCREENFIELD_USERINPUT_NOT_SUPPORTED_FOR_CHOICETYPE - Errors with this extended error code have the following properties: choiceName
SCREENFIELD_VALIDATIONRULE_NOT_SUPPORTED - Errors with this extended error code have the following properties: elementName
SCREENRULE_ACTION_INVALID_ATTRIBUTE - Errors with this extended error code have the following properties: screenRuleName, attributeName
SCREENRULE_ACTION_INVALID_ATTRIBUTE_FOR_API_VERSION - Errors with this extended error code have the following properties: screenRuleName, attributeName
SCREENRULE_ACTION_INVALID_VALUE - Errors with this extended error code have the following properties: screenRuleName, acceptedValues, actionValue
SCREENRULE_ACTION_MISSING_ATTRIBUTE - Errors with this extended error code have the following properties: screenRuleName
SCREENRULE_ACTION_MISSING_FIELDREFERENCE - Errors with this extended error code have the following properties: screenRuleName
SCREENRULE_ACTION_MISSING_VALUE - Errors with this extended error code have the following properties: screenRuleName
SCREENRULE_ATTRIBUTE_NOT_SUPPORTED_FOR_SCREENFIELD - Errors with this extended error code have the following properties: screenRuleName, attributeName, fieldName
SCREENRULE_FIELD_NOT_FOUND_ON_SCREEN - Errors with this extended error code have the following properties: screenRuleName, fieldValue
SCREENRULE_MISSING_ACTION - Errors with this extended error code have the following properties: screenRuleName
SCREENRULE_NOT_SUPPORTED_IN_ORG - Errors with this extended error code have the following properties:
SCREENRULE_SCREENFIELD_NOT_VISIBLE - Errors with this extended error code have the following properties: fieldName
SCREENRULE_VISIBILITY_NOT_SUPPORTED_IN_ORG - Errors with this extended error code have the following properties:
SCREEN_ALLOWBACK_ALLOWFINISH_BOTH_FALSE - Errors with this extended error code have the following properties:
SCREEN_CONTAINS_LIGHTNING_COMPONENT - Errors with this extended error code have the following properties: elementName
SCREEN_MISSING_FOOTER_AND_LIGHTNING_COMPONENT - Errors with this extended error code have the following properties:
SCREEN_MISSING_LABEL - Errors with this extended error code have the following properties: characterLimit
SCREEN_MULTISELECTFIELD_DOESNT_SUPPORT_CHOICE_WITH_USERINPUT - Errors with this extended error code have the following properties: choiceName
SCREEN_PAUSEDTEXT_NOT_SHOWN_WHEN_ALLOWPAUSE_IS_FALSE - Errors with this extended error code have the following properties: fieldName
SETTING_FIELD_MAKES_OTHER_FIELD_REQUIRED - Errors with this extended error code have the following properties: fieldName, requiredField
SETTING_FIELD_MAKES_OTHER_FIELD_UNSUPPORTED - Errors with this extended error code have the following properties: fieldName, otherFieldName
SOBJECT_ELEMENT_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: fieldName, fieldValue
SOBJECT_ELEMENT_MISMATCHED_OBJECTTYPE - Errors with this extended error code have the following properties: objectType, sobjectName
SORT_ENCRYPTED_FIELDS_NOT_SUPPORTED - Errors with this extended error code have the following properties: fieldName, objectType
SORT_FIELD_MISSING - Errors with this extended error code have the following properties: sortOrder
SORT_FIELD_NOT_SUPPORTED - Errors with this extended error code have the following properties: fieldName, objectName
SORT_GEOLOCATION_FIELDS_NOT_SUPPORTED - Errors with this extended error code have the following properties: fieldName, objectName
SORT_LIMIT_INVALID - Errors with this extended error code have the following properties: maxLimit
SORT_ORDER_MISSING - Errors with this extended error code have the following properties: fieldName
SPECIFIC_FIELD_VALUE_MAKES_OTHER_FIELD_REQUIRED - Errors with this extended error code have the following properties: fieldName, fieldType, requiredField
START_ELEMENT_MISSING - Errors with this extended error code have the following properties:
SUBFLOW_DESKTOP_DESIGNER_FLOWS_NOT_SUPPORTED - Errors with this extended error code have the following properties: flowName
SUBFLOW_INPUT_ELEMENT_INCOMPATIBLE_DATATYPES - Errors with this extended error code have the following properties: subflowName, inputAssignmentNames
SUBFLOW_INPUT_INVALID_VALUE - Errors with this extended error code have the following properties: subflowName, inputAssignmentNames
SUBFLOW_INPUT_MISMATCHED_COLLECTIONTYPES - Errors with this extended error code have the following properties: subflowName, inputParameterNames
SUBFLOW_INPUT_MISMATCHED_OBJECTS - Errors with this extended error code have the following properties: subflowName, inputParameterNames
SUBFLOW_INPUT_MISSING_NAME - Errors with this extended error code have the following properties: subflowName
SUBFLOW_INPUT_MULTIPLE_ASSIGNMENTS_TO_ONE_VARIABLE - Errors with this extended error code have the following properties: inputVariableName
SUBFLOW_INPUT_REFERENCES_FIELD_ON_SOBJECT_VARIABLE - Errors with this extended error code have the following properties: inputVariableName
SUBFLOW_INPUT_VALUE_INCOMPATIBLE_DATATYPES - Errors with this extended error code have the following properties: subflowName, inputAssignmentNames
SUBFLOW_INPUT_VARIABLE_NOT_FOUND_IN_MASTERFLOW - Errors with this extended error code have the following properties: subflowName, inputAssignmentNames
SUBFLOW_INPUT_VARIABLE_NOT_FOUND_IN_REFERENCEDFLOW - Errors with this extended error code have the following properties: subflowName, inputAssignmentNames
SUBFLOW_INPUT_VARIABLE_NO_INPUT_ACCESS - Errors with this extended error code have the following properties: subflowName, inputAssignmentNames
SUBFLOW_INVALID_NAME - Errors with this extended error code have the following properties:
SUBFLOW_INVALID_REFERENCE - Errors with this extended error code have the following properties: flowName
SUBFLOW_MASTER_FLOW_TYPE_NOT_AUTOLAUNCHED - Errors with this extended error code have the following properties: parentFlowName
SUBFLOW_MISSING_NAME - Errors with this extended error code have the following properties:
SUBFLOW_NO_ACTIVE_VERSION - Errors with this extended error code have the following properties: subflowName, flowName
SUBFLOW_OUTPUT_INCOMPATIBLE_DATATYPES - Errors with this extended error code have the following properties: subflowName, flowVersion, outputParameterNames
SUBFLOW_OUTPUT_MISMATCHED_COLLECTIONTYPES - Errors with this extended error code have the following properties: subflowName, flowVersion, outputParameterNames
SUBFLOW_OUTPUT_MISMATCHED_OBJECTS - Errors with this extended error code have the following properties: subflowName, flowVersion, outputParameterNames
SUBFLOW_OUTPUT_MISSING_ASSIGNTOREFERENCE - Errors with this extended error code have the following properties: outputAssignment
SUBFLOW_OUTPUT_MISSING_NAME - Errors with this extended error code have the following properties: subflowName
SUBFLOW_OUTPUT_MULTIPLE_ASSIGNMENTS_TO_ONE_VARIABLE - Errors with this extended error code have the following properties: outputVariableName
SUBFLOW_OUTPUT_REFERENCES_FIELD_ON_SOBJECT_VARIABLE - Errors with this extended error code have the following properties: outputAssignment
SUBFLOW_OUTPUT_TARGET_DOES_NOT_EXIST_IN_MASTER_FLOW - Errors with this extended error code have the following properties: subflowName, outputAssignmentName
SUBFLOW_OUTPUT_VARIABLE_NOT_FOUND_IN_MASTERFLOW - Errors with this extended error code have the following properties: subflowName, variableName
SUBFLOW_OUTPUT_VARIABLE_NOT_FOUND_IN_REFERENCEDFLOW - Errors with this extended error code have the following properties: subflowName, flowVersion, outputParameterNames
SUBFLOW_OUTPUT_VARIABLE_NO_OUTPUT_ACCESS - Errors with this extended error code have the following properties: subflowName, variableName
SUBFLOW_REFERENCES_MASTERFLOW - Errors with this extended error code have the following properties:
SURVEY_CHOICE_NOT_REFERENCED_BY_A_QUESTION - Errors with this extended error code have the following properties: choiceName
SURVEY_CHOICE_REFERENCED_BY_MULTIPLE_QUESTIONS - Errors with this extended error code have the following properties: choiceName
SURVEY_INACTIVE_SUBFLOWS - Errors with this extended error code have the following properties: subflowName
SURVEY_MISSING_QUESTION_OR_SUBFLOW - Errors with this extended error code have the following properties: surveyName
SURVEY_MISSING_REQUIRED_VARIABLES - Errors with this extended error code have the following properties: surveyName
SURVEY_NESTED_SUBFLOWS - Errors with this extended error code have the following properties: subflowName
SURVEY_NONSURVEY_SUBFLOWS - Errors with this extended error code have the following properties: subflowName
SURVEY_SCREENFIELD_TYPE_NOT_SUPPORTED_FOR_QUESTION - Errors with this extended error code have the following properties: elementName
SURVEY_START_ELEMENT_INVALID - Errors with this extended error code have the following properties:
SURVEY_VARIABLE_ACCESS_INVALID - Errors with this extended error code have the following properties: surveyName
UNEXPECTED_ERROR - Errors with this extended error code have the following properties:
VALUE_CHAR_LIMIT_EXCEEDED - Errors with this extended error code have the following properties: elementName, characterLimit
VARIABLE_FIELD_NOT_SUPPORTED_FOR_DATATYPE - Errors with this extended error code have the following properties: fieldName, datatype
VARIABLE_FIELD_NOT_SUPPORTED_FOR_DATATYPE_AND_COLLECTION - Errors with this extended error code have the following properties: fieldName, datatype
VARIABLE_FIELD_REQUIRED_FOR_DATATYPE - Errors with this extended error code have the following properties: datatype, fieldName
VARIABLE_SCALE_EXCEEDS_LIMIT - Errors with this extended error code have the following properties: elementName
VARIABLE_SCALE_NEGATIVE_INTEGER - Errors with this extended error code have the following properties: elementName
VARIABLE_SCALE_NULL - Errors with this extended error code have the following properties: elementName
WAITEVENT_DEFAULT_CONNECTOR_MISSING_LABEL - Errors with this extended error code have the following properties: waitEventName
WAITEVENT_DUPLICATE_INPUT_PARAM - Errors with this extended error code have the following properties: parameterName
WAITEVENT_INPUT_NOT_SUPPORTED_FOR_EVENTTYPE - Errors with this extended error code have the following properties: waitEventName, inputParameterName
WAITEVENT_INPUT_REQUIRES_LITERAL_VALUE - Errors with this extended error code have the following properties: waitEventName, parameterName
WAITEVENT_INVALID_CONDITION_LOGIC - Errors with this extended error code have the following properties: waitEventName
WAITEVENT_MISSING - Errors with this extended error code have the following properties:
WAITEVENT_MISSING_CONNECTOR - Errors with this extended error code have the following properties: waitEventName
WAITEVENT_MISSING_EVENTTYPE - Errors with this extended error code have the following properties: waitEventName
WAITEVENT_OBJECT_NOT_SUPPORTED_FOR_EVENTTYPE - Errors with this extended error code have the following properties: waitEventName
WAITEVENT_OUTPUT_NOT_SUPPORTED_FOR_EVENTTYPE - Errors with this extended error code have the following properties: waitEventName, outputParameter
WAITEVENT_RELATIVEALARM_INVALID_DATETIME_FIELD - Errors with this extended error code have the following properties: waitEventName, eventParameterName, incompatibleValue
WAITEVENT_RELATIVEALARM_INVALID_FIELD - Errors with this extended error code have the following properties: waitEventName, eventParameterName, incompatibleValue
WAITEVENT_RELATIVEALARM_INVALID_OBJECTTYPE - Errors with this extended error code have the following properties: waitEventName, inputParameterName
WAITEVENT_RELATIVEALARM_INVALID_OFFSETNUMBER - Errors with this extended error code have the following properties: waitEventName, eventParameterName, incompatibleValue
WAITEVENT_RELATIVEALARM_INVALID_OFFSETUNIT - Errors with this extended error code have the following properties: waitEventName, eventParameterName, incompatibleValue
WAITEVENT_REQUIRED_INPUT_MISSING - Errors with this extended error code have the following properties: waitEventName, parameterName
WAITEVENT_TYPE_INVALID_OR_NOT_SUPPORTED - Errors with this extended error code have the following properties: waitEventName
WORKFLOW_MISSING_PROCESSMETADATAVALUES - Errors with this extended error code have the following properties: flowName
WORKFLOW_OBJECTTYPE_NOT_FOUND - Errors with this extended error code have the following properties: objectType
WORKFLOW_OBJECTTYPE_NOT_SUPPORTED - Errors with this extended error code have the following properties: objectType
WORKFLOW_OBJECTVARIABLE_AND_OLDOBJECTVARIABLE_REFERENCE_SAME_SOBJECT_VARIABLE - Errors with this extended error code have the following properties: objectVariableName, oldObjectVariableName
WORKFLOW_OBJECTVARIABLE_DOESNT_SUPPORT_INPUT - Errors with this extended error code have the following properties: objectType, objectVariableName
WORKFLOW_OLDOBJECTVARIABLE_DOESNT_SUPPORT_INPUT - Errors with this extended error code have the following properties: objectType, oldObjectVariableName
WORKFLOW_PROCESSMETADATAVALUES_MORE_THAN_ONE_NAME - Errors with this extended error code have the following properties: metadataValue
WORKFLOW_PROCESS_METADATAVALUES_MISSING_NAME - Errors with this extended error code have the following properties: metadataValue
WORKFLOW_RECURSIVECOUNTVARIABLE_DOESNT_SUPPORT_INPUT - Errors with this extended error code have the following properties: elementName
WORKFLOW_TRIGGERTYPE_INVALID_VALUE - Errors with this extended error code have the following properties:
ExternalDataSource
a character (inherited from Metadata)
a character
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a ExternalPrincipalType - which is a character taking one of the following values:
Anonymous
PerUser
NamedUser
a AuthenticationProtocol - which is a character taking one of the following values:
NoAuthentication
Oauth
Password
a character
a ExternalDataSourceType - which is a character taking one of the following values:
Datacloud
Datajourney
OpenSearch
Identity
outgoingemail
recommendation
SfdcOrg
OData
OData4
SimpleURL
Wrapper
a character
a character
ExternalServiceRegistration
a character (inherited from Metadata)
a character
a character
a character
a character
a character
a character
a character
FeedFilterCriterion
a FeedItemType - which is a character taking one of the following values:
TrackedChange
UserStatus
TextPost
AdvancedTextPost
LinkPost
ContentPost
PollPost
RypplePost
ProfileSkillPost
DashboardComponentSnapshot
ApprovalPost
CaseCommentPost
ReplyPost
EmailMessageEvent
CallLogPost
ChangeStatusPost
AttachArticleEvent
MilestoneEvent
ActivityEvent
ChatTranscriptPost
CollaborationGroupCreated
CollaborationGroupUnarchived
SocialPost
QuestionPost
FacebookPost
BasicTemplateFeedItem
CreateRecordEvent
CanvasPost
AnnouncementPost
a FeedItemVisibility - which is a character taking one of the following values:
AllUsers
InternalUsers
a character
FeedItemSettings
an integer
a character either 'true' or 'false'
a FeedItemDisplayFormat - which is a character taking one of the following values:
Default
HideBlankLines
a FeedItemType - which is a character taking one of the following values:
TrackedChange
UserStatus
TextPost
AdvancedTextPost
LinkPost
ContentPost
PollPost
RypplePost
ProfileSkillPost
DashboardComponentSnapshot
ApprovalPost
CaseCommentPost
ReplyPost
EmailMessageEvent
CallLogPost
ChangeStatusPost
AttachArticleEvent
MilestoneEvent
ActivityEvent
ChatTranscriptPost
CollaborationGroupCreated
CollaborationGroupUnarchived
SocialPost
QuestionPost
FacebookPost
BasicTemplateFeedItem
CreateRecordEvent
CanvasPost
AnnouncementPost
FeedLayout
a character either 'true' or 'false'
a character either 'true' or 'false'
a FeedLayoutFilterPosition - which is a character taking one of the following values:
CenterDropDown
LeftFixed
LeftFloat
a FeedLayoutFilter
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a FeedLayoutComponent
a FeedLayoutComponent
a character either 'true' or 'false'
FeedLayoutComponent
a FeedLayoutComponentType - which is a character taking one of the following values:
HelpAndToolLinks
CustomButtons
Following
Followers
CustomLinks
Milestones
Topics
CaseUnifiedFiles
Visualforce
an integer
a character
FeedLayoutFilter
a character
a FeedLayoutFilterType - which is a character taking one of the following values:
AllUpdates
FeedItemType
Custom
a FeedItemType - which is a character taking one of the following values:
TrackedChange
UserStatus
TextPost
AdvancedTextPost
LinkPost
ContentPost
PollPost
RypplePost
ProfileSkillPost
DashboardComponentSnapshot
ApprovalPost
CaseCommentPost
ReplyPost
EmailMessageEvent
CallLogPost
ChangeStatusPost
AttachArticleEvent
MilestoneEvent
ActivityEvent
ChatTranscriptPost
CollaborationGroupCreated
CollaborationGroupUnarchived
SocialPost
QuestionPost
FacebookPost
BasicTemplateFeedItem
CreateRecordEvent
CanvasPost
AnnouncementPost
FieldMapping
a character
a character
a FieldMappingRow
a character
FieldMappingField
a character
a character
an integer
FieldMappingRow
a character
a FieldMappingField
a character
a MappingOperation - which is a character taking one of the following values:
Autofill
Overwrite
FieldOverride
a character
a character
a character
FieldServiceSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
an integer
a character
a character
FieldSet
a character (inherited from Metadata)
a FieldSetItem
a character
a FieldSetItem
a character
FieldSetItem
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
FieldSetTranslation
a character
a character
FieldValue
a character
a character that appears similar to any of the other accepted types (integer, numeric, date, datetime, boolean)
FileProperties
a character
a character
a character formatted as 'yyyy-mm-ddThh:mm:ssZ'
a character
a character
a character
a character
a character
a character formatted as 'yyyy-mm-ddThh:mm:ssZ'
a ManageableState - which is a character taking one of the following values:
released
deleted
deprecated
installed
beta
unmanaged
a character
a character
FileTypeDispositionAssignmentBean
a FileDownloadBehavior - which is a character taking one of the following values:
DOWNLOAD
EXECUTE_IN_BROWSER
HYBRID
a FileType - which is a character taking one of the following values:
UNKNOWN
POWER_POINT
POWER_POINT_X
POWER_POINT_M
POWER_POINT_T
WORD
WORD_X
WORD_M
WORD_T
PPS
PPSX
EXCEL
EXCEL_X
EXCEL_M
EXCEL_T
GOOGLE_DOCUMENT
GOOGLE_PRESENTATION
GOOGLE_SPREADSHEET
GOOGLE_DRAWING
GOOGLE_FORM
GOOGLE_SCRIPT
LINK
SLIDE
AAC
ACGI
AI
AVI
BMP
BOXNOTE
CSV
EPS
EXE
FLASH
GIF
GZIP
HTM
HTML
HTX
JPEG
JPE
PJP
PJPEG
JFIF
JPG
JS
MHTM
MHTML
MP3
M4A
M4V
MP4
MPEG
MPG
MOV
MSG
ODP
ODS
ODT
OGV
PNG
PSD
RTF
QUIPDOC
QUIPSHEET
SHTM
SHTML
SNOTE
STYPI
SVG
SVGZ
TEXT
THTML
VISIO
WMV
WRF
XML
ZIP
XZIP
WMA
XSN
TRTF
TXML
WEBVIEW
RFC822
ASF
DWG
JAR
XJS
OPX
XPSD
TIF
TIFF
WAV
CSS
THUMB720BY480
THUMB240BY180
THUMB120BY90
ALLTHUMBS
PAGED_FLASH
PACK
C
CPP
WORDT
INI
JAVA
LOG
POWER_POINTT
SQL
XHTML
EXCELT
a character either 'true' or 'false'
FileUploadAndDownloadSecuritySettings
a character (inherited from Metadata)
a FileTypeDispositionAssignmentBean
a character either 'true' or 'false'
FilterItem
a character
a FilterOperation - which is a character taking one of the following values:
equals
notEqual
lessThan
greaterThan
lessOrEqual
greaterOrEqual
contains
notContain
startsWith
includes
excludes
within
a character
a character
FindSimilarOppFilter
a character
a character
FiscalYearSettings
a character
a character
FlexiPage
a character (inherited from Metadata)
a character
a FlexiPageRegion
a character
a character
a PlatformActionList
a QuickActionList
a character
a FlexiPageTemplateInstance
a FlexiPageType - which is a character taking one of the following values:
AppPage
ObjectPage
RecordPage
HomePage
MailAppAppPage
CommAppPage
CommForgotPasswordPage
CommLoginPage
CommObjectPage
CommQuickActionCreatePage
CommRecordPage
CommRelatedListPage
CommSearchResultPage
CommGlobalSearchResultPage
CommSelfRegisterPage
CommThemeLayoutPage
UtilityBar
RecordPreview
FlexiPageRegion
a RegionFlagStatus - which is a character taking one of the following values:
disabled
enabled
a ComponentInstance
a FlexiPageRegionMode - which is a character taking one of the following values:
Append
Prepend
Replace
a character
a RegionFlagStatus - which is a character taking one of the following values:
disabled
enabled
a RegionFlagStatus - which is a character taking one of the following values:
disabled
enabled
a FlexiPageRegionType - which is a character taking one of the following values:
Region
Facet
FlexiPageTemplateInstance
a character
a ComponentInstanceProperty
Flow
a character (inherited from Metadata)
a FlowActionCall
a FlowApexPluginCall
a FlowAssignment
a FlowChoice
a FlowConstant
a FlowDecision
a character
a FlowDynamicChoiceSet
a FlowFormula
a character
a character
a FlowLoop
a FlowMetadataValue
a FlowProcessType - which is a character taking one of the following values:
AutoLaunchedFlow
Flow
Workflow
CustomEvent
InvocableProcess
LoginFlow
ActionPlan
JourneyBuilderIntegration
UserProvisioningFlow
Survey
FieldServiceMobile
OrchestrationFlow
FieldServiceWeb
TransactionSecurityFlow
a FlowRecordCreate
a FlowRecordDelete
a FlowRecordLookup
a FlowRecordUpdate
a FlowScreen
a FlowStage
a character
a FlowStep
a FlowSubflow
a FlowTextTemplate
a FlowVariable
a FlowWait
FlowActionCall
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a character
a InvocableActionType - which is a character taking one of the following values:
apex
chatterPost
contentWorkspaceEnableFolders
emailAlert
emailSimple
flow
metricRefresh
quickAction
submit
thanks
thunderResponse
createServiceReport
deployOrchestration
createResponseEventAction
generateWorkOrders
deactivateSessionPermSet
activateSessionPermSet
aggregateValue
orchestrationTimer
orchestrationDebugLog
choosePricebook
localAction
a FlowConnector
a FlowConnector
a FlowActionCallInputParameter
a FlowActionCallOutputParameter
FlowActionCallInputParameter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowElementReferenceOrValue
FlowActionCallOutputParameter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a character
FlowApexPluginCall
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a character
a FlowConnector
a FlowConnector
a FlowApexPluginCallInputParameter
a FlowApexPluginCallOutputParameter
FlowApexPluginCallInputParameter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowElementReferenceOrValue
FlowApexPluginCallOutputParameter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a character
FlowAssignment
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a FlowAssignmentItem
a FlowConnector
FlowAssignmentItem
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowAssignmentOperator - which is a character taking one of the following values:
Assign
Add
Subtract
AddItem
a FlowElementReferenceOrValue
FlowBaseElement
a FlowMetadataValue
FlowCategory
a character (inherited from Metadata)
a character
a FlowCategoryItems
a character
FlowCategoryItems
a character
FlowChoice
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a character
a FlowDataType - which is a character taking one of the following values:
Currency
Date
Number
String
Boolean
SObject
DateTime
Picklist
Multipicklist
a FlowChoiceUserInput
a FlowElementReferenceOrValue
FlowChoiceTranslation
a character
a character
a FlowChoiceUserInputTranslation
FlowChoiceUserInput
a FlowMetadataValue (inherited from FlowBaseElement)
a character either 'true' or 'false'
a character
a FlowInputValidationRule
FlowChoiceUserInputTranslation
a character
a FlowInputValidationRuleTranslation
FlowCondition
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowComparisonOperator - which is a character taking one of the following values:
EqualTo
NotEqualTo
GreaterThan
LessThan
GreaterThanOrEqualTo
LessThanOrEqualTo
StartsWith
EndsWith
Contains
IsNull
WasSet
WasSelected
WasVisited
a FlowElementReferenceOrValue
FlowConnector
a FlowMetadataValue (inherited from FlowBaseElement)
a character
FlowConstant
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a FlowDataType - which is a character taking one of the following values:
Currency
Date
Number
String
Boolean
SObject
DateTime
Picklist
Multipicklist
a FlowElementReferenceOrValue
FlowDecision
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a FlowConnector
a character
a FlowRule
FlowDefinition
a character (inherited from Metadata)
an integer
a character
a character
FlowDefinitionTranslation
a FlowTranslation
a character
a character
FlowDynamicChoiceSet
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a FlowDataType - which is a character taking one of the following values:
Currency
Date
Number
String
Boolean
SObject
DateTime
Picklist
Multipicklist
a character
a FlowRecordFilter
an integer
a character
a FlowOutputFieldAssignment
a character
a character
a character
a SortOrder - which is a character taking one of the following values:
Asc
Desc
a character
FlowElement
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a character
FlowElementReferenceOrValue
a character either 'true' or 'false'
a character formatted as 'yyyy-mm-ddThh:mm:ssZ'
a character formatted as 'yyyy-mm-dd'
a character
a numeric
a character
FlowFormula
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a FlowDataType - which is a character taking one of the following values:
Currency
Date
Number
String
Boolean
SObject
DateTime
Picklist
Multipicklist
a character
an integer
FlowInputFieldAssignment
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowElementReferenceOrValue
FlowInputValidationRule
a character
a character
FlowInputValidationRuleTranslation
a character
FlowLoop
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a character
a character
a IterationOrder - which is a character taking one of the following values:
Asc
Desc
a FlowConnector
a FlowConnector
FlowMetadataValue
a character
a FlowElementReferenceOrValue
FlowNode
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a character
an integer
an integer
FlowOutputFieldAssignment
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a character
FlowRecordCreate
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a character
a FlowConnector
a FlowConnector
a FlowInputFieldAssignment
a character
a character
FlowRecordDelete
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a FlowConnector
a FlowConnector
a FlowRecordFilter
a character
a character
FlowRecordFilter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowRecordFilterOperator - which is a character taking one of the following values:
EqualTo
NotEqualTo
GreaterThan
LessThan
GreaterThanOrEqualTo
LessThanOrEqualTo
StartsWith
EndsWith
Contains
IsNull
a FlowElementReferenceOrValue
FlowRecordLookup
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a character either 'true' or 'false'
a FlowConnector
a FlowConnector
a FlowRecordFilter
a character
a FlowOutputFieldAssignment
a character
a character
a character
a SortOrder - which is a character taking one of the following values:
Asc
Desc
FlowRecordUpdate
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a FlowConnector
a FlowConnector
a FlowRecordFilter
a FlowInputFieldAssignment
a character
a character
FlowRule
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a character
a FlowCondition
a FlowConnector
a character
FlowScreen
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a FlowConnector
a FlowScreenField
a character
a character
a FlowScreenRule
a character either 'true' or 'false'
a character either 'true' or 'false'
FlowScreenField
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a character
a FlowDataType - which is a character taking one of the following values:
Currency
Date
Number
String
Boolean
SObject
DateTime
Picklist
Multipicklist
a character
a FlowElementReferenceOrValue
a character
a character
a FlowScreenFieldType - which is a character taking one of the following values:
DisplayText
InputField
LargeTextArea
PasswordField
RadioButtons
DropdownBox
MultiSelectCheckboxes
MultiSelectPicklist
ComponentInstance
a character
a FlowScreenFieldInputParameter
a character either 'true' or 'false'
a character either 'true' or 'false'
a FlowScreenFieldOutputParameter
an integer
a FlowInputValidationRule
FlowScreenFieldInputParameter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowElementReferenceOrValue
FlowScreenFieldOutputParameter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a character
FlowScreenFieldTranslation
a character
a character
a character
a FlowInputValidationRuleTranslation
FlowScreenRule
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowCondition
a character
a FlowScreenRuleAction
FlowScreenRuleAction
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a character
a FlowElementReferenceOrValue
FlowScreenTranslation
a FlowScreenFieldTranslation
a character
a character
a character
FlowStage
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a character either 'true' or 'false'
a character
an integer
FlowStep
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a FlowConnector
FlowSubflow
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a FlowConnector
a character
a FlowSubflowInputAssignment
a FlowSubflowOutputAssignment
FlowSubflowInputAssignment
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowElementReferenceOrValue
FlowSubflowOutputAssignment
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a character
FlowTextTemplate
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a character
FlowTranslation
a FlowChoiceTranslation
a character
a character
a FlowScreenTranslation
FlowVariable
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a FlowDataType - which is a character taking one of the following values:
Currency
Date
Number
String
Boolean
SObject
DateTime
Picklist
Multipicklist
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
an integer
a FlowElementReferenceOrValue
FlowWait
a character (inherited from FlowNode)
an integer (inherited from FlowNode)
an integer (inherited from FlowNode)
a FlowConnector
a character
a FlowConnector
a FlowWaitEvent
FlowWaitEvent
a character (inherited from FlowElement)
a character (inherited from FlowElement)
a character
a FlowCondition
a FlowConnector
a character
a FlowWaitEventInputParameter
a character
a FlowWaitEventOutputParameter
FlowWaitEventInputParameter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a FlowElementReferenceOrValue
FlowWaitEventOutputParameter
a FlowMetadataValue (inherited from FlowBaseElement)
a character
a character
Folder
a character (inherited from Metadata)
a FolderAccessTypes - which is a character taking one of the following values:
Shared
Public
Hidden
PublicInternal
a FolderShare
a character
a PublicFolderAccess - which is a character taking one of the following values:
ReadOnly
ReadWrite
a SharedTo
FolderShare
a FolderShareAccessLevel - which is a character taking one of the following values:
View
EditAllContents
Manage
a character
a FolderSharedToType - which is a character taking one of the following values:
Group
Role
RoleAndSubordinates
RoleAndSubordinatesInternal
Manager
ManagerAndSubordinatesInternal
Organization
Territory
TerritoryAndSubordinates
AllPrmUsers
User
PartnerUser
AllCspUsers
CustomerPortalUser
PortalRole
PortalRoleAndSubordinates
ChannelProgramGroup
ForecastingCategoryMapping
a character
a WeightedSourceCategory
ForecastingDisplayedFamilySettings
a character
ForecastingSettings
a character (inherited from Metadata)
a DisplayCurrency - which is a character taking one of the following values:
CORPORATE
PERSONAL
a character either 'true' or 'false'
a ForecastingCategoryMapping
a ForecastingDisplayedFamilySettings
a ForecastingTypeSettings
ForecastingTypeSettings
a character either 'true' or 'false'
a AdjustmentsSettings
a character
a ForecastRangeSettings
a character
a ForecastingDateType - which is a character taking one of the following values:
OpportunityCloseDate
ProductDate
ScheduleDate
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a OpportunityListFieldsLabelMapping
a OpportunityListFieldsSelectedSettings
a OpportunityListFieldsUnselectedSettings
a character
a character
a QuotasSettings
a character
ForecastRangeSettings
an integer
an integer
a PeriodTypes - which is a character taking one of the following values:
Month
Quarter
Week
Year
GlobalPicklistValue
a character (inherited from Metadata)
a character
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
GlobalQuickActionTranslation
a character
a character
GlobalValueSet
a character (inherited from Metadata)
a CustomValue
a character
a character
a character either 'true' or 'false'
GlobalValueSetTranslation
a character (inherited from Metadata)
a ValueTranslation
Group
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
HistoryRetentionPolicy
an integer
an integer
a character
Holiday
a character formatted as 'yyyy-mm-dd'
a character
a character
a character formatted as 'hh:mm:ssZ
a character either 'true' or 'false'
a character
an integer
a character
an integer
a character formatted as 'yyyy-mm-dd'
a character
an integer
a character
a character formatted as 'yyyy-mm-dd'
a character
a character formatted as 'hh:mm:ssZ
HomePageComponent
a character (inherited from Metadata)
a character
an integer
a character
a character
a PageComponentType - which is a character taking one of the following values:
links
htmlArea
imageOrNote
visualforcePage
a character either 'true' or 'false'
a character either 'true' or 'false'
a PageComponentWidth - which is a character taking one of the following values:
narrow
wide
HomePageLayout
a character (inherited from Metadata)
a character
a character
IdeaReputationLevel
a character
an integer
IdeasSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a numeric
a character
Index
a character (inherited from Metadata)
a IndexField
a character
IndexField
a character
a character
InsightType
a character (inherited from Metadata)
a InsightTrendType - which is a character taking one of the following values:
Positive
Negative
Informational
Suggestion
a character
a character either 'true' or 'false'
a character
a InsightParentType - which is a character taking one of the following values:
Opportunity
Account
a character
InstalledPackage
a character (inherited from Metadata)
a character
a character
IntegrationHubSettings
a character (inherited from Metadata)
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a character
a character
an integer
an integer
an integer
IntegrationHubSettingsType
a character (inherited from Metadata)
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a character
a character
an integer
an integer
an integer
IpRange
a character
a character
a character
KeyboardShortcuts
a CustomShortcut
a DefaultShortcut
Keyword
a character
KeywordList
a character (inherited from Metadata)
a character
a Keyword
a character
KnowledgeAnswerSettings
a character
a character
a character either 'true' or 'false'
KnowledgeCaseField
a character
KnowledgeCaseFieldsSettings
a KnowledgeCaseField
KnowledgeCaseSettings
a character
a KnowledgeCommunitiesSettings
a KnowledgeSitesSettings
a KnowledgeSitesSettings
a character
a character
a character
a KnowledgeCaseEditor - which is a character taking one of the following values:
simple
standard
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
KnowledgeCommunitiesSettings
a character
KnowledgeLanguage
a character either 'true' or 'false'
a character
a KnowledgeLanguageLookupValueType - which is a character taking one of the following values:
User
Queue
a character
a KnowledgeLanguageLookupValueType - which is a character taking one of the following values:
User
Queue
a character
KnowledgeLanguageSettings
a KnowledgeLanguage
KnowledgeSettings
a character (inherited from Metadata)
a KnowledgeAnswerSettings
a KnowledgeCaseSettings
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a KnowledgeLanguageSettings
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a KnowledgeSuggestedArticlesSettings
KnowledgeSitesSettings
a character
KnowledgeSuggestedArticlesSettings
a KnowledgeCaseFieldsSettings
a character either 'true' or 'false'
a KnowledgeWorkOrderFieldsSettings
a KnowledgeWorkOrderLineItemFieldsSettings
KnowledgeWorkOrderField
a character
KnowledgeWorkOrderFieldsSettings
a KnowledgeWorkOrderField
KnowledgeWorkOrderLineItemField
a character
KnowledgeWorkOrderLineItemFieldsSettings
a KnowledgeWorkOrderLineItemField
Layout
a character (inherited from Metadata)
a character
a CustomConsoleComponents
a character either 'true' or 'false'
a character
a FeedLayout
a LayoutHeader - which is a character taking one of the following values:
PersonalTagging
PublicTagging
a LayoutSection
a MiniLayout
a character
a PlatformActionList
a QuickActionList
a RelatedContent
a RelatedListItem
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a SummaryLayout
LayoutColumn
a LayoutItem
a character
LayoutItem
a AnalyticsCloudComponentLayoutItem
a UiBehavior - which is a character taking one of the following values:
Edit
Required
Readonly
a character
a character
a character
a character either 'true' or 'false'
a character
an integer
a character
a ReportChartComponentLayoutItem
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
LayoutSection
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a LayoutColumn
a LayoutSectionStyle - which is a character taking one of the following values:
TwoColumnsTopToBottom
TwoColumnsLeftToRight
OneColumn
CustomLinks
LayoutSectionTranslation
a character
a character
LayoutTranslation
a character
a character
a LayoutSectionTranslation
LeadConvertSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a ObjectMapping
a VisibleOrRequired - which is a character taking one of the following values:
VisibleOptional
VisibleRequired
NotVisible
Letterhead
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a LetterheadLine
a character
a LetterheadHeaderFooter
a LetterheadHeaderFooter
a LetterheadLine
a character
a LetterheadLine
LetterheadHeaderFooter
a character
an integer
a LetterheadHorizontalAlignment - which is a character taking one of the following values:
None
Left
Center
Right
a character
a LetterheadVerticalAlignment - which is a character taking one of the following values:
None
Top
Middle
Bottom
LetterheadLine
a character
an integer
LicensedCustomPermissions
a character
a character
LicenseDefinition
a character (inherited from Metadata)
a character
a character
a character either 'true' or 'false'
a character
a LicensedCustomPermissions
a character
a character
an integer
a character
an integer
an integer
an integer
LightningBolt
a character (inherited from Metadata)
a LightningBoltCategory - which is a character taking one of the following values:
IT
Marketing
Sales
Service
a LightningBoltFeatures
a LightningBoltImages
a LightningBoltItems
a character
a character
a character
LightningBoltFeatures
a character
an integer
a character
LightningBoltImages
a character
an integer
LightningBoltItems
a character
a character
LightningComponentBundle
a character (inherited from Metadata)
a numeric
a character either 'true' or 'false'
LightningExperienceTheme
a character (inherited from Metadata)
a character
a character
a character
a character either 'true' or 'false'
ListMetadataQuery
a character
a character
ListPlacement
an integer
a character
a character
an integer
ListView
a character (inherited from Metadata)
a character
a character
a character
a FilterScope - which is a character taking one of the following values:
Everything
Mine
Queue
Delegated
MyTerritory
MyTeamTerritory
Team
AssignedToMe
a ListViewFilter
a character
a Language - which is a character taking one of the following values:
en_US
de
es
fr
it
ja
sv
ko
zh_TW
zh_CN
pt_BR
nl_NL
da
th
fi
ru
es_MX
no
hu
pl
cs
tr
in
ro
vi
uk
iw
el
bg
en_GB
ar
sk
pt_PT
hr
sl
fr_CA
ka
sr
sh
en_AU
en_MY
en_IN
en_PH
en_CA
ro_MD
bs
mk
lv
lt
et
sq
sh_ME
mt
ga
eu
cy
is
ms
tl
lb
rm
hy
hi
ur
bn
de_AT
de_CH
ta
ar_DZ
ar_BH
ar_EG
ar_IQ
ar_JO
ar_KW
ar_LB
ar_LY
ar_MA
ar_OM
ar_QA
ar_SA
ar_SD
ar_SY
ar_TN
ar_AE
ar_YE
zh_SG
zh_HK
en_HK
en_IE
en_SG
en_ZA
fr_BE
fr_LU
fr_CH
de_BE
de_LU
it_CH
nl_BE
es_AR
es_BO
es_CL
es_CO
es_CR
es_DO
es_EC
es_SV
es_GT
es_HN
es_NI
es_PA
es_PY
es_PE
es_PR
es_US
es_UY
es_VE
ca
eo
iw_EO
a character
a SharedTo
ListViewFilter
a character
a FilterOperation - which is a character taking one of the following values:
equals
notEqual
lessThan
greaterThan
lessOrEqual
greaterOrEqual
contains
notContain
startsWith
includes
excludes
within
a character
LiveAgentConfig
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
LiveAgentSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
LiveChatAgentConfig
a character (inherited from Metadata)
a AgentConfigAssignments
a character
an integer
an integer
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a SupervisorAgentStatusFilter - which is a character taking one of the following values:
Online
Away
Offline
a character
a character
a SupervisorAgentConfigSkills
a AgentConfigButtons
a AgentConfigSkills
LiveChatButton
a character (inherited from Metadata)
a LiveChatButtonPresentation - which is a character taking one of the following values:
Slide
Fade
Appear
Custom
a character
an integer
an integer
a character
a character
a LiveChatButtonDeployments
a character either 'true' or 'false'
a LiveChatButtonInviteEndPosition - which is a character taking one of the following values:
TopLeft
Top
TopRight
Left
Center
Right
BottomLeft
Bottom
BottomRight
a character
a LiveChatButtonInviteStartPosition - which is a character taking one of the following values:
TopLeft
TopLeftTop
Top
TopRightTop
TopRight
TopRightRight
Right
BottomRightRight
BottomRight
BottomRightBottom
Bottom
BottomLeftBottom
BottomLeft
BottomLeftLeft
Left
TopLeftLeft
a character either 'true' or 'false'
a character
an integer
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
an integer
an integer
a character
a character
a character
a character
an integer
a LiveChatButtonRoutingType - which is a character taking one of the following values:
Choice
LeastActive
MostAvailable
a character
a LiveChatButtonSkills
an integer
a LiveChatButtonType - which is a character taking one of the following values:
Standard
Invite
a Language - which is a character taking one of the following values:
en_US
de
es
fr
it
ja
sv
ko
zh_TW
zh_CN
pt_BR
nl_NL
da
th
fi
ru
es_MX
no
hu
pl
cs
tr
in
ro
vi
uk
iw
el
bg
en_GB
ar
sk
pt_PT
hr
sl
fr_CA
ka
sr
sh
en_AU
en_MY
en_IN
en_PH
en_CA
ro_MD
bs
mk
lv
lt
et
sq
sh_ME
mt
ga
eu
cy
is
ms
tl
lb
rm
hy
hi
ur
bn
de_AT
de_CH
ta
ar_DZ
ar_BH
ar_EG
ar_IQ
ar_JO
ar_KW
ar_LB
ar_LY
ar_MA
ar_OM
ar_QA
ar_SA
ar_SD
ar_SY
ar_TN
ar_AE
ar_YE
zh_SG
zh_HK
en_HK
en_IE
en_SG
en_ZA
fr_BE
fr_LU
fr_CH
de_BE
de_LU
it_CH
nl_BE
es_AR
es_BO
es_CL
es_CO
es_CR
es_DO
es_EC
es_SV
es_GT
es_HN
es_NI
es_PA
es_PY
es_PE
es_PR
es_US
es_UY
es_VE
ca
eo
iw_EO
LiveChatButtonDeployments
a character
LiveChatButtonSkills
a character
LiveChatDeployment
a character (inherited from Metadata)
a character
an integer
an integer
a character either 'true' or 'false'
a LiveChatDeploymentDomainWhitelist
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a character
LiveChatDeploymentDomainWhitelist
a character
LiveChatSensitiveDataRule
a character (inherited from Metadata)
a SensitiveDataActionType - which is a character taking one of the following values:
Remove
Replace
a character
an integer
a character either 'true' or 'false'
a character
a character
LiveMessageSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
LogInfo
a LogCategory - which is a character taking one of the following values:
Db
Workflow
Validation
Callout
Apex_code
Apex_profiling
Visualforce
System
Wave
All
a LogCategoryLevel - which is a character taking one of the following values:
None
Finest
Finer
Fine
Debug
Info
Warn
Error
LookupFilter
a character either 'true' or 'false'
a character
a character
a character
a FilterItem
a character
a character either 'true' or 'false'
LookupFilterTranslation
a character
a character
MacroSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
ManagedTopic
a character (inherited from Metadata)
a character
a character
a character
an integer
a character
ManagedTopics
a character (inherited from Metadata)
a ManagedTopic
MarketingActionSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
MarketingResourceType
a character (inherited from Metadata)
a character
a character
a character
a character
MatchingRule
a character (inherited from Metadata)
a character
a character
a character
a MatchingRuleItem
a MatchingRuleStatus - which is a character taking one of the following values:
Inactive
DeactivationFailed
Activating
Deactivating
Active
ActivationFailed
MatchingRuleItem
a BlankValueBehavior - which is a character taking one of the following values:
MatchBlanks
NullNotAllowed
a character
a MatchingMethod - which is a character taking one of the following values:
Exact
FirstName
LastName
CompanyName
Phone
City
Street
Zip
Title
MatchingRules
a character (inherited from Metadata)
a MatchingRule
Metadata
a character
MetadataWithContent
a character (inherited from Metadata)
a character formed using base64encode
MilestoneType
a character (inherited from Metadata)
a character
a MilestoneTypeRecurrenceType - which is a character taking one of the following values:
none
recursIndependently
recursChained
MiniLayout
a character
a RelatedListItem
MobileSettings
a character (inherited from Metadata)
a ChatterMobileSettings
a DashboardMobileSettings
a SFDCMobileSettings
a TouchMobileSettings
ModeratedEntityField
a character
a character
a character
ModerationRule
a character (inherited from Metadata)
a ModerationRuleAction - which is a character taking one of the following values:
Block
FreezeAndNotify
Review
Replace
Flag
an integer
a character either 'true' or 'false'
a character
a ModeratedEntityField
a character
an integer
a RateLimitTimePeriod - which is a character taking one of the following values:
Short
Medium
a ModerationRuleType - which is a character taking one of the following values:
Content
Rate
a character
a character
NamedCredential
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a ExternalPrincipalType - which is a character taking one of the following values:
Anonymous
PerUser
NamedUser
a AuthenticationProtocol - which is a character taking one of the following values:
NoAuthentication
Oauth
Password
a character
NameSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
NavigationLinkSet
a NavigationMenuItem
NavigationMenuItem
a character
a character
an integer
a character either 'true' or 'false'
a NavigationSubMenu
a character
a character
a character
NavigationSubMenu
a NavigationMenuItem
Network
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a CommunityRoles
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character
an integer
a NavigationLinkSet
a NetworkMemberGroup
a NetworkPageOverride
a character
a character
a RecommendationAudience
a RecommendationDefinition
a ReputationLevelDefinitions
a ReputationPointsRules
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a NetworkStatus - which is a character taking one of the following values:
UnderConstruction
Live
DownForMaintenance
a NetworkTabSet
a character
a character
NetworkAccess
a IpRange
NetworkBranding
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
NetworkMemberGroup
a character
a character
NetworkPageOverride
a NetworkPageOverrideSetting - which is a character taking one of the following values:
Designer
VisualForce
Standard
a NetworkPageOverrideSetting - which is a character taking one of the following values:
Designer
VisualForce
Standard
a NetworkPageOverrideSetting - which is a character taking one of the following values:
Designer
VisualForce
Standard
a NetworkPageOverrideSetting - which is a character taking one of the following values:
Designer
VisualForce
Standard
a NetworkPageOverrideSetting - which is a character taking one of the following values:
Designer
VisualForce
Standard
NetworkTabSet
a character
a character
a character
NextAutomatedApprover
a character either 'true' or 'false'
a character
ObjectMapping
a character
a ObjectMappingField
a character
ObjectMappingField
a character
a character
ObjectNameCaseValue
a Article - which is a character taking one of the following values:
None
Indefinite
Definite
a CaseType - which is a character taking one of the following values:
Nominative
Accusative
Genitive
Dative
Inessive
Elative
Illative
Adessive
Ablative
Allative
Essive
Translative
Partitive
Objective
Subjective
Instrumental
Prepositional
Locative
Vocative
Sublative
Superessive
Delative
Causalfinal
Essiveformal
Termanative
Distributive
Ergative
Adverbial
Abessive
Comitative
a character either 'true' or 'false'
a Possessive - which is a character taking one of the following values:
None
First
Second
a character
ObjectRelationship
a ObjectRelationship
a character either 'true' or 'false'
a character
ObjectSearchSetting
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
an integer
ObjectUsage
a character
OpportunityListFieldsLabelMapping
a character
a character
OpportunityListFieldsSelectedSettings
a character
OpportunityListFieldsUnselectedSettings
a character
OpportunitySettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a FindSimilarOppFilter
a character either 'true' or 'false'
Orchestration
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a character
OrchestrationContext
a character (inherited from Metadata)
a character
a OrchestrationContextEvent
a character
a character
a character
a character
OrchestrationContextEvent
a character
a character
a character
a character
OrderSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
OrganizationSettingsDetail
a character
a character either 'true' or 'false'
OrgPreferenceSettings
a character (inherited from Metadata)
a OrganizationSettingsDetail
Package
a character (inherited from Metadata)
a APIAccessLevel - which is a character taking one of the following values:
Unrestricted
Restricted
a character
a character
a ProfileObjectPermissions
a character
a character
a character
a PackageTypeMembers
a character
a character
PackageTypeMembers
a character
a character
PackageVersion
an integer
an integer
a character
PasswordPolicies
a character
a Complexity - which is a character taking one of the following values:
NoRestriction
AlphaNumeric
SpecialCharacters
UpperLowerCaseNumeric
UpperLowerCaseNumericSpecialCharacters
a Expiration - which is a character taking one of the following values:
ThirtyDays
SixtyDays
NinetyDays
SixMonths
OneYear
Never
a character
a LockoutInterval - which is a character taking one of the following values:
FifteenMinutes
ThirtyMinutes
SixtyMinutes
Forever
a MaxLoginAttempts - which is a character taking one of the following values:
ThreeAttempts
FiveAttempts
TenAttempts
NoLimit
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a QuestionRestriction - which is a character taking one of the following values:
None
DoesNotContainPassword
PathAssistant
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a character
a PathAssistantStep
a character
PathAssistantSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
PathAssistantStep
a character
a character
a character
PermissionSet
a character (inherited from Metadata)
a PermissionSetApplicationVisibility
a PermissionSetApexClassAccess
a PermissionSetCustomPermissions
a character
a PermissionSetExternalDataSourceAccess
a PermissionSetFieldPermissions
a character either 'true' or 'false'
a character
a character
a PermissionSetObjectPermissions
a PermissionSetApexPageAccess
a PermissionSetRecordTypeVisibility
a PermissionSetTabSetting
a PermissionSetUserPermission
PermissionSetApexClassAccess
a character
a character either 'true' or 'false'
PermissionSetApexPageAccess
a character
a character either 'true' or 'false'
PermissionSetApplicationVisibility
a character
a character either 'true' or 'false'
PermissionSetCustomPermissions
a character either 'true' or 'false'
a character
PermissionSetExternalDataSourceAccess
a character either 'true' or 'false'
a character
PermissionSetFieldPermissions
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
PermissionSetGroup
a character (inherited from Metadata)
a character
a character either 'true' or 'false'
a character
a character
PermissionSetObjectPermissions
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
PermissionSetRecordTypeVisibility
a character
a character either 'true' or 'false'
PermissionSetTabSetting
a character
a PermissionSetTabVisibility - which is a character taking one of the following values:
None
Available
Visible
PermissionSetUserPermission
a character either 'true' or 'false'
a character
PersonalJourneySettings
a character (inherited from Metadata)
a character either 'true' or 'false'
PersonListSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
PicklistEntry
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
PicklistValue
a character (inherited from GlobalPicklistValue)
a character either 'true' or 'false' (inherited from GlobalPicklistValue)
a character (inherited from GlobalPicklistValue)
a character either 'true' or 'false' (inherited from GlobalPicklistValue)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a ForecastCategories - which is a character taking one of the following values:
Omitted
Pipeline
BestCase
Forecast
Closed
a character either 'true' or 'false'
an integer
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
PicklistValueTranslation
a character
a character
PlatformActionList
a character (inherited from Metadata)
a PlatformActionListContext - which is a character taking one of the following values:
ListView
RelatedList
ListViewRecord
RelatedListRecord
Record
FeedElement
Chatter
Global
Flexipage
MruList
MruRow
RecordEdit
Photo
BannerPhoto
ObjectHomeChart
ListViewDefinition
Dockable
Lookup
Assistant
a PlatformActionListItem
a character
PlatformActionListItem
a character
a PlatformActionType - which is a character taking one of the following values:
QuickAction
StandardButton
CustomButton
ProductivityAction
ActionLink
InvocableAction
an integer
a character
PlatformCachePartition
a character (inherited from Metadata)
a character
a character either 'true' or 'false'
a character
a PlatformCachePartitionType
PlatformCachePartitionType
an integer
an integer
an integer
a PlatformCacheType - which is a character taking one of the following values:
Session
Organization
Portal
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a character
a character
a character
a character
a PortalRoles - which is a character taking one of the following values:
Executive
Manager
Worker
PersonAccount
a character
a character either 'true' or 'false'
a character
a PortalType - which is a character taking one of the following values:
CustomerSuccess
Partner
Network
PostTemplate
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a character
PrimaryTabComponents
a Container
ProductSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
Profile
a character (inherited from Metadata)
a ProfileApplicationVisibility
a ProfileCategoryGroupVisibility
a ProfileApexClassAccess
a character either 'true' or 'false'
a ProfileCustomPermissions
a character
a ProfileExternalDataSourceAccess
a ProfileFieldLevelSecurity
a ProfileLayoutAssignment
a ProfileLoginHours
a ProfileLoginIpRange
a ProfileObjectPermissions
a ProfileApexPageAccess
a ProfileActionOverride
a ProfileRecordTypeVisibility
a ProfileTabVisibility
a character
a ProfileUserPermission
ProfileActionOverride
a character
a character
a FormFactor - which is a character taking one of the following values:
Small
Medium
Large
a character
a character
a ActionOverrideType - which is a character taking one of the following values:
Default
Standard
Scontrol
Visualforce
Flexipage
LightningComponent
ProfileApexClassAccess
a character
a character either 'true' or 'false'
ProfileApexPageAccess
a character
a character either 'true' or 'false'
ProfileApplicationVisibility
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
ProfileCategoryGroupVisibility
a character
a character
a CategoryGroupVisibility - which is a character taking one of the following values:
ALL
NONE
CUSTOM
ProfileCustomPermissions
a character either 'true' or 'false'
a character
ProfileExternalDataSourceAccess
a character either 'true' or 'false'
a character
ProfileFieldLevelSecurity
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
ProfileLayoutAssignment
a character
a character
ProfileLoginHours
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
ProfileLoginIpRange
a character
a character
a character
ProfileObjectPermissions
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
ProfilePasswordPolicy
a character (inherited from Metadata)
an integer
an integer
an integer
a character either 'true' or 'false'
a character either 'true' or 'false'
an integer
an integer
an integer
an integer
a character
ProfileRecordTypeVisibility
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
ProfileSessionSetting
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a SessionSecurityLevel - which is a character taking one of the following values:
LOW
STANDARD
HIGH_ASSURANCE
a character either 'true' or 'false'
an integer
a character either 'true' or 'false'
ProfileTabVisibility
a character
a TabVisibility - which is a character taking one of the following values:
Hidden
DefaultOff
DefaultOn
ProfileUserPermission
a character either 'true' or 'false'
a character
PublicGroups
a character
PushNotification
a character
a character
Queue
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a QueueMembers
a character
a QueueSobject
QueueMembers
a PublicGroups
a RoleAndSubordinates
a RoleAndSubordinatesInternal
a Roles
a Users
QueueSobject
a character
QuickAction
a character (inherited from Metadata)
a character
a character
a FieldOverride
a character
an integer
a character
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character
a QuickActionLayout
a QuickActionSendEmailOptions
a QuickActionLabel - which is a character taking one of the following values:
LogACall
LogANote
New
NewRecordType
Update
NewChild
NewChildRecordType
CreateNew
CreateNewRecordType
SendEmail
QuickRecordType
Quick
EditDescription
Defer
ChangeDueDate
ChangePriority
ChangeStatus
SocialPost
Escalate
EscalateToRecord
OfferFeedback
RequestFeedback
AddRecord
AddMember
Reply
ReplyAll
Forward
a character
a character
a character
a character
a QuickActionType - which is a character taking one of the following values:
Create
VisualforcePage
Post
SendEmail
LogACall
SocialPost
Canvas
Update
LightningComponent
Flow
an integer
QuickActionLayout
a LayoutSectionStyle - which is a character taking one of the following values:
TwoColumnsTopToBottom
TwoColumnsLeftToRight
OneColumn
CustomLinks
a QuickActionLayoutColumn
QuickActionLayoutColumn
a QuickActionLayoutItem
QuickActionLayoutItem
a character either 'true' or 'false'
a character
a UiBehavior - which is a character taking one of the following values:
Edit
Required
Readonly
QuickActionList
a QuickActionListItem
QuickActionListItem
a character
QuickActionSendEmailOptions
a character
a character either 'true' or 'false'
QuickActionTranslation
a character
a character
QuotasSettings
a character either 'true' or 'false'
QuoteSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
RecommendationAudience
a RecommendationAudienceDetail
RecommendationAudienceDetail
a AudienceCriteriaType - which is a character taking one of the following values:
CustomList
MaxDaysInCommunity
a character
a character
RecommendationDefinition
a RecommendationDefinitionDetail
RecommendationDefinitionDetail
a character
a character
a character
a ScheduledRecommendation
a character
a character
RecommendationStrategy
a character (inherited from Metadata)
a character
a character
a character
a StrategyNode
RecordType
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a character
a character
a RecordTypePicklistValue
RecordTypePicklistValue
a character
a PicklistValue
RecordTypeTranslation
a character
a character
a character
RelatedContent
a RelatedContentItem
RelatedContentItem
a LayoutItem
RelatedList
a character either 'true' or 'false'
a character
RelatedListItem
a character
a character
a character
a character
a character
a SortOrder - which is a character taking one of the following values:
Asc
Desc
RemoteSiteSetting
a character (inherited from Metadata)
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
Report
a character (inherited from Metadata)
a ReportAggregate
a Report
a ReportBlockInfo
a ReportBucketField
a ReportChart
a ReportColorRange
a ReportColumn
a ReportCrossFilter
a CurrencyIsoCode - which is a character taking one of the following values:
ADP
AED
AFA
AFN
ALL
AMD
ANG
AOA
ARS
ATS
AUD
AWG
AZM
AZN
BAM
BBD
BDT
BEF
BGL
BGN
BHD
BIF
BMD
BND
BOB
BOV
BRB
BRL
BSD
BTN
BWP
BYB
BYN
BYR
BZD
CAD
CDF
CHF
CLF
CLP
CNY
COP
CRC
CSD
CUC
CUP
CVE
CYP
CZK
DEM
DJF
DKK
DOP
DZD
ECS
EEK
EGP
ERN
ESP
ETB
EUR
FIM
FJD
FKP
FRF
GBP
GEL
GHC
GHS
GIP
GMD
GNF
GRD
GTQ
GWP
GYD
HKD
HNL
HRD
HRK
HTG
HUF
IDR
IEP
ILS
INR
IQD
IRR
ISK
ITL
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LUF
LVL
LYD
MAD
MDL
MGA
MGF
MKD
MMK
MNT
MOP
MRO
MTL
MUR
MVR
MWK
MXN
MXV
MYR
MZM
MZN
NAD
NGN
NIO
NLG
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PTE
PYG
QAR
RMB
ROL
RON
RSD
RUB
RUR
RWF
SAR
SBD
SCR
SDD
SDG
SEK
SGD
SHP
SIT
SKK
SLL
SOS
SRD
SRG
SSP
STD
SUR
SVC
SYP
SZL
THB
TJR
TJS
TMM
TMT
TND
TOP
TPE
TRL
TRY
TTD
TWD
TZS
UAH
UGX
USD
UYU
UZS
VEB
VEF
VND
VUV
WST
XAF
XCD
XOF
XPF
YER
YUM
ZAR
ZMK
ZMW
ZWD
ZWL
a ReportDataCategoryFilter
a character
a character
a ReportFilter
a character
a ReportFormat - which is a character taking one of the following values:
MultiBlock
Matrix
Summary
Tabular
a ReportGrouping
a ReportGrouping
a ReportHistoricalSelector
a character
an integer
a ReportParam
a character
a character
an integer
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a SortOrder - which is a character taking one of the following values:
Asc
Desc
a character
a ReportTimeFrameFilter
a character
ReportAggregate
a character
a character
a ReportAggregateDatatype - which is a character taking one of the following values:
currency
percent
number
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
an integer
ReportAggregateReference
a character
ReportBlockInfo
a ReportAggregateReference
a character
a character
ReportBucketField
a ReportBucketFieldType - which is a character taking one of the following values:
text
number
picklist
a character
a character
a ReportFormulaNullTreatment - which is a character taking one of the following values:
n
z
a character
a character
a character either 'true' or 'false'
a ReportBucketFieldValue
ReportBucketFieldSourceValue
a character
a character
a character
ReportBucketFieldValue
a ReportBucketFieldSourceValue
a character
ReportChart
a character
a character
a ChartBackgroundDirection - which is a character taking one of the following values:
TopToBottom
LeftToRight
Diagonal
a ChartSummary
a ChartType - which is a character taking one of the following values:
None
Scatter
ScatterGrouped
Bubble
BubbleGrouped
HorizontalBar
HorizontalBarGrouped
HorizontalBarStacked
HorizontalBarStackedTo100
VerticalColumn
VerticalColumnGrouped
VerticalColumnStacked
VerticalColumnStackedTo100
Line
LineGrouped
LineCumulative
LineCumulativeGrouped
Pie
Donut
Funnel
VerticalColumnLine
VerticalColumnGroupedLine
VerticalColumnStackedLine
Plugin
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a ChartLegendPosition - which is a character taking one of the following values:
Right
Bottom
OnChart
a ChartPosition - which is a character taking one of the following values:
CHART_TOP
CHART_BOTTOM
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a ReportChartSize - which is a character taking one of the following values:
Tiny
Small
Medium
Large
Huge
a numeric
a numeric
a ChartRangeType - which is a character taking one of the following values:
Auto
Manual
a character
an integer
a character
a character
an integer
ReportChartComponentLayoutItem
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a ReportChartComponentSize - which is a character taking one of the following values:
SMALL
MEDIUM
LARGE
ReportColorRange
a ReportSummaryType - which is a character taking one of the following values:
Sum
Average
Maximum
Minimum
None
a character
a numeric
a character
a numeric
a character
a character
ReportColumn
a ReportSummaryType - which is a character taking one of the following values:
Sum
Average
Maximum
Minimum
None
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
ReportCrossFilter
a ReportFilterItem
a ObjectFilterOperator - which is a character taking one of the following values:
with
without
a character
a character
a character
ReportDataCategoryFilter
a character
a character
a DataCategoryFilterOperation - which is a character taking one of the following values:
above
below
at
aboveOrBelow
ReportFilter
a character
a ReportFilterItem
a Language - which is a character taking one of the following values:
en_US
de
es
fr
it
ja
sv
ko
zh_TW
zh_CN
pt_BR
nl_NL
da
th
fi
ru
es_MX
no
hu
pl
cs
tr
in
ro
vi
uk
iw
el
bg
en_GB
ar
sk
pt_PT
hr
sl
fr_CA
ka
sr
sh
en_AU
en_MY
en_IN
en_PH
en_CA
ro_MD
bs
mk
lv
lt
et
sq
sh_ME
mt
ga
eu
cy
is
ms
tl
lb
rm
hy
hi
ur
bn
de_AT
de_CH
ta
ar_DZ
ar_BH
ar_EG
ar_IQ
ar_JO
ar_KW
ar_LB
ar_LY
ar_MA
ar_OM
ar_QA
ar_SA
ar_SD
ar_SY
ar_TN
ar_AE
ar_YE
zh_SG
zh_HK
en_HK
en_IE
en_SG
en_ZA
fr_BE
fr_LU
fr_CH
de_BE
de_LU
it_CH
nl_BE
es_AR
es_BO
es_CL
es_CO
es_CR
es_DO
es_EC
es_SV
es_GT
es_HN
es_NI
es_PA
es_PY
es_PE
es_PR
es_US
es_UY
es_VE
ca
eo
iw_EO
ReportFilterItem
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a FilterOperation - which is a character taking one of the following values:
equals
notEqual
lessThan
greaterThan
lessOrEqual
greaterOrEqual
contains
notContain
startsWith
includes
excludes
within
a character
a character
ReportFolder
a FolderAccessTypes (inherited from Folder)
a FolderShare (inherited from Folder)
a character (inherited from Folder)
a PublicFolderAccess (inherited from Folder)
a SharedTo (inherited from Folder)
ReportGrouping
a ReportAggrType - which is a character taking one of the following values:
Sum
Average
Maximum
Minimum
RowCount
a UserDateGranularity - which is a character taking one of the following values:
None
Day
Week
Month
Quarter
Year
FiscalQuarter
FiscalYear
MonthInYear
DayInMonth
FiscalPeriod
FiscalWeek
a character
a character
a SortOrder - which is a character taking one of the following values:
Asc
Desc
a ReportSortType - which is a character taking one of the following values:
Column
Aggregate
CustomSummaryFormula
ReportHistoricalSelector
a character
ReportLayoutSection
a ReportTypeColumn
a character
ReportParam
a character
a character
ReportTimeFrameFilter
a character
a character formatted as 'yyyy-mm-dd'
a UserDateInterval - which is a character taking one of the following values:
INTERVAL_CURRENT
INTERVAL_CURNEXT1
INTERVAL_CURPREV1
INTERVAL_NEXT1
INTERVAL_PREV1
INTERVAL_CURNEXT3
INTERVAL_CURFY
INTERVAL_PREVFY
INTERVAL_PREV2FY
INTERVAL_AGO2FY
INTERVAL_NEXTFY
INTERVAL_PREVCURFY
INTERVAL_PREVCUR2FY
INTERVAL_CURNEXTFY
INTERVAL_CUSTOM
INTERVAL_YESTERDAY
INTERVAL_TODAY
INTERVAL_TOMORROW
INTERVAL_LASTWEEK
INTERVAL_THISWEEK
INTERVAL_NEXTWEEK
INTERVAL_LASTMONTH
INTERVAL_THISMONTH
INTERVAL_NEXTMONTH
INTERVAL_LASTTHISMONTH
INTERVAL_THISNEXTMONTH
INTERVAL_CURRENTQ
INTERVAL_CURNEXTQ
INTERVAL_CURPREVQ
INTERVAL_NEXTQ
INTERVAL_PREVQ
INTERVAL_CURNEXT3Q
INTERVAL_CURY
INTERVAL_PREVY
INTERVAL_PREV2Y
INTERVAL_AGO2Y
INTERVAL_NEXTY
INTERVAL_PREVCURY
INTERVAL_PREVCUR2Y
INTERVAL_CURNEXTY
INTERVAL_LAST7
INTERVAL_LAST30
INTERVAL_LAST60
INTERVAL_LAST90
INTERVAL_LAST120
INTERVAL_NEXT7
INTERVAL_NEXT30
INTERVAL_NEXT60
INTERVAL_NEXT90
INTERVAL_NEXT120
LAST_FISCALWEEK
THIS_FISCALWEEK
NEXT_FISCALWEEK
LAST_FISCALPERIOD
THIS_FISCALPERIOD
NEXT_FISCALPERIOD
LASTTHIS_FISCALPERIOD
THISNEXT_FISCALPERIOD
CURRENT_ENTITLEMENT_PERIOD
PREVIOUS_ENTITLEMENT_PERIOD
PREVIOUS_TWO_ENTITLEMENT_PERIODS
TWO_ENTITLEMENT_PERIODS_AGO
CURRENT_AND_PREVIOUS_ENTITLEMENT_PERIOD
CURRENT_AND_PREVIOUS_TWO_ENTITLEMENT_PERIODS
a character formatted as 'yyyy-mm-dd'
ReportType
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a ReportTypeCategory - which is a character taking one of the following values:
accounts
opportunities
forecasts
cases
leads
campaigns
activities
busop
products
admin
territory
other
content
usage_entitlement
wdc
calibration
territory2
a character either 'true' or 'false'
a character
a ObjectRelationship
a character
a ReportLayoutSection
ReportTypeColumn
a character either 'true' or 'false'
a character
a character
a character
ReportTypeColumnTranslation
a character
a character
ReportTypeSectionTranslation
a ReportTypeColumnTranslation
a character
a character
ReportTypeTranslation
a character
a character
a character
a ReportTypeSectionTranslation
ReputationBranding
a character
ReputationLevel
a ReputationBranding
a character
a numeric
ReputationLevelDefinitions
a ReputationLevel
ReputationLevels
a ChatterAnswersReputationLevel
a IdeaReputationLevel
ReputationPointsRule
a character
an integer
ReputationPointsRules
a ReputationPointsRule
RetrieveRequest
a numeric
a character
a character either 'true' or 'false'
a character
a Package
Role
a character (inherited from RoleOrTerritory)
a character (inherited from RoleOrTerritory)
a character (inherited from RoleOrTerritory)
a character either 'true' or 'false' (inherited from RoleOrTerritory)
a character (inherited from RoleOrTerritory)
a character (inherited from RoleOrTerritory)
a character
RoleAndSubordinates
a character
RoleAndSubordinatesInternal
a character
RoleOrTerritory
a character (inherited from Metadata)
a character
a character
a character
a character either 'true' or 'false'
a character
a character
Roles
a character
RuleEntry
a character
a AssignToLookupValueType - which is a character taking one of the following values:
User
Queue
a character
a character
a BusinessHoursSourceType - which is a character taking one of the following values:
None
Case
Static
a FilterItem
a character either 'true' or 'false'
a EscalationAction
a EscalationStartTimeType - which is a character taking one of the following values:
CaseCreation
CaseLastModified
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character
a character
a character
SamlSsoConfig
a character (inherited from Metadata)
a character
a character
a character
a character
a character
a SamlIdentityLocationType - which is a character taking one of the following values:
SubjectNameId
Attribute
a SamlIdentityType - which is a character taking one of the following values:
Username
FederationId
UserId
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a SamlType - which is a character taking one of the following values:
SAML1_1
SAML2_0
a SamlSpSLOBinding - which is a character taking one of the following values:
RedirectBinding
PostBinding
a character
a character either 'true' or 'false'
a character
ScheduledRecommendation
a ScheduledRecommendationDetail
ScheduledRecommendationDetail
a RecommendationChannel - which is a character taking one of the following values:
DefaultChannel
CustomChannel1
CustomChannel2
CustomChannel3
CustomChannel4
CustomChannel5
a character either 'true' or 'false'
an integer
a character
Scontrol
a character formed using base64encode
(inherited from MetadataWithContent)
a SControlContentSource - which is a character taking one of the following values:
HTML
URL
Snippet
a character
a Encoding - which is a character taking one of the following values:
UTF-8
ISO-8859-1
Shift_JIS
ISO-2022-JP
EUC-JP
ks_c_5601-1987
Big5
GB2312
Big5-HKSCS
x-SJIS_0213
a character formed using base64encode
a character
a character
a character either 'true' or 'false'
ScontrolTranslation
a character
a character
SearchLayouts
a character
a character
a character
a character
a character
a character
a character
a character
a character
SearchSettings
a character (inherited from Metadata)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a SearchSettingsByObject
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
SearchSettingsByObject
a ObjectSearchSetting
SecuritySettings
a character (inherited from Metadata)
a NetworkAccess
a PasswordPolicies
a SessionSettings
ServiceCloudConsoleConfig
a AppComponentList
a character
a character
a character
a KeyboardShortcuts
a ListPlacement
a character
a LiveAgentConfig
a character
a PushNotification
a TabLimitConfig
a character
SessionSettings
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a SessionTimeout - which is a character taking one of the following values:
TwentyFourHours
TwelveHours
EightHours
FourHours
TwoHours
SixtyMinutes
ThirtyMinutes
FifteenMinutes
SFDCMobileSettings
a character either 'true' or 'false'
a character either 'true' or 'false'
SharedTo
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
SharingBaseRule
a character (inherited from Metadata)
a character
a AccountSharingRuleSettings
a character
a character
a SharedTo
SharingCriteriaRule
a character (inherited from SharingBaseRule)
a AccountSharingRuleSettings (inherited from SharingBaseRule)
a character (inherited from SharingBaseRule)
a character (inherited from SharingBaseRule)
a SharedTo (inherited from SharingBaseRule)
a character
a FilterItem
SharingOwnerRule
a character (inherited from SharingBaseRule)
a AccountSharingRuleSettings (inherited from SharingBaseRule)
a character (inherited from SharingBaseRule)
a character (inherited from SharingBaseRule)
a SharedTo (inherited from SharingBaseRule)
a SharedTo
SharingReason
a character (inherited from Metadata)
a character
SharingReasonTranslation
a character
a character
SharingRecalculation
a character
SharingRules
a character (inherited from Metadata)
a SharingCriteriaRule
a SharingOwnerRule
a SharingTerritoryRule
SharingSet
a character (inherited from Metadata)
a AccessMapping
a character
a character
a character
SharingTerritoryRule
a SharedTo (inherited from SharingOwnerRule)
SidebarComponent
a character
a character
a character either 'true' or 'false'
an integer
a character
a character
a character
a RelatedList
a character
a character
an integer
SiteDotCom
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a SiteType - which is a character taking one of the following values:
Siteforce
Visualforce
User
SiteRedirectMapping
a SiteRedirect - which is a character taking one of the following values:
Permanent
Temporary
a character either 'true' or 'false'
a character
a character
SiteWebAddress
a character
a character
a character either 'true' or 'false'
Skill
a character (inherited from Metadata)
a SkillAssignments
a character
a character
SkillAssignments
a SkillProfileAssignments
a SkillUserAssignments
SkillProfileAssignments
a character
SkillUserAssignments
a character
SocialCustomerServiceSettings
a character (inherited from Metadata)
a CaseSubjectOption - which is a character taking one of the following values:
SocialPostSource
SocialPostContent
BuildCustom
StandardFieldTranslation
a character
a character
StandardValue
a character (inherited from CustomValue)
a character either 'true' or 'false' (inherited from CustomValue)
a character (inherited from CustomValue)
a character either 'true' or 'false' (inherited from CustomValue)
a character (inherited from CustomValue)
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a ForecastCategories - which is a character taking one of the following values:
Omitted
Pipeline
BestCase
Forecast
Closed
a character
a character either 'true' or 'false'
an integer
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
StandardValueSet
a character (inherited from Metadata)
a character
a character either 'true' or 'false'
a StandardValue
StandardValueSetTranslation
a character (inherited from Metadata)
a ValueTranslation
State
a character either 'true' or 'false'
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
StaticResource
a character formed using base64encode
(inherited from MetadataWithContent)
a StaticResourceCacheControl - which is a character taking one of the following values:
Private
Public
a character
a character
StrategyNode
a character
a character
a character
a character
an integer
SubtabComponents
a Container
SummaryLayout
a character
an integer
an integer
an integer
a SummaryLayoutItem
a SummaryLayoutStyle - which is a character taking one of the following values:
Default
QuoteTemplate
DefaultQuoteTemplate
ServiceReportTemplate
ChildServiceReportTemplateStyle
DefaultServiceReportTemplate
CaseInteraction
QuickActionLayoutLeftRight
QuickActionLayoutTopDown
PathAssistant
SummaryLayoutItem
a character
a character
an integer
an integer
an integer
SupervisorAgentConfigSkills
a character
SynonymDictionary
a character (inherited from Metadata)
a SynonymGroup
a character either 'true' or 'false'
a character
SynonymGroup
a Language - which is a character taking one of the following values:
en_US
de
es
fr
it
ja
sv
ko
zh_TW
zh_CN
pt_BR
nl_NL
da
th
fi
ru
es_MX
no
hu
pl
cs
tr
in
ro
vi
uk
iw
el
bg
en_GB
ar
sk
pt_PT
hr
sl
fr_CA
ka
sr
sh
en_AU
en_MY
en_IN
en_PH
en_CA
ro_MD
bs
mk
lv
lt
et
sq
sh_ME
mt
ga
eu
cy
is
ms
tl
lb
rm
hy
hi
ur
bn
de_AT
de_CH
ta
ar_DZ
ar_BH
ar_EG
ar_IQ
ar_JO
ar_KW
ar_LB
ar_LY
ar_MA
ar_OM
ar_QA
ar_SA
ar_SD
ar_SY
ar_TN
ar_AE
ar_YE
zh_SG
zh_HK
en_HK
en_IE
en_SG
en_ZA
fr_BE
fr_LU
fr_CH
de_BE
de_LU
it_CH
nl_BE
es_AR
es_BO
es_CL
es_CO
es_CR
es_DO
es_EC
es_SV
es_GT
es_HN
es_NI
es_PA
es_PY
es_PE
es_PR
es_US
es_UY
es_VE
ca
eo
iw_EO
a character
TabLimitConfig
a character
a character
Territory
a character (inherited from RoleOrTerritory)
a character (inherited from RoleOrTerritory)
a character (inherited from RoleOrTerritory)
a character either 'true' or 'false' (inherited from RoleOrTerritory)
a character (inherited from RoleOrTerritory)
a character (inherited from RoleOrTerritory)
a character
a character
Territory2
a character (inherited from Metadata)
a character
a character
a character
a FieldValue
a character
a character
a character
a character
a Territory2RuleAssociation
a character
Territory2Model
a character (inherited from Metadata)
a FieldValue
a character
a character
Territory2Rule
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a character
a Territory2RuleItem
Territory2RuleAssociation
a character either 'true' or 'false'
a character
Territory2RuleItem
a character
a FilterOperation - which is a character taking one of the following values:
equals
notEqual
lessThan
greaterThan
lessOrEqual
greaterOrEqual
contains
notContain
startsWith
includes
excludes
within
a character
Territory2Settings
a character (inherited from Metadata)
a character
a character
a character
a character
a Territory2SettingsOpportunityFilter
Territory2SettingsOpportunityFilter
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
Territory2Type
a character (inherited from Metadata)
a character
a character
an integer
TopicsForObjects
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
TouchMobileSettings
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
TransactionSecurityAction
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
a TransactionSecurityNotification
a character either 'true' or 'false'
TransactionSecurityNotification
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
TransactionSecurityPolicy
a character (inherited from Metadata)
a TransactionSecurityAction
a character either 'true' or 'false'
a character
a character
a character
a TransactionSecurityEventName - which is a character taking one of the following values:
ReportEvent
ApiEvent
AdminSetupEvent
LoginEvent
a MonitoredEvents - which is a character taking one of the following values:
AuditTrail
Login
Entity
DataExport
AccessResource
a character
a character
a character
a character
a TxnSecurityPolicyType - which is a character taking one of the following values:
CustomApexPolicy
CustomConditionBuilderPolicy
Translations
a character (inherited from Metadata)
a CustomApplicationTranslation
a CustomDataTypeTranslation
a CustomLabelTranslation
a CustomPageWebLinkTranslation
a CustomTabTranslation
a FlowDefinitionTranslation
a GlobalQuickActionTranslation
a ReportTypeTranslation
a ScontrolTranslation
UiFormulaCriterion
a character
a character
a character
UiFormulaRule
a character
a UiFormulaCriterion
UiPlugin
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a character
a character either 'true' or 'false'
a character
a character
UserCriteria
a character (inherited from Metadata)
an integer
a character
an integer
a character
a character
a NetworkUserType - which is a character taking one of the following values:
Internal
Customer
Partner
Users
a character
ValidationRule
a character (inherited from Metadata)
a character either 'true' or 'false'
a character
a character
a character
a character
ValidationRuleTranslation
a character
a character
ValueSet
a character
a character either 'true' or 'false'
a ValueSetValuesDefinition
a character
a ValueSettings
ValueSettings
a character
a character
ValueSetValuesDefinition
a character either 'true' or 'false'
a CustomValue
ValueTranslation
a character
a character
ValueTypeField
a ValueTypeField
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
an integer
a character
a PicklistEntry
a character
a character either 'true' or 'false'
VisualizationPlugin
a character (inherited from Metadata)
a character
a character
a character
a character
a VisualizationResource
a VisualizationType
VisualizationResource
a character
a character
an integer
a VisualizationResourceType - which is a character taking one of the following values:
js
css
VisualizationType
a character
a character
a character
a character
a character
WaveApplication
a character (inherited from Metadata)
a character
a character
a character
a character
a FolderShare
a character
a character
WaveDashboard
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a character
a character
a character
WaveDataflow
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a character
a character
WaveDataset
a character (inherited from Metadata)
a character
a character
a character
a character
WaveLens
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a character
a character
a character
a character
a character
WaveRecipe
a character formed using base64encode
(inherited from MetadataWithContent)
a character
a character
a character
a character
WaveTemplateBundle
a character (inherited from Metadata)
a character
a numeric
a character
a character
a character
a character
a character
WaveXmd
a character (inherited from Metadata)
a character
a character
a character
a character
a WaveXmdDate
a WaveXmdDimension
a WaveXmdMeasure
a WaveXmdOrganization
a character
a character
a character
WaveXmdDate
a character
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
a character
an integer
an integer
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
an integer
WaveXmdDimension
a WaveXmdDimensionCustomAction
a character either 'true' or 'false'
a character
a character
a character
a character
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character
a WaveXmdDimensionMember
a character
a WaveXmdRecordDisplayLookup
a character
a character
a WaveXmdDimensionSalesforceAction
a character either 'true' or 'false'
an integer
a character either 'true' or 'false'
an integer
WaveXmdDimensionCustomAction
a character
a character either 'true' or 'false'
a character
a character
an integer
a character
a character
a character
WaveXmdDimensionMember
a character
a character
a character
an integer
WaveXmdDimensionSalesforceAction
a character either 'true' or 'false'
a character
an integer
WaveXmdMeasure
a character
a character
a character
a character
an integer
a character either 'true' or 'false'
a character
a character
a character
a numeric
a character
a character either 'true' or 'false'
a character
a character
an integer
a character either 'true' or 'false'
an integer
WaveXmdOrganization
a character
a character
a character
an integer
WaveXmdRecordDisplayLookup
a character
WebLink
a character (inherited from Metadata)
a WebLinkAvailability - which is a character taking one of the following values:
online
offline
a character
a WebLinkDisplayType - which is a character taking one of the following values:
link
button
massActionButton
a Encoding - which is a character taking one of the following values:
UTF-8
ISO-8859-1
Shift_JIS
ISO-2022-JP
EUC-JP
ks_c_5601-1987
Big5
GB2312
Big5-HKSCS
x-SJIS_0213
a character either 'true' or 'false'
a character either 'true' or 'false'
a character either 'true' or 'false'
an integer
a character either 'true' or 'false'
a WebLinkType - which is a character taking one of the following values:
url
sControl
javascript
page
flow
a character
a WebLinkWindowType - which is a character taking one of the following values:
newWindow
sidebar
noSidebar
replace
onClickJavaScript
a character
a WebLinkPosition - which is a character taking one of the following values:
fullScreen
none
topLeft
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
an integer
WebLinkTranslation
a character
a character
WebToCaseSettings
a character
a character
a character either 'true' or 'false'
WeightedSourceCategory
a character
a numeric
Workflow
a character (inherited from Metadata)
a WorkflowAlert
a WorkflowFieldUpdate
a WorkflowFlowAction
a WorkflowKnowledgePublish
a WorkflowOutboundMessage
a WorkflowRule
a WorkflowSend
a WorkflowTask
WorkflowAction
a character (inherited from Metadata)
WorkflowActionReference
a character
a WorkflowActionType - which is a character taking one of the following values:
FieldUpdate
KnowledgePublish
Task
Alert
Send
OutboundMessage
FlowAction
WorkflowAlert
see documentation for WorkflowAction
a character
a character
a character either 'true' or 'false'
a WorkflowEmailRecipient
a character
a ActionEmailSenderType - which is a character taking one of the following values:
CurrentUser
OrgWideEmailAddress
DefaultWorkflowUser
a character
WorkflowEmailRecipient
a character
a character
a ActionEmailRecipientTypes - which is a character taking one of the following values:
group
role
user
opportunityTeam
accountTeam
roleSubordinates
owner
creator
partnerUser
accountOwner
customerPortalUser
portalRole
portalRoleSubordinates
contactLookup
userLookup
roleSubordinatesInternal
caseTeam
campaignMemberDerivedOwner
WorkflowFieldUpdate
see documentation for WorkflowAction
a character
a character
a character
a character
a character
a LookupValueType - which is a character taking one of the following values:
User
Queue
RecordType
a character
a character either 'true' or 'false'
a FieldUpdateOperation - which is a character taking one of the following values:
Formula
Literal
Null
NextValue
PreviousValue
LookupValue
a character either 'true' or 'false'
a character either 'true' or 'false'
a character
WorkflowFlowAction
see documentation for WorkflowAction
a character
a character
a WorkflowFlowActionParameter
a character
a character
a character either 'true' or 'false'
WorkflowFlowActionParameter
a character
a character
WorkflowKnowledgePublish
see documentation for WorkflowAction
a KnowledgeWorkflowAction - which is a character taking one of the following values:
PublishAsNew
Publish
a character
a character
a character
a character either 'true' or 'false'
WorkflowRule
a character (inherited from Metadata)
a WorkflowActionReference
a character either 'true' or 'false'
a character
a FilterItem
a character
a character
a WorkflowTriggerTypes - which is a character taking one of the following values:
onCreateOnly
onCreateOrTriggeringUpdate
onAllChanges
OnRecursiveUpdate
a WorkflowTimeTrigger
WorkflowSend
see documentation for WorkflowAction
a SendAction - which is a character taking one of the following values:
Send
a character
a character
a character
a character either 'true' or 'false'
WorkflowTask
see documentation for WorkflowAction
a character
a ActionTaskAssignedToTypes - which is a character taking one of the following values:
user
role
opportunityTeam
accountTeam
owner
accountOwner
creator
accountCreator
partnerUser
portalRole
a character
an integer
a character either 'true' or 'false'
a character
a character
a character either 'true' or 'false'
a character
a character
WorkflowTaskTranslation
a character
a character
a character
WorkflowTimeTrigger
a WorkflowActionReference
a character
a character
a WorkflowTimeUnits - which is a character taking one of the following values:
Hours
Days
WorkspaceMapping
a character
a character
a list
that can be used as input to one of the CRUD Metadata API
operations: sf_create_metadata, sf_update_metadata, sf_update_metadata
A function for allowing finer grained control over how a search is performed when not using SOSL
parameterized_search_control( objects = NULL, fields_scope = c("ALL", "NAME", "EMAIL", "PHONE", "SIDEBAR"), fields = NULL, overall_limit = 2000, default_limit = 200, spell_correction = TRUE )
parameterized_search_control( objects = NULL, fields_scope = c("ALL", "NAME", "EMAIL", "PHONE", "SIDEBAR"), fields = NULL, overall_limit = 2000, default_limit = 200, spell_correction = TRUE )
objects |
|
fields_scope |
|
fields |
|
overall_limit |
|
default_limit |
|
spell_correction |
|
list
of parameters passed onto sf_search
## Not run: # free text search only on Contact record Phone fields # this will improve the performance of the search my_phone_search <- "(336)" search_result <- sf_search(my_phone_search, objects = c("Contact", "Lead"), fields_scope = "PHONE", fields = c("Id", "FirstName", "LastName")) ## End(Not run)
## Not run: # free text search only on Contact record Phone fields # this will improve the performance of the search my_phone_search <- "(336)" search_result <- sf_search(my_phone_search, objects = c("Contact", "Lead"), fields_scope = "PHONE", fields = c("Id", "FirstName", "LastName")) ## End(Not run)
salesforcer
backwards compatible version of the RForcecom function
rforcecom.bulkAction
This function is a convenience wrapper for submitting bulk API jobs
rforcecom.bulkAction( session, operation = c("insert", "delete", "upsert", "update", "hardDelete"), data, object, external_id_fieldname = NULL, multiBatch = TRUE, batchSize = 10000, interval_seconds = 5, max_attempts = 100, verbose = FALSE )
rforcecom.bulkAction( session, operation = c("insert", "delete", "upsert", "update", "hardDelete"), data, object, external_id_fieldname = NULL, multiBatch = TRUE, batchSize = 10000, interval_seconds = 5, max_attempts = 100, verbose = FALSE )
session |
|
operation |
a character string defining the type of operation being performed |
data |
a matrix or data.frame that can be coerced into a CSV file for submitting as batch request |
object |
a character string defining the target salesforce object that the operation will be performed on |
external_id_fieldname |
|
multiBatch |
a boolean value defining whether or not submit data in batches to the API |
batchSize |
an integer value defining the number of records to submit if multiBatch is true. The max value is 10,000 in accordance with Salesforce limits. |
interval_seconds |
an integer defining the seconds between attempts to check for job completion |
max_attempts |
an integer defining then max number attempts to check for job completion before stopping |
verbose |
|
A tbl_df
of the results of the bulk job
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: # update Account object updates <- rforcecom.bulkAction(session, operation = 'update', data = my_data, object = 'Account') ## End(Not run)
## Not run: # update Account object updates <- rforcecom.bulkAction(session, operation = 'update', data = my_data, object = 'Account') ## End(Not run)
salesforcer
backwards compatible version of
RForcecom::rforcecom.bulkQuery
rforcecom.bulkQuery( session, soqlQuery, object, interval_seconds = 5, max_attempts = 100, verbose = FALSE )
rforcecom.bulkQuery( session, soqlQuery, object, interval_seconds = 5, max_attempts = 100, verbose = FALSE )
session |
|
soqlQuery |
|
object |
|
interval_seconds |
an integer defining the seconds between attempts to check for job completion |
max_attempts |
an integer defining then max number attempts to check for job completion before stopping |
verbose |
|
A data.frame
of the recordset returned by query
salesforcer
backwards compatible version of
RForcecom::rforcecom.create
rforcecom.create(session, objectName, fields)
rforcecom.create(session, objectName, fields)
session |
|
objectName |
|
fields |
Field names and values. (ex: Name="CompanyName", Phone="000-000-000" ) |
data.frame
containing the id and success indicator of the record creation process
salesforcer
backwards compatible version of
RForcecom::rforcecom.delete
rforcecom.delete(session, objectName, id)
rforcecom.delete(session, objectName, id)
session |
|
objectName |
|
id |
Record ID to delete. (ex: "999x000000xxxxxZZZ") |
NULL
if successful otherwise the function errors out
salesforcer
backwards compatible version of
RForcecom::rforcecom.getObjectDescription
rforcecom.getObjectDescription(session, objectName)
rforcecom.getObjectDescription(session, objectName)
session |
|
objectName |
|
Object descriptions
This function returns a data.frame with one row per field for an object.
salesforcer
backwards compatible version of
RForcecom::rforcecom.getServerTimestamp
rforcecom.getServerTimestamp(session)
rforcecom.getServerTimestamp(session)
session |
|
salesforcer
backwards compatible version of
RForcecom::rforcecom.login
rforcecom.login( username, password, loginURL = "https://login.salesforce.com/", apiVersion = "35.0" )
rforcecom.login( username, password, loginURL = "https://login.salesforce.com/", apiVersion = "35.0" )
username |
Your username for login to the Salesforce.com. In many cases, username is your E-mail address. |
password |
Your password for login to the Salesforce.com. Note: DO NOT FORGET your Security Token. (Ex.) If your password is "Pass1234" and your security token is "XYZXYZXYZXYZ", you should set "Pass1234XYZXYZXYZXYZ". |
loginURL |
(optional) Login URL. If your environment is sandbox specify (ex:) "https://test.salesforce.com". |
apiVersion |
(optional) Version of the REST API and SOAP API that you want to use. (ex:) "35.0" Supported versions from v20.0 and up. |
sessionID |
Session ID. |
instanceURL |
Instance URL. |
apiVersion |
API Version. |
salesforcer
backwards compatible version of
RForcecom::rforcecom.query
rforcecom.query(session, soqlQuery, queryAll = FALSE)
rforcecom.query(session, soqlQuery, queryAll = FALSE)
session |
|
soqlQuery |
|
queryAll |
|
Result dataset.
salesforcer
backwards compatible version of
RForcecom::rforcecom.retrieve
rforcecom.retrieve( session, objectName, fields, limit = NULL, id = NULL, offset = NULL, order = NULL, inverse = NULL, nullsLast = NULL )
rforcecom.retrieve( session, objectName, fields, limit = NULL, id = NULL, offset = NULL, order = NULL, inverse = NULL, nullsLast = NULL )
session |
|
objectName |
|
fields |
A List of field names. (ex: c("Id", "Name", "Industry", "AnnualRevenue)")) |
limit |
Number of the records to retrieve. (ex: 5) |
id |
Record ID to retrieve. (ex: "999x000000xxxxxZZZ") |
offset |
Specifies the starting row offset. (ex: "100") |
order |
A list for controlling the order of query results. (ex: "c("Industry","Name")") |
inverse |
If it is TRUE, the results are ordered in descending order. This parameter works when order parameter has been set. (Default: FALSE) |
nullsLast |
If it is TRUE, null records list in last. If not null records list in first. This parameter works when order parameter has been set. (Default: FALSE) |
salesforcer
backwards compatible version of
RForcecom::rforcecom.search
rforcecom.search(session, queryString)
rforcecom.search(session, queryString)
session |
|
queryString |
Query strings to search. (ex: "United", "Electoronics") |
salesforcer
backwards compatible version of
RForcecom::rforcecom.update
rforcecom.update(session, objectName, id, fields)
rforcecom.update(session, objectName, id, fields)
session |
|
objectName |
|
id |
Record ID to update. (ex: "999x000000xxxxxZZZ") |
fields |
Field names and values. (ex: Name="CompanyName", Phone="000-000-000" ) |
NULL
if successful otherwise the function errors out
salesforcer
backwards compatible version of
RForcecom::rforcecom.upsert
rforcecom.upsert(session, objectName, externalIdField, externalId, fields)
rforcecom.upsert(session, objectName, externalIdField, externalId, fields)
session |
|
objectName |
|
externalIdField |
An external Key's field name. (ex: "AccountMaster__c") |
externalId |
An external Key's ID. (ex: "999x000000xxxxxZZZ") |
fields |
Field names and values. (ex: Name="CompanyName", Phone="000-000-000" ) |
NULL
if successful otherwise the function errors out
This function aborts a Job in the Salesforce Bulk API
sf_abort_job_bulk( job_id, api_type = c("Bulk 1.0", "Bulk 2.0"), verbose = FALSE )
sf_abort_job_bulk( job_id, api_type = c("Bulk 1.0", "Bulk 2.0"), verbose = FALSE )
job_id |
|
api_type |
|
verbose |
|
A list
of parameters defining the now aborted job
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') sf_abort_job_bulk(job_info$id) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') sf_abort_job_bulk(job_info$id) ## End(Not run)
sf_analytics_notification_create(body)
sf_analytics_notification_create(body)
body |
|
list
sf_analytics_notification_delete(notification_id)
sf_analytics_notification_delete(notification_id)
notification_id |
|
logical
sf_analytics_notification_describe(notification_id)
sf_analytics_notification_describe(notification_id)
notification_id |
|
list
sf_analytics_notification_update(notification_id, body)
sf_analytics_notification_update(notification_id, body)
notification_id |
|
body |
|
list
sf_analytics_notifications_limits( source = c("lightningDashboardSubscribe", "lightningReportSubscribe", "waveNotification"), record_id = NULL )
sf_analytics_notifications_limits( source = c("lightningDashboardSubscribe", "lightningReportSubscribe", "waveNotification"), record_id = NULL )
source |
By default, all 3 sources will be returned in the results. |
record_id |
|
list
sf_analytics_notifications_list( source = c("lightningDashboardSubscribe", "lightningReportSubscribe", "waveNotification"), owner_id = NULL, record_id = NULL )
sf_analytics_notifications_list( source = c("lightningDashboardSubscribe", "lightningReportSubscribe", "waveNotification"), owner_id = NULL, record_id = NULL )
source |
By default, all 3 sources will be returned in the results. |
owner_id |
|
record_id |
|
list
Log in using Basic (Username-Password) or OAuth 2.0 authentication. OAuth does
not require sharing passwords, but will require authorizing salesforcer
as a connected app to view and manage your organization. You will be directed to
a web browser, asked to sign in to your Salesforce account, and to grant salesforcer
permission to operate on your behalf. By default, these user credentials are
cached in a file named .httr-oauth-salesforcer
in the current working directory.
sf_auth( username = NULL, password = NULL, security_token = NULL, login_url = getOption("salesforcer.login_url"), token = NULL, consumer_key = getOption("salesforcer.consumer_key"), consumer_secret = getOption("salesforcer.consumer_secret"), callback_url = getOption("salesforcer.callback_url"), cache = getOption("salesforcer.httr_oauth_cache"), verbose = FALSE )
sf_auth( username = NULL, password = NULL, security_token = NULL, login_url = getOption("salesforcer.login_url"), token = NULL, consumer_key = getOption("salesforcer.consumer_key"), consumer_secret = getOption("salesforcer.consumer_secret"), callback_url = getOption("salesforcer.callback_url"), cache = getOption("salesforcer.httr_oauth_cache"), verbose = FALSE )
username |
Salesforce username, typically an email address |
password |
Salesforce password |
security_token |
Salesforce security token. Note: A new security token is generated whenever your password is changed. |
login_url |
a custom login url; defaults to https://login.salesforce.com. If needing to log into a sandbox or dev environment then provide its login URL (e.g. https://test.salesforce.com) |
token |
optional; an actual token object or the path to a valid token
stored as an |
consumer_key , consumer_secret , callback_url
|
the "Consumer Key","Consumer Secret",
and "Callback URL" when using a connected app; defaults to the |
cache |
|
verbose |
|
list
invisibly that contains 4 elements detailing the authentication state
The link{sf_auth}
function invisibly returns the following
4 pieces of information which can be reused in other operations:
character
; One of two options 'Basic' or 'OAuth'. If a username,
password, and security token were supplied, then this would result in
'Basic' authentication.
Token2.0
; The object returned by oauth2.0_token
.
This value is NULL
if auth_method='Basic'
.
character
; A unique ID associated with this user session. The session
ID is obtained from the X-SFDC-Session header fetched with SOAP API's login()
call. This value is NULL
if auth_method='OAuth'
.
character
; The domain address of the server that your Salesforce org
is on and where subsequent API calls will be directed to. For example,
https://na21.salesforce.com
refers to an org located on the 'NA21'
server instance located in Chicago, USA / Washington DC, USA per this
Knowledge Article: https://help.salesforce.com/s/articleView?language=en_US&id=000314281.
## Not run: # log in using basic authentication (username-password) sf_auth(username = "[email protected]", password = "test_password", security_token = "test_token") # log in using OAuth 2.0 (via browser or cached .httr-oauth-salesforcer) sf_auth() # log in to a Sandbox environment # Via brower or refresh of .httr-oauth-salesforcer sf_auth(login_url = "https://test.salesforce.com") # Save token to disk and log in using it saveRDS(salesforcer_state()$token, "token.rds") sf_auth(token = "token.rds") ## End(Not run)
## Not run: # log in using basic authentication (username-password) sf_auth(username = "[email protected]", password = "test_password", security_token = "test_token") # log in using OAuth 2.0 (via browser or cached .httr-oauth-salesforcer) sf_auth() # log in to a Sandbox environment # Via brower or refresh of .httr-oauth-salesforcer sf_auth(login_url = "https://test.salesforce.com") # Save token to disk and log in using it saveRDS(salesforcer_state()$token, "token.rds") sf_auth(token = "token.rds") ## End(Not run)
This function returns detailed (row-by-row) information on an existing batch which has already been submitted to Bulk API Job
sf_batch_details_bulk( job_id, batch_id, api_type = c("Bulk 1.0"), verbose = FALSE )
sf_batch_details_bulk( job_id, batch_id, api_type = c("Bulk 1.0"), verbose = FALSE )
job_id |
|
batch_id |
|
api_type |
|
verbose |
|
A tbl_df
, formatted by Salesforce, with information containing
the success or failure or certain rows in a submitted batch, unless the operation
was query, then it is a data.frame containing the result_id for retrieving the recordset.
This is a legacy function used only with Bulk 1.0.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: job_info <- sf_create_job_bulk(operation = "query", object = "Account") soql <- "SELECT Id, Name FROM Account LIMIT 10" batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql) batch_details <- sf_batch_details_bulk(job_id=batch_query_info$jobId, batch_id=batch_query_info$id) sf_close_job_bulk(job_info$id) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk(operation = "query", object = "Account") soql <- "SELECT Id, Name FROM Account LIMIT 10" batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql) batch_details <- sf_batch_details_bulk(job_id=batch_query_info$jobId, batch_id=batch_query_info$id) sf_close_job_bulk(job_info$id) ## End(Not run)
This function checks on and returns status information on an existing batch which has already been submitted to Bulk API Job
sf_batch_status_bulk( job_id, batch_id, api_type = c("Bulk 1.0"), verbose = FALSE )
sf_batch_status_bulk( job_id, batch_id, api_type = c("Bulk 1.0"), verbose = FALSE )
job_id |
|
batch_id |
|
api_type |
|
verbose |
|
A tbl_df
of parameters defining the batch identified by the batch_id
This is a legacy function used only with Bulk 1.0.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: job_info <- sf_create_job_bulk(operation = "query", object = "Account") soql <- "SELECT Id, Name FROM Account LIMIT 10" batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql) batch_status <- sf_batch_status_bulk(job_id = batch_query_info$jobId, batch_id = batch_query_info$id) job_close_ind <- sf_close_job_bulk(job_info$id) sf_get_job_bulk(job_info$id) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk(operation = "query", object = "Account") soql <- "SELECT Id, Name FROM Account LIMIT 10" batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql) batch_status <- sf_batch_status_bulk(job_id = batch_query_info$jobId, batch_id = batch_query_info$id) job_close_ind <- sf_close_job_bulk(job_info$id) sf_get_job_bulk(job_info$id) ## End(Not run)
This function closes a Job in the Salesforce Bulk API
sf_close_job_bulk( job_id, api_type = c("Bulk 1.0", "Bulk 2.0"), verbose = FALSE )
sf_close_job_bulk( job_id, api_type = c("Bulk 1.0", "Bulk 2.0"), verbose = FALSE )
job_id |
|
api_type |
|
verbose |
|
A list
of parameters defining the now closed job
This is a legacy function used only with Bulk 1.0.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 10" job_info <- sf_create_job_bulk(operation='query', object='Account') query_info <- sf_submit_query_bulk(job_id=job_info$id, soql=my_query) recordset <- sf_query_result_bulk(job_id = query_info$jobId, batch_id = query_info$id, result_id = result$result) sf_close_job_bulk(job_info$id) ## End(Not run)
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 10" job_info <- sf_create_job_bulk(operation='query', object='Account') query_info <- sf_submit_query_bulk(job_id=job_info$id, soql=my_query) recordset <- sf_query_result_bulk(job_id = query_info$jobId, batch_id = query_info$id, result_id = result$result) sf_close_job_bulk(job_info$id) ## End(Not run)
Typically only used internally by functions when control parameters are passed
through via dots (...), but it can be called directly to control the behavior
of API calls. This function behaves exactly like glm.control
for the glm
function.
sf_control( AllOrNoneHeader = list(allOrNone = FALSE), AllowFieldTruncationHeader = list(allowFieldTruncation = FALSE), AssignmentRuleHeader = list(useDefaultRule = TRUE), DisableFeedTrackingHeader = list(disableFeedTracking = FALSE), DuplicateRuleHeader = list(allowSave = FALSE, includeRecordDetails = FALSE, runAsCurrentUser = TRUE), EmailHeader = list(triggerAutoResponseEmail = FALSE, triggerOtherEmail = FALSE, triggerUserEmail = TRUE), LocaleOptions = list(language = "en_US"), MruHeader = list(updateMru = FALSE), OwnerChangeOptions = list(options = list(list(execute = TRUE, type = "EnforceNewOwnerHasReadAccess"), list(execute = FALSE, type = "KeepAccountTeam"), list(execute = FALSE, type = "KeepSalesTeam"), list(execute = FALSE, type = "KeepSalesTeamGrantCurrentOwnerReadWriteAccess"), list(execute = FALSE, type = "SendEmail"), list(execute = FALSE, type = "TransferAllOwnedCases"), list(execute = TRUE, type = "TransferContacts"), list(execute = TRUE, type = "TransferContracts"), list(execute = FALSE, type = "TransferNotesAndAttachments"), list(execute = TRUE, type = "TransferOpenActivities"), list(execute = TRUE, type = "TransferOrders"), list(execute = FALSE, type = "TransferOtherOpenOpportunities"), list(execute = FALSE, type = "TransferOwnedClosedOpportunities"), list(execute = FALSE, type = "TransferOwnedOpenCases"), list(execute = FALSE, type = "TransferOwnedOpenOpportunities"))), QueryOptions = list(batchSize = 500), UserTerritoryDeleteHeader = list(transferToUserId = NA), BatchRetryHeader = list(`Sforce-Disable-Batch-Retry` = FALSE), LineEndingHeader = list(`Sforce-Line-Ending` = NA), PKChunkingHeader = list(`Sforce-Enable-PKChunking` = FALSE), api_type = NULL, operation = NULL )
sf_control( AllOrNoneHeader = list(allOrNone = FALSE), AllowFieldTruncationHeader = list(allowFieldTruncation = FALSE), AssignmentRuleHeader = list(useDefaultRule = TRUE), DisableFeedTrackingHeader = list(disableFeedTracking = FALSE), DuplicateRuleHeader = list(allowSave = FALSE, includeRecordDetails = FALSE, runAsCurrentUser = TRUE), EmailHeader = list(triggerAutoResponseEmail = FALSE, triggerOtherEmail = FALSE, triggerUserEmail = TRUE), LocaleOptions = list(language = "en_US"), MruHeader = list(updateMru = FALSE), OwnerChangeOptions = list(options = list(list(execute = TRUE, type = "EnforceNewOwnerHasReadAccess"), list(execute = FALSE, type = "KeepAccountTeam"), list(execute = FALSE, type = "KeepSalesTeam"), list(execute = FALSE, type = "KeepSalesTeamGrantCurrentOwnerReadWriteAccess"), list(execute = FALSE, type = "SendEmail"), list(execute = FALSE, type = "TransferAllOwnedCases"), list(execute = TRUE, type = "TransferContacts"), list(execute = TRUE, type = "TransferContracts"), list(execute = FALSE, type = "TransferNotesAndAttachments"), list(execute = TRUE, type = "TransferOpenActivities"), list(execute = TRUE, type = "TransferOrders"), list(execute = FALSE, type = "TransferOtherOpenOpportunities"), list(execute = FALSE, type = "TransferOwnedClosedOpportunities"), list(execute = FALSE, type = "TransferOwnedOpenCases"), list(execute = FALSE, type = "TransferOwnedOpenOpportunities"))), QueryOptions = list(batchSize = 500), UserTerritoryDeleteHeader = list(transferToUserId = NA), BatchRetryHeader = list(`Sforce-Disable-Batch-Retry` = FALSE), LineEndingHeader = list(`Sforce-Line-Ending` = NA), PKChunkingHeader = list(`Sforce-Enable-PKChunking` = FALSE), api_type = NULL, operation = NULL )
AllOrNoneHeader |
|
AllowFieldTruncationHeader |
|
AssignmentRuleHeader |
|
DisableFeedTrackingHeader |
|
DuplicateRuleHeader |
|
EmailHeader |
|
LocaleOptions |
|
MruHeader |
|
OwnerChangeOptions |
|
QueryOptions |
|
UserTerritoryDeleteHeader |
|
BatchRetryHeader |
|
LineEndingHeader |
|
PKChunkingHeader |
|
api_type |
|
operation |
|
## Not run: this_control <- sf_control(DuplicateRuleHeader=list(allowSave=TRUE, includeRecordDetails=FALSE, runAsCurrentUser=TRUE)) new_contact <- c(FirstName = "Test", LastName = "Contact-Create") new_record <- sf_create(new_contact, "Contact", control = this_control) # specifying the controls directly and are picked up by dots new_record <- sf_create(new_contact, "Contact", DuplicateRuleHeader = list(allowSave=TRUE, includeRecordDetails=FALSE, runAsCurrentUser=TRUE)) ## End(Not run)
## Not run: this_control <- sf_control(DuplicateRuleHeader=list(allowSave=TRUE, includeRecordDetails=FALSE, runAsCurrentUser=TRUE)) new_contact <- c(FirstName = "Test", LastName = "Contact-Create") new_record <- sf_create(new_contact, "Contact", control = this_control) # specifying the controls directly and are picked up by dots new_record <- sf_create(new_contact, "Contact", DuplicateRuleHeader = list(allowSave=TRUE, includeRecordDetails=FALSE, runAsCurrentUser=TRUE)) ## End(Not run)
Converts Leads each into an Account, Contact, as well as (optionally) an Opportunity.
sf_convert_lead( input_data, guess_types = TRUE, api_type = c("SOAP"), control = list(...), ..., verbose = FALSE )
sf_convert_lead( input_data, guess_types = TRUE, api_type = c("SOAP"), control = list(...), ..., verbose = FALSE )
input_data |
|
guess_types |
|
api_type |
|
control |
|
... |
arguments passed to |
verbose |
|
When converting leads owned by a queue, the owner must be specified.
This is because accounts and contacts cannot be owned by a queue. Below is a
complete list of options to control the conversion process. Include a column
in your input data to specify an option for each record. For example, if you
want opportunities to not be created for each converted lead then add a column
in your input data called doNotCreateOpportunity
and set its value to
TRUE
. The default is FALSE
which creates opportunities. The order
of columns in the input data does not matter, just that the names
match (case-insensitive).
ID of the Lead to convert. Required.
Valid LeadStatus value for a converted lead. Required.
Id of the Account into which the lead will be merged. Required only when updating an existing account, including person accounts. If no accountId is specified, then the API creates a new account.
Id of the Contact into which the lead will be merged (this contact must be associated with the specified accountId, and an accountId must be specified). Required only when updating an existing contact. If no contactId is specified, then the API creates a new contact that is implicitly associated with the Account.
Specifies the Id of the person to own any newly created account, contact, and opportunity. If the client application does not specify this value, then the owner of the new object will be the owner of the lead.
The Id of an existing opportunity to relate to the lead.
The opportunityId and opportunityName arguments are mutually exclusive. Specifying
a value for both results in an error. If doNotCreateOpportunity argument is
TRUE
, then no Opportunity is created and this field must be left blank;
otherwise, an error is returned.
Specifies whether to create an Opportunity during
lead conversion (FALSE
, the default) or not (TRUE
). Set this flag
to TRUE
only if you do not want to create an opportunity from the lead.
An opportunity is created by default.
Name of the opportunity to create. If no name is specified,
then this value defaults to the company name of the lead. The maximum length
of this field is 80 characters. The opportunityId and opportunityName arguments
are mutually exclusive. Specifying a value for both results in an error. If
doNotCreateOpportunity argument is TRUE
, then no Opportunity is created and
this field must be left blank; otherwise, an error is returned.
Specifies whether to overwrite the LeadSource field
on the target Contact object with the contents of the LeadSource field in
the source Lead object (TRUE
), or not (FALSE
, the default). To
set this field to TRUE
, the client application must specify a contactId
for the target contact.
Specifies whether to send a notification email
to the owner specified in the ownerId (TRUE
) or not (FALSE
,
the default).
tbl_df
with details of the converted record
## Not run: # create a new lead at Grand Hotels & Resorts Ltd new_lead <- tibble(FirstName = "Test", LastName = "Prospect", Company = "Grand Hotels & Resorts Ltd") rec <- sf_create(new_lead, "Lead") # find the Id of matching account to link to acct_id <- sf_query("SELECT Id from Account WHERE name = 'Grand Hotels & Resorts Ltd' LIMIT 1") # create the row(s) for the leads to convert to_convert <- tibble(leadId = rec$id, convertedStatus = "Closed - Converted", accountId = acct_id$Id) converted_lead <- sf_convert_lead(to_convert) ## End(Not run)
## Not run: # create a new lead at Grand Hotels & Resorts Ltd new_lead <- tibble(FirstName = "Test", LastName = "Prospect", Company = "Grand Hotels & Resorts Ltd") rec <- sf_create(new_lead, "Lead") # find the Id of matching account to link to acct_id <- sf_query("SELECT Id from Account WHERE name = 'Grand Hotels & Resorts Ltd' LIMIT 1") # create the row(s) for the leads to convert to_convert <- tibble(leadId = rec$id, convertedStatus = "Closed - Converted", accountId = acct_id$Id) converted_lead <- sf_convert_lead(to_convert) ## End(Not run)
sf_copy_dashboard(dashboard_id, report_folder_id)
sf_copy_dashboard(dashboard_id, report_folder_id)
dashboard_id |
|
report_folder_id |
|
list
Creates a copy of a custom, standard, or public report by sending a POST request to the Report List resource.
sf_copy_report(report_id, name = NULL, verbose = FALSE)
sf_copy_report(report_id, name = NULL, verbose = FALSE)
report_id |
|
name |
|
verbose |
|
list
representing the newly cloned report with up to 4 properties
that describe the report:
Report type along with the URL to retrieve common objects and joined metadata.
Unique identifiers for groupings and summaries.
Fields in each section of a report type plus filter information for those fields.
Additional information about summaries and groupings.
Other Report functions:
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: # only the 200 most recently viewed reports most_recent_reports <- sf_report_list() # all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # id of the report to copy this_report_id <- all_reports$Id[1] # not providing a name appends " - Copy" to the name of the report being cloned report_details <- sf_copy_report(this_report_id) # example of providing new name to the copied report report_details <- sf_copy_report(this_report_id, "My New Copy of Report ABC") ## End(Not run)
## Not run: # only the 200 most recently viewed reports most_recent_reports <- sf_report_list() # all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # id of the report to copy this_report_id <- all_reports$Id[1] # not providing a name appends " - Copy" to the name of the report being cloned report_details <- sf_copy_report(this_report_id) # example of providing new name to the copied report report_details <- sf_copy_report(this_report_id, "My New Copy of Report ABC") ## End(Not run)
Adds one or more new records to your organization’s data.
sf_create( input_data, object_name, api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
sf_create( input_data, object_name, api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
input_data |
|
object_name |
|
api_type |
|
guess_types |
|
control |
|
... |
arguments passed to |
all_or_none |
|
verbose |
|
tbl_df
of records with success indicator
Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.
## Not run: n <- 2 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) new_recs1 <- sf_create(new_contacts, object_name = "Contact") # add control to allow the creation of records that violate a duplicate rules new_recs2 <- sf_create(new_contacts, object_name = "Contact", DuplicateRuleHeader=list(allowSave=TRUE, includeRecordDetails=FALSE, runAsCurrentUser=TRUE)) # example using the Bulk 1.0 API to insert records new_recs3 <- sf_create(new_contacts, object_name = "Contact", api_type = "Bulk 1.0") ## End(Not run)
## Not run: n <- 2 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) new_recs1 <- sf_create(new_contacts, object_name = "Contact") # add control to allow the creation of records that violate a duplicate rules new_recs2 <- sf_create(new_contacts, object_name = "Contact", DuplicateRuleHeader=list(allowSave=TRUE, includeRecordDetails=FALSE, runAsCurrentUser=TRUE)) # example using the Bulk 1.0 API to insert records new_recs3 <- sf_create(new_contacts, object_name = "Contact", api_type = "Bulk 1.0") ## End(Not run)
This function will allow you to create attachments (and other blob data, such as Documents) by supplying file paths (absolute or relative) to media that you would like to upload to Salesforce along with accompanying metadata, such as a Description, Keywords, ParentId, FolderId, etc.
sf_create_attachment( attachment_input_data, object_name = c("Attachment", "Document"), api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), control = list(...), ..., verbose = FALSE )
sf_create_attachment( attachment_input_data, object_name = c("Attachment", "Document"), api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), control = list(...), ..., verbose = FALSE )
attachment_input_data |
|
object_name |
|
api_type |
|
control |
|
... |
arguments passed to |
verbose |
|
tbl_df
with details of the created records
The length of any file name can’t exceed 512 bytes (per Bulk 1.0 API). The SOAP API create call restricts these files to a maximum size of 25 MB. For a file attached to a Solution, the limit is 1.5 MB. The maximum email attachment size is 3 MB. You can only create or update documents to a maximum size of 5 MB. The REST API allows you to insert or update blob data limited to 50 MB of text data or 37.5 MB of base64–encoded data.
Other Attachment functions:
check_and_encode_files()
,
sf_delete_attachment()
,
sf_download_attachment()
,
sf_update_attachment()
## Not run: # upload two PDFs from working directory to a particular record as Attachments file_path1 <- here::here("doc1.pdf") file_path2 <- here::here("doc2.pdf") parent_record_id <- "0036A000002C6MmQAK" attachment_details <- tibble(Body = c(file_path1, file_path2), ParentId = rep(parent_record_id, 2)) result <- sf_create_attachment(attachment_details) # the function supports inserting all blob content, just update the # object_name argument to add the PDF as a Document instead of an Attachment document_details <- tibble(Name = "doc1.pdf", Description = "Test Document 1", Body = file_path1, FolderId = "00l6A000001EgIwQAK", # replace with your FolderId! Keywords = "example,test,document") result <- sf_create_attachment(document_details, object_name = "Document") # the Bulk API can be invoked using api_type="Bulk 1.0" which will automatically # take a data.frame of Attachment info and create a ZIP file with CSV manifest # that is required for that API result <- sf_create_attachment(attachment_details, api_type="Bulk 1.0") ## End(Not run)
## Not run: # upload two PDFs from working directory to a particular record as Attachments file_path1 <- here::here("doc1.pdf") file_path2 <- here::here("doc2.pdf") parent_record_id <- "0036A000002C6MmQAK" attachment_details <- tibble(Body = c(file_path1, file_path2), ParentId = rep(parent_record_id, 2)) result <- sf_create_attachment(attachment_details) # the function supports inserting all blob content, just update the # object_name argument to add the PDF as a Document instead of an Attachment document_details <- tibble(Name = "doc1.pdf", Description = "Test Document 1", Body = file_path1, FolderId = "00l6A000001EgIwQAK", # replace with your FolderId! Keywords = "example,test,document") result <- sf_create_attachment(document_details, object_name = "Document") # the Bulk API can be invoked using api_type="Bulk 1.0" which will automatically # take a data.frame of Attachment info and create a ZIP file with CSV manifest # that is required for that API result <- sf_create_attachment(attachment_details, api_type="Bulk 1.0") ## End(Not run)
This function takes a data frame and submits it in batches to a an already existing Bulk API Job by chunking into temp files
sf_create_batches_bulk( job_id, input_data, batch_size = NULL, api_type = c("Bulk 1.0", "Bulk 2.0"), verbose = FALSE )
sf_create_batches_bulk( job_id, input_data, batch_size = NULL, api_type = c("Bulk 1.0", "Bulk 2.0"), verbose = FALSE )
job_id |
|
input_data |
|
batch_size |
|
api_type |
|
verbose |
|
a tbl_df
containing details of each batch
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: # NOTE THAT YOU MUST FIRST CREATE AN EXTERNAL ID FIELD CALLED My_External_Id # BEFORE RUNNING THIS EXAMPLE # inserting 2 records my_data <- tibble(Name=c('New Record 1', 'New Record 2'), My_External_Id__c=c('11111','22222')) job_info <- sf_create_job_bulk(operation='insert', object='Account') batches_ind <- sf_create_batches_bulk(job_id = job_info$id, input_data = my_data) # upserting 3 records my_data2 <- tibble(My_External_Id__c=c('11111','22222', '99999'), Name=c('Updated_Name1', 'Updated_Name2', 'Upserted_Record')) job_info <- sf_create_job_bulk(operation='upsert', externalIdFieldName='My_External_Id__c', object='Account') batches_ind <- sf_create_batches_bulk(job_id = job_info$id, input_data = my_data2) sf_get_job_bulk(job_info$id) ## End(Not run)
## Not run: # NOTE THAT YOU MUST FIRST CREATE AN EXTERNAL ID FIELD CALLED My_External_Id # BEFORE RUNNING THIS EXAMPLE # inserting 2 records my_data <- tibble(Name=c('New Record 1', 'New Record 2'), My_External_Id__c=c('11111','22222')) job_info <- sf_create_job_bulk(operation='insert', object='Account') batches_ind <- sf_create_batches_bulk(job_id = job_info$id, input_data = my_data) # upserting 3 records my_data2 <- tibble(My_External_Id__c=c('11111','22222', '99999'), Name=c('Updated_Name1', 'Updated_Name2', 'Upserted_Record')) job_info <- sf_create_job_bulk(operation='upsert', externalIdFieldName='My_External_Id__c', object='Account') batches_ind <- sf_create_batches_bulk(job_id = job_info$id, input_data = my_data2) sf_get_job_bulk(job_info$id) ## End(Not run)
This function initializes a Job in the Salesforce Bulk API
sf_create_job_bulk( operation = c("insert", "delete", "upsert", "update", "hardDelete", "query", "queryall"), object_name, soql = NULL, external_id_fieldname = NULL, api_type = c("Bulk 1.0", "Bulk 2.0"), content_type = c("CSV", "ZIP_CSV", "ZIP_XML", "ZIP_JSON"), concurrency_mode = c("Parallel", "Serial"), column_delimiter = c("COMMA", "TAB", "PIPE", "SEMICOLON", "CARET", "BACKQUOTE"), control = list(...), ..., line_ending = deprecated(), verbose = FALSE )
sf_create_job_bulk( operation = c("insert", "delete", "upsert", "update", "hardDelete", "query", "queryall"), object_name, soql = NULL, external_id_fieldname = NULL, api_type = c("Bulk 1.0", "Bulk 2.0"), content_type = c("CSV", "ZIP_CSV", "ZIP_XML", "ZIP_JSON"), concurrency_mode = c("Parallel", "Serial"), column_delimiter = c("COMMA", "TAB", "PIPE", "SEMICOLON", "CARET", "BACKQUOTE"), control = list(...), ..., line_ending = deprecated(), verbose = FALSE )
operation |
|
object_name |
|
soql |
|
external_id_fieldname |
|
api_type |
|
content_type |
|
concurrency_mode |
|
column_delimiter |
|
control |
|
... |
arguments passed to |
line_ending |
|
verbose |
|
A tbl_df
parameters defining the created job, including id
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: # insert into Account job_info <- sf_create_job_bulk(operation='insert', object_name='Account') # delete from Account job_info <- sf_create_job_bulk(operation='delete', object_name='Account') # update into Account job_info <- sf_create_job_bulk(operation='update', object_name='Account') # upsert into Account job_info <- sf_create_job_bulk(operation='upsert', externalIdFieldName='My_External_Id__c', object_name='Account') # insert attachments job_info <- sf_create_job_bulk(operation='insert', object_name='Attachment') # query leads job_info <- sf_create_job_bulk(operation='query', object_name='Lead') ## End(Not run)
## Not run: # insert into Account job_info <- sf_create_job_bulk(operation='insert', object_name='Account') # delete from Account job_info <- sf_create_job_bulk(operation='delete', object_name='Account') # update into Account job_info <- sf_create_job_bulk(operation='update', object_name='Account') # upsert into Account job_info <- sf_create_job_bulk(operation='upsert', externalIdFieldName='My_External_Id__c', object_name='Account') # insert attachments job_info <- sf_create_job_bulk(operation='insert', object_name='Attachment') # query leads job_info <- sf_create_job_bulk(operation='query', object_name='Lead') ## End(Not run)
This function takes a list of Metadata components and sends them to Salesforce for creation
sf_create_metadata( metadata_type, metadata, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
sf_create_metadata( metadata_type, metadata, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
metadata_type |
|
metadata |
|
control |
|
... |
arguments passed to |
all_or_none |
|
verbose |
|
A tbl_df
containing the creation result for each submitted metadata component
## Not run: # read the metadata of the existing Account object # we will use this object as a template to create a custom version metadata_info <- sf_read_metadata(metadata_type='CustomObject', object_names=c('Account')) custom_metadata <- metadata_info[[1]] # remove default actionOverrides, this cannot be set during creation custom_metadata[which(names(custom_metadata) %in% c("actionOverrides"))] <- NULL # remove fields since its a custom object and the standard ones no longer exist custom_metadata[which(names(custom_metadata) %in% c("fields"))] <- NULL # remove views so that we get the Standard List Views custom_metadata[which(names(custom_metadata) %in% c("listViews"))] <- NULL # remove links so that we get the Standard Web Links custom_metadata[which(names(custom_metadata) %in% c("webLinks"))] <- NULL # now make some adjustments to customize the object this_label <- 'Custom_Account43' custom_metadata$fullName <- paste0(this_label, '__c') custom_metadata$label <- this_label custom_metadata$pluralLabel <- paste0(this_label, 's') custom_metadata$nameField <- list(displayFormat='AN-{0000}', label='Account Number', type='AutoNumber') custom_metadata$fields <- list(fullName="Phone__c", label="Phone", type="Phone") # set the deployment status, this must be set before creation custom_metadata$deploymentStatus <- 'Deployed' # make a description to identify this easily in the UI setup tab custom_metadata$description <- 'created by the Metadata API' new_custom_object <- sf_create_metadata(metadata_type = 'CustomObject', metadata = custom_metadata, verbose = TRUE) # adding custom fields to our object # input formatted as a list custom_fields <- list(list(fullName='Custom_Account43__c.CustomField66__c', label='CustomField66', length=100, type='Text'), list(fullName='Custom_Account43__c.CustomField77__c', label='CustomField77', length=100, type='Text')) # formatted as a data.frame custom_fields <- data.frame(fullName=c('Custom_Account43__c.CustomField88__c', 'Custom_Account43__c.CustomField99__c'), label=c('Test Field1', 'Test Field2'), length=c(44,45), type=c('Text', 'Text')) new_custom_fields <- sf_create_metadata(metadata_type = 'CustomField', metadata = custom_fields) ## End(Not run)
## Not run: # read the metadata of the existing Account object # we will use this object as a template to create a custom version metadata_info <- sf_read_metadata(metadata_type='CustomObject', object_names=c('Account')) custom_metadata <- metadata_info[[1]] # remove default actionOverrides, this cannot be set during creation custom_metadata[which(names(custom_metadata) %in% c("actionOverrides"))] <- NULL # remove fields since its a custom object and the standard ones no longer exist custom_metadata[which(names(custom_metadata) %in% c("fields"))] <- NULL # remove views so that we get the Standard List Views custom_metadata[which(names(custom_metadata) %in% c("listViews"))] <- NULL # remove links so that we get the Standard Web Links custom_metadata[which(names(custom_metadata) %in% c("webLinks"))] <- NULL # now make some adjustments to customize the object this_label <- 'Custom_Account43' custom_metadata$fullName <- paste0(this_label, '__c') custom_metadata$label <- this_label custom_metadata$pluralLabel <- paste0(this_label, 's') custom_metadata$nameField <- list(displayFormat='AN-{0000}', label='Account Number', type='AutoNumber') custom_metadata$fields <- list(fullName="Phone__c", label="Phone", type="Phone") # set the deployment status, this must be set before creation custom_metadata$deploymentStatus <- 'Deployed' # make a description to identify this easily in the UI setup tab custom_metadata$description <- 'created by the Metadata API' new_custom_object <- sf_create_metadata(metadata_type = 'CustomObject', metadata = custom_metadata, verbose = TRUE) # adding custom fields to our object # input formatted as a list custom_fields <- list(list(fullName='Custom_Account43__c.CustomField66__c', label='CustomField66', length=100, type='Text'), list(fullName='Custom_Account43__c.CustomField77__c', label='CustomField77', length=100, type='Text')) # formatted as a data.frame custom_fields <- data.frame(fullName=c('Custom_Account43__c.CustomField88__c', 'Custom_Account43__c.CustomField99__c'), label=c('Test Field1', 'Test Field2'), length=c(44,45), type=c('Text', 'Text')) new_custom_fields <- sf_create_metadata(metadata_type = 'CustomField', metadata = custom_fields) ## End(Not run)
Create a new report using a POST request. To create a report, you only have to
specify a name and report type to create a new report; all other metadata properties
are optional. It is recommended to use the metadata from existing reports pulled
using sf_describe_report
as a guide on how to specify the properties
of a new report.
sf_create_report( name = NULL, report_type = NULL, report_metadata = NULL, verbose = FALSE )
sf_create_report( name = NULL, report_type = NULL, report_metadata = NULL, verbose = FALSE )
name |
|
report_type |
|
report_metadata |
|
verbose |
|
list
representing the newly cloned report with up to 4 properties
that describe the report:
Report type along with the URL to retrieve common objects and joined metadata.
Unique identifiers for groupings and summaries.
Fields in each section of a report type plus filter information for those fields.
Additional information about summaries and groupings.
Other Report functions:
sf_copy_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: # creating a blank report using just the name and type my_new_report <- sf_create_report("Top Accounts Report", "AccountList") # creating a report with additional metadata by grabbing an existing report # and modifying it slightly (only the name in this case) # first, grab all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # second, get the id of the report to copy this_report_id <- all_reports$Id[1] # third, pull down its metadata and update the name report_describe_list <- sf_describe_report(this_report_id) report_describe_list$reportMetadata$name <- "TEST API Report Creation" # fourth, create the report by passing the metadata my_new_report <- sf_create_report(report_metadata=report_describe_list) ## End(Not run)
## Not run: # creating a blank report using just the name and type my_new_report <- sf_create_report("Top Accounts Report", "AccountList") # creating a report with additional metadata by grabbing an existing report # and modifying it slightly (only the name in this case) # first, grab all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # second, get the id of the report to copy this_report_id <- all_reports$Id[1] # third, pull down its metadata and update the name report_describe_list <- sf_describe_report(this_report_id) report_describe_list$reportMetadata$name <- "TEST API Report Creation" # fourth, create the report by passing the metadata my_new_report <- sf_create_report(report_metadata=report_describe_list) ## End(Not run)
Deletes one or more records from your organization’s data.
sf_delete( ids, object_name = NULL, api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
sf_delete( ids, object_name = NULL, api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
ids |
|
object_name |
|
api_type |
|
guess_types |
|
control |
|
... |
arguments passed to |
all_or_none |
|
verbose |
|
tbl_df
of records with success indicator
Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.
## Not run: n <- 3 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) new_records <- sf_create(new_contacts, object_name="Contact") deleted_first <- sf_delete(new_records$id[1], object_name = "Contact") # add the control to do an "All or None" deletion of the remaining records deleted_rest <- sf_delete(new_records$id[2:3], object_name = "Contact", AllOrNoneHeader = list(allOrNone = TRUE)) ## End(Not run)
## Not run: n <- 3 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) new_records <- sf_create(new_contacts, object_name="Contact") deleted_first <- sf_delete(new_records$id[1], object_name = "Contact") # add the control to do an "All or None" deletion of the remaining records deleted_rest <- sf_delete(new_records$id[2:3], object_name = "Contact", AllOrNoneHeader = list(allOrNone = TRUE)) ## End(Not run)
This function is a wrapper around sf_delete
that accepts a list
of Ids and assumes that they are in the Attachment object and should be deleted.
This function is solely provided as a convenience and to provide the last
attachment function to parallel the CRUD functionality for all other records.
sf_delete_attachment( ids, object_name = c("Attachment"), api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), ..., verbose = FALSE )
sf_delete_attachment( ids, object_name = c("Attachment"), api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), ..., verbose = FALSE )
ids |
|
object_name |
|
api_type |
|
... |
arguments passed to |
verbose |
|
tbl_df
with details of the deleted records
Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.
Other Attachment functions:
check_and_encode_files()
,
sf_create_attachment()
,
sf_download_attachment()
,
sf_update_attachment()
## Not run: # upload a PDF to a particular record as an Attachment file_path <- system.file("extdata", "data-wrangling-cheatsheet.pdf", package = "salesforcer") parent_record_id <- "0036A000002C6MmQAK" # replace with your own ParentId! attachment_details <- tibble(Body = file_path, ParentId = parent_record_id) create_result <- sf_create_attachment(attachment_details) # now delete the attachment # note that the function below is just running the following! # sf_delete(ids = create_result$id) sf_delete_attachment(ids = create_result$id) ## End(Not run)
## Not run: # upload a PDF to a particular record as an Attachment file_path <- system.file("extdata", "data-wrangling-cheatsheet.pdf", package = "salesforcer") parent_record_id <- "0036A000002C6MmQAK" # replace with your own ParentId! attachment_details <- tibble(Body = file_path, ParentId = parent_record_id) create_result <- sf_create_attachment(attachment_details) # now delete the attachment # note that the function below is just running the following! # sf_delete(ids = create_result$id) sf_delete_attachment(ids = create_result$id) ## End(Not run)
sf_delete_dashboard(dashboard_id)
sf_delete_dashboard(dashboard_id)
dashboard_id |
|
logical
Delete Bulk API Job
sf_delete_job_bulk(job_id, api_type = c("Bulk 2.0"), verbose = FALSE)
sf_delete_job_bulk(job_id, api_type = c("Bulk 2.0"), verbose = FALSE)
job_id |
|
api_type |
|
verbose |
|
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') sf_abort_job_bulk(job_info$id) sf_delete_job_bulk(job_info$id) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') sf_abort_job_bulk(job_info$id) sf_delete_job_bulk(job_info$id) ## End(Not run)
This function takes a request of named elements in Salesforce and deletes them.
sf_delete_metadata( metadata_type, object_names, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
sf_delete_metadata( metadata_type, object_names, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
metadata_type |
|
object_names |
a character vector of names that we wish to read metadata for |
control |
|
... |
arguments passed to |
all_or_none |
|
verbose |
|
A data.frame
containing the creation result for each submitted metadata component
sf_list_metadata
, Salesforce Documentation
## Not run: metadata_info <- sf_delete_metadata(metadata_type = 'CustomObject', object_names = c('Custom_Account25__c')) ## End(Not run)
## Not run: metadata_info <- sf_delete_metadata(metadata_type = 'CustomObject', object_names = c('Custom_Account25__c')) ## End(Not run)
Delete a report by sending a DELETE request to the Report resource. Deleted reports are moved to the Recycle Bin.
sf_delete_report(report_id, verbose = FALSE)
sf_delete_report(report_id, verbose = FALSE)
report_id |
|
verbose |
|
logical
indicating whether the report was deleted. This function
will return TRUE
if successful in deleting the report.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: # first, grab all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # second, get the id of the report to delete this_report_id <- all_reports$Id[1] # third, delete that report using its Id success <- sf_delete_report(this_report_id) ## End(Not run)
## Not run: # first, grab all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # second, get the id of the report to delete this_report_id <- all_reports$Id[1] # third, delete that report using its Id success <- sf_delete_report(this_report_id) ## End(Not run)
If the given report instance has a status of Success
or Error
,
delete the report instance.
sf_delete_report_instance(report_id, report_instance_id, verbose = FALSE)
sf_delete_report_instance(report_id, report_instance_id, verbose = FALSE)
report_id |
|
report_instance_id |
|
verbose |
|
logical
indicating whether the report instance was deleted. This function
will return TRUE
if successful in deleting the report instance.
Other Report Instance functions:
sf_get_report_instance_results()
,
sf_list_report_instances()
## Not run: # first, get the Id of a report in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] # second, ensure that report has been executed at least once asynchronously results <- sf_execute_report(this_report_id, async=TRUE) # check if that report has succeeded, if so (or if it errored), then delete instance_list <- sf_list_report_instances(this_report_id) instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] ## End(Not run)
## Not run: # first, get the Id of a report in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] # second, ensure that report has been executed at least once asynchronously results <- sf_execute_report(this_report_id, async=TRUE) # check if that report has succeeded, if so (or if it errored), then delete instance_list <- sf_list_report_instances(this_report_id) instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] ## End(Not run)
Returns metadata for the specified dashboard, including dashboard components, filters, layout, and the running user.
sf_describe_dashboard(dashboard_id, as_tbl = TRUE, verbose = FALSE)
sf_describe_dashboard(dashboard_id, as_tbl = TRUE, verbose = FALSE)
dashboard_id |
|
as_tbl |
|
verbose |
|
list
or tbl_df
depending on the value of argument as_tbl
sf_describe_dashboard_components(dashboard_id, component_ids = c(character(0)))
sf_describe_dashboard_components(dashboard_id, component_ids = c(character(0)))
dashboard_id |
|
component_ids |
|
list
This function returns details about the organization metadata
sf_describe_metadata(verbose = FALSE)
sf_describe_metadata(verbose = FALSE)
verbose |
|
A tbl_df
https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta
## Not run: # describe metadata for the organization associated with the session metadata_info <- sf_describe_metadata() ## End(Not run)
## Not run: # describe metadata for the organization associated with the session metadata_info <- sf_describe_metadata() ## End(Not run)
This function takes the name of an object in Salesforce and returns a description of the fields on that object by returning a tibble with one row per field.
sf_describe_object_fields(object_name)
sf_describe_object_fields(object_name)
object_name |
|
A tbl_df
containing one row per field for the requested object.
The tibble only contains the fields that the user can view, as defined by the user's field-level security settings.
## Not run: acct_fields <- sf_describe_object_fields('Account') ## End(Not run)
## Not run: acct_fields <- sf_describe_object_fields('Account') ## End(Not run)
Describes the individual metadata for the specified object.
sf_describe_objects( object_names, api_type = c("SOAP", "REST"), control = list(...), ..., verbose = FALSE )
sf_describe_objects( object_names, api_type = c("SOAP", "REST"), control = list(...), ..., verbose = FALSE )
object_names |
|
api_type |
|
control |
|
... |
arguments passed to |
verbose |
|
list
REST API Documentation, REST API Example
## Not run: account_metadata <- sf_describe_objects("Account") account_metadata_SOAP <- sf_describe_objects("Account", api_type="SOAP") multiple_objs_metadata <- sf_describe_objects(c("Contact", "Lead")) account_metadata_REST <- sf_describe_objects("Account", api_type="REST") ## End(Not run)
## Not run: account_metadata <- sf_describe_objects("Account") account_metadata_SOAP <- sf_describe_objects("Account", api_type="SOAP") multiple_objs_metadata <- sf_describe_objects(c("Contact", "Lead")) account_metadata_REST <- sf_describe_objects("Account", api_type="REST") ## End(Not run)
Retrieves report, report type, and related metadata for a tabular, summary, or matrix report.
sf_describe_report(report_id, verbose = FALSE)
sf_describe_report(report_id, verbose = FALSE)
report_id |
|
verbose |
|
Report metadata gives information about the report as a whole. Tells you such things as, the report type, format, the fields that are summaries, row or column groupings, filters saved to the report, and so on.
Report type metadata tells you about all the fields available in the report type, those you can filter, and by what filter criteria.
Report extended metadata tells you about the fields that are summaries, groupings, and contain record details in the report.
list
containing up to 4 properties that describe the report:
Report type along with the URL to retrieve common objects and joined metadata.
Unique identifiers for groupings and summaries.
Fields in each section of a report type plus filter information for those fields.
Additional information about summaries and groupings.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: # pull a list of up to 200 recent reports # (for a full list you must use sf_query on the Report object) reports <- sf_list_reports() # id for the first report reports[[1,"id"]] # describe that report type described_report <- sf_describe_report_type(unique_report_types[[1,"id"]]) ## End(Not run)
## Not run: # pull a list of up to 200 recent reports # (for a full list you must use sf_query on the Report object) reports <- sf_list_reports() # id for the first report reports[[1,"id"]] # describe that report type described_report <- sf_describe_report_type(unique_report_types[[1,"id"]]) ## End(Not run)
Return metadata about a report type.
sf_describe_report_type(report_type, verbose = FALSE)
sf_describe_report_type(report_type, verbose = FALSE)
report_type |
|
verbose |
|
list
containing up to 4 properties that describe the report:
Report type along with the URL to retrieve common objects and joined metadata.
Unique identifiers for groupings and summaries.
Fields in each section of a report type plus filter information for those fields.
Additional information about summaries and groupings.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: reports <- sf_list_report_types() unique_report_types <- reports %>% distinct(reportTypes.type) # first unique report type unique_report_types[[1,1]] # describe that report type described_report <- sf_describe_report_type(unique_report_types[[1,1]]) ## End(Not run)
## Not run: reports <- sf_list_report_types() unique_report_types <- reports %>% distinct(reportTypes.type) # first unique report type unique_report_types[[1,1]] # describe that report type described_report <- sf_describe_report_type(unique_report_types[[1,1]]) ## End(Not run)
This function will allow you to download an attachment to disk based on the attachment body, file name, and path.
sf_download_attachment( body, name = NULL, sf_id = NULL, object_name = c("Attachment", "Document"), path = "." )
sf_download_attachment( body, name = NULL, sf_id = NULL, object_name = c("Attachment", "Document"), path = "." )
body |
|
name |
|
sf_id |
|
object_name |
|
path |
|
character
; invisibly return the file path of the downloaded
content
Other Attachment functions:
check_and_encode_files()
,
sf_create_attachment()
,
sf_delete_attachment()
,
sf_update_attachment()
## Not run: # downloading all attachments for a Parent record # if your attachment name doesn't include the extension, then you can use the # ContentType column to append it to the Name, if needed queried_attachments <- sf_query("SELECT Id, Body, Name, ContentType FROM Attachment WHERE ParentId = '0016A0000035mJ5'") mapply(sf_download_attachment, queried_attachments$Body, queried_attachments$Name) # downloading an attachment by its Id # (the file name will be the same as it exists in Salesforce) sf_download_attachment(sf_id = queried_attachments$Id[1]) ## End(Not run)
## Not run: # downloading all attachments for a Parent record # if your attachment name doesn't include the extension, then you can use the # ContentType column to append it to the Name, if needed queried_attachments <- sf_query("SELECT Id, Body, Name, ContentType FROM Attachment WHERE ParentId = '0016A0000035mJ5'") mapply(sf_download_attachment, queried_attachments$Body, queried_attachments$Name) # downloading an attachment by its Id # (the file name will be the same as it exists in Salesforce) sf_download_attachment(sf_id = queried_attachments$Id[1]) ## End(Not run)
Delete records from the recycle bin immediately and permanently.
sf_empty_recycle_bin(ids, api_type = c("SOAP"), verbose = FALSE)
sf_empty_recycle_bin(ids, api_type = c("SOAP"), verbose = FALSE)
ids |
|
api_type |
|
verbose |
|
When emptying recycle bins, consider the following rules and guidelines:
The logged in user can delete any record that he or she can query in their Recycle Bin, or the recycle bins of any subordinates. If the logged in user has Modify All Data permission, he or she can query and delete records from any Recycle Bin in the organization.
Do not include the IDs of any records that will be cascade deleted, or an error will occur.
Once records are deleted using this call, they cannot be undeleted using link{sf_undelete}
After records are deleted from the Recycle Bin using this call, they can be queried using the queryall
argument for some time. Typically this time is 24 hours, but may be shorter or longer.
tbl_df
of records with success indicator
https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_emptyrecyclebin.htm
## Not run: new_contact <- c(FirstName = "Test", LastName = "Contact") new_records <- sf_create(new_contact, object_name = "Contact") delete <- sf_delete(new_records$id[1], AllOrNoneHeader = list(allOrNone = TRUE)) is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", new_records$id[1]), queryall = TRUE) hard_deleted <- sf_empty_recycle_bin(new_records$id[1]) # confirm that the record really is gone (can't be deleted) undelete <- sf_undelete(new_records$id[1]) # if you use queryall you still will find the record for ~24hrs is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", new_records$id[1]), queryall = TRUE) # As of v48.0 (Spring 2020) you can query the Ids of all records in the Recycle # Bin, which makes it easier to clear the entire bin because you can grab the # Ids of the records first records_in_bin <- sf_query("SELECT Record FROM DeleteEvent") records_emptied_from_bin <- sf_delete(records_in_bin$Record) ## End(Not run)
## Not run: new_contact <- c(FirstName = "Test", LastName = "Contact") new_records <- sf_create(new_contact, object_name = "Contact") delete <- sf_delete(new_records$id[1], AllOrNoneHeader = list(allOrNone = TRUE)) is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", new_records$id[1]), queryall = TRUE) hard_deleted <- sf_empty_recycle_bin(new_records$id[1]) # confirm that the record really is gone (can't be deleted) undelete <- sf_undelete(new_records$id[1]) # if you use queryall you still will find the record for ~24hrs is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", new_records$id[1]), queryall = TRUE) # As of v48.0 (Spring 2020) you can query the Ids of all records in the Recycle # Bin, which makes it easier to clear the entire bin because you can grab the # Ids of the records first records_in_bin <- sf_query("SELECT Record FROM DeleteEvent") records_emptied_from_bin <- sf_delete(records_in_bin$Record) ## End(Not run)
Get summary data with or without details by running a report synchronously or
asynchronously through the API. When you run a report, the API returns data
for the same number of records that are available when the report is run in
the Salesforce user interface. Include the filters
argument in your
request to get specific results on the fly by passing dynamic filters,
groupings, and aggregates in the report metadata. Finally, you may want to
use sf_run_report
.
sf_execute_report( report_id, async = FALSE, include_details = TRUE, labels = TRUE, guess_types = TRUE, bind_using_character_cols = deprecated(), as_tbl = TRUE, report_metadata = NULL, verbose = FALSE )
sf_execute_report( report_id, async = FALSE, include_details = TRUE, labels = TRUE, guess_types = TRUE, bind_using_character_cols = deprecated(), as_tbl = TRUE, report_metadata = NULL, verbose = FALSE )
report_id |
|
async |
|
include_details |
|
labels |
|
guess_types |
|
bind_using_character_cols |
|
as_tbl |
|
report_metadata |
.
|
verbose |
|
Run a report synchronously if you expect it to finish running quickly. Otherwise, we recommend that you run reports through the API asynchronously for these reasons:
Long running reports have a lower risk of reaching the timeout limit when run asynchronously.
The 2-minute overall Salesforce API timeout limit doesn’t apply to asynchronous runs.
The Salesforce Reports and Dashboards REST API can handle a higher number of asynchronous run requests at a time.
Since the results of an asynchronously run report are stored for a 24-hr rolling period, they’re available for recurring access.
Before you filter a report, it helpful to check the following properties in the metadata that tell you if a field can be filtered, the values and criteria you can filter by, and filters that already exist in the report:
filterable
filterValues
dataTypeFilterOperatorMap
reportFilters
tbl_df
by default, but a list
when as_tbl=FALSE
,
which means that the content from the API is converted from JSON to a list
with no other post-processing.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: # first, get the Id of a report in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] # then execute a synchronous report that will wait for the results results <- sf_execute_report(this_report_id) # alternatively, you can execute an async report and then grab its results when done # - The benefit of an async report is that the results will be stored for up to # 24 hours for faster recall, if needed results <- sf_execute_report(this_report_id, async=TRUE) # check if completed and proceed if the status is "Success" instance_list <- sf_list_report_instances(report_id) instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] if(instance_status == "Success"){ results <- sf_get_report_instance_results(report_id, results$id) } # Note: For more complex execution use the report_metadata argument. # This can be done by building the list from scratch based on Salesforce # documentation (not recommended) or pulling down the existing reportMetadata # property of the report and modifying the list slightly (recommended). # In addition, for relatively simple changes, you can leverage the convenience # function sf_report_wrapper() which makes it easier to retrieve report results report_details <- sf_describe_report(this_report_id) report_metadata <- list(reportMetadata = report_details$reportMetadata) report_metadata$reportMetadata$showGrandTotal <- FALSE report_metadata$reportMetadata$showSubtotals <- FALSE fields <- sf_execute_report(this_report_id, report_metadata = report_metadata) ## End(Not run)
## Not run: # first, get the Id of a report in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] # then execute a synchronous report that will wait for the results results <- sf_execute_report(this_report_id) # alternatively, you can execute an async report and then grab its results when done # - The benefit of an async report is that the results will be stored for up to # 24 hours for faster recall, if needed results <- sf_execute_report(this_report_id, async=TRUE) # check if completed and proceed if the status is "Success" instance_list <- sf_list_report_instances(report_id) instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] if(instance_status == "Success"){ results <- sf_get_report_instance_results(report_id, results$id) } # Note: For more complex execution use the report_metadata argument. # This can be done by building the list from scratch based on Salesforce # documentation (not recommended) or pulling down the existing reportMetadata # property of the report and modifying the list slightly (recommended). # In addition, for relatively simple changes, you can leverage the convenience # function sf_report_wrapper() which makes it easier to retrieve report results report_details <- sf_describe_report(this_report_id) report_metadata <- list(reportMetadata = report_details$reportMetadata) report_metadata$reportMetadata$showGrandTotal <- FALSE report_metadata$reportMetadata$showSubtotals <- FALSE fields <- sf_execute_report(this_report_id, report_metadata = report_metadata) ## End(Not run)
sf_filter_dashboard_operators_list()
sf_filter_dashboard_operators_list()
list
sf_filter_dashboard_options_analysis( dashboard_id, filter_columns = list(), options = list() )
sf_filter_dashboard_options_analysis( dashboard_id, filter_columns = list(), options = list() )
dashboard_id |
|
filter_columns |
|
options |
|
list
Performs rule-based searches for duplicate records.
sf_find_duplicates( search_criteria, object_name, include_record_details = FALSE, guess_types = TRUE, verbose = FALSE )
sf_find_duplicates( search_criteria, object_name, include_record_details = FALSE, guess_types = TRUE, verbose = FALSE )
search_criteria |
|
object_name |
|
include_record_details |
|
guess_types |
|
verbose |
|
tbl_df
of records found to be duplicates by the match rules
You must have active duplicate rules for the supplied object before running
this function. The object_name
argument refers to using that object's duplicate
rules on the search criteria to determine which records in other objects are duplicates.
## Not run: # use the duplicate rules associated with the Lead object on the search # criteria (email) in order to find duplicates found_dupes <- sf_find_duplicates(search_criteria = list(Email="[email protected]"), object_name = "Lead") # now look for duplicates on email using the Contact object's rules found_dupes <- sf_find_duplicates(search_criteria = list(Email="[email protected]"), object_name = "Contact") ## End(Not run)
## Not run: # use the duplicate rules associated with the Lead object on the search # criteria (email) in order to find duplicates found_dupes <- sf_find_duplicates(search_criteria = list(Email="[email protected]"), object_name = "Lead") # now look for duplicates on email using the Contact object's rules found_dupes <- sf_find_duplicates(search_criteria = list(Email="[email protected]"), object_name = "Contact") ## End(Not run)
Performs rule-based searches for duplicate records.
sf_find_duplicates_by_id( sf_id, include_record_details = FALSE, guess_types = TRUE, verbose = FALSE )
sf_find_duplicates_by_id( sf_id, include_record_details = FALSE, guess_types = TRUE, verbose = FALSE )
sf_id |
|
include_record_details |
|
guess_types |
|
verbose |
|
tbl_df
of records found to be duplicates by the match rules
You must have active duplicate rules for the supplied object before running this function. This function uses the duplicate rules for the object that has the same type as the input record IDs. For example, if the record Id represents an Account, this function uses the duplicate rules associated with the Account object.
## Not run: # use the duplicate rules associated with the object that this record # belongs to in order to find duplicates found_dupes <- sf_find_duplicates_by_id(sf_id = "00Q6A00000aABCnZZZ") ## End(Not run)
## Not run: # use the duplicate rules associated with the object that this record # belongs to in order to find duplicates found_dupes <- sf_find_duplicates_by_id(sf_id = "00Q6A00000aABCnZZZ") ## End(Not run)
This function retrieves details about all Bulk jobs in the org.
sf_get_all_jobs_bulk( parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL), next_records_url = NULL, api_type = c("Bulk 2.0"), verbose = FALSE )
sf_get_all_jobs_bulk( parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL), next_records_url = NULL, api_type = c("Bulk 2.0"), verbose = FALSE )
parameterized_search_list |
list; a list of parameters to be added as part of the URL query string (i.e. after a question mark ("?") so that the result only returns information about jobs that meet that specific criteria. For more information, read the note below and/or the Salesforce documentation here. |
next_records_url |
character (leave as NULL); a string used internally by the function to paginate through to more records until complete |
api_type |
|
verbose |
|
A tbl_df
of parameters defining the details of all bulk jobs
parameterized_search_list elements that can be set to filter the results:
A logical either TRUE or FALSE. TRUE only returns information about jobs where PK Chunking has been enabled.
A character string to return jobs matching the specified type. Must be one of: "BigObjectIngest", "Classic", "V2QIngest". Classic corresponds to Bulk 1.0 API jobs and V2Ingest corresponds to the Bulk 2.0 API jobs.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/get_all_jobs.htm
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') all_jobs_info <- sf_get_all_jobs_bulk() # just the Bulk API 1.0 jobs all_jobs_info <- sf_get_all_jobs_bulk(parameterized_search_list=list(jobType='Classic')) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') all_jobs_info <- sf_get_all_jobs_bulk() # just the Bulk API 1.0 jobs all_jobs_info <- sf_get_all_jobs_bulk(parameterized_search_list=list(jobType='Classic')) ## End(Not run)
This function retrieves details about all Bulk query jobs in the org.
sf_get_all_query_jobs_bulk( parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL, concurrencyMode = NULL), next_records_url = NULL, api_type = c("Bulk 2.0"), verbose = FALSE )
sf_get_all_query_jobs_bulk( parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL, concurrencyMode = NULL), next_records_url = NULL, api_type = c("Bulk 2.0"), verbose = FALSE )
parameterized_search_list |
list; a list of parameters to be added as part of the URL query string (i.e. after a question mark ("?") so that the result only returns information about jobs that meet that specific criteria. For more information, read the note below and/or the Salesforce documentation here. |
next_records_url |
character (leave as NULL); a string used internally by the function to paginate through to more records until complete |
api_type |
|
verbose |
|
A tbl_df
of parameters defining the details of all bulk jobs
parameterized_search_list elements that can be set to filter the results:
A logical either TRUE or FALSE. TRUE only returns information about jobs where PK Chunking has been enabled.
A character string to return jobs matching the specified type. Must be one of: "BigObjectIngest", "Classic", "V2Query". Classic corresponds to Bulk 1.0 API jobs and V2Query corresponds to the Bulk 2.0 API jobs.
A character string to return jobs matching the specified concurrency mode. Must be one of: "serial" or "parallel", but only "serial" is currently supported.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/get_all_jobs.htm
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') all_query_jobs_info <- sf_get_all_query_jobs_bulk() # just the Bulk API 2.0 query jobs all_query_jobs_info <- sf_get_all_query_jobs_bulk(parameterized_search_list=list(jobType='V2Query')) # just the Bulk API 1.0 query jobs all_query_jobs_info <- sf_get_all_query_jobs_bulk(parameterized_search_list=list(jobType='Classic')) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') all_query_jobs_info <- sf_get_all_query_jobs_bulk() # just the Bulk API 2.0 query jobs all_query_jobs_info <- sf_get_all_query_jobs_bulk(parameterized_search_list=list(jobType='V2Query')) # just the Bulk API 1.0 query jobs all_query_jobs_info <- sf_get_all_query_jobs_bulk(parameterized_search_list=list(jobType='Classic')) ## End(Not run)
sf_get_dashboard_data( dashboard_id, running_user = NULL, dashboard_filters = c(character(0)) )
sf_get_dashboard_data( dashboard_id, running_user = NULL, dashboard_filters = c(character(0)) )
dashboard_id |
|
running_user |
|
dashboard_filters |
|
tbl_df
This function allows for pulling specific data from a dashboard. There is a
convenience function (sf_get_dashboard_data) to get the dashboard data
in a tabular format returned as a tbl_df
.
sf_get_dashboard_results( dashboard_id, running_user = NULL, dashboard_filters = c(character(0)) )
sf_get_dashboard_results( dashboard_id, running_user = NULL, dashboard_filters = c(character(0)) )
dashboard_id |
|
running_user |
|
dashboard_filters |
|
tbl_df
sf_get_dashboard_status( dashboard_id, running_user = NULL, dashboard_filters = c(character(0)) )
sf_get_dashboard_status( dashboard_id, running_user = NULL, dashboard_filters = c(character(0)) )
dashboard_id |
|
running_user |
|
dashboard_filters |
|
list
Retrieves the list of individual records that have been deleted within the given timespan for the specified object.
sf_get_deleted(object_name, start, end, verbose = FALSE)
sf_get_deleted(object_name, start, end, verbose = FALSE)
object_name |
|
start |
|
end |
|
verbose |
|
This API ignores the seconds portion of the supplied datetime values.
## Not run: # get all deleted Contact records from midnight until now deleted_recs <- sf_get_deleted("Contact", Sys.Date(), Sys.time()) ## End(Not run)
## Not run: # get all deleted Contact records from midnight until now deleted_recs <- sf_get_deleted("Contact", Sys.Date(), Sys.time()) ## End(Not run)
This function retrieves details about a Job in the Salesforce Bulk API
sf_get_job_bulk( job_id, api_type = c("Bulk 1.0", "Bulk 2.0"), query_operation = FALSE, verbose = FALSE )
sf_get_job_bulk( job_id, api_type = c("Bulk 1.0", "Bulk 2.0"), query_operation = FALSE, verbose = FALSE )
job_id |
|
api_type |
|
query_operation |
|
verbose |
|
A tbl_df
of parameters defining the details of the specified job id
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') refreshed_job_info <- sf_get_job_bulk(job_info$id) sf_abort_job_bulk(refreshed_job_info$id) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') refreshed_job_info <- sf_get_job_bulk(job_info$id) sf_abort_job_bulk(refreshed_job_info$id) ## End(Not run)
This function returns detailed (row-level) information on a job which has already been submitted completed (successfully or not).
sf_get_job_records_bulk( job_id, api_type = c("Bulk 1.0", "Bulk 2.0"), record_types = c("successfulResults", "failedResults", "unprocessedRecords"), combine_record_types = TRUE, verbose = FALSE )
sf_get_job_records_bulk( job_id, api_type = c("Bulk 1.0", "Bulk 2.0"), record_types = c("successfulResults", "failedResults", "unprocessedRecords"), combine_record_types = TRUE, verbose = FALSE )
job_id |
|
api_type |
|
record_types |
|
combine_record_types |
|
verbose |
|
A tbl_df
or list
of tbl_df
, formatted by Salesforce,
with information containing the success or failure or certain rows in a submitted job
With Bulk 2.0 the order of records in the response is not guaranteed to match the ordering of records in the original job data.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') input_data <- tibble(Name=c("Test Account 1", "Test Account 2")) batches_result <- sf_create_batches_bulk(job_info$id, input_data) # pause a few seconds for operation to finish. Wait longer if job is not complete. Sys.sleep(3) # check status using - sf_get_job_bulk(job_info$id) job_record_details <- sf_get_job_records_bulk(job_id=job_info$id) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk('insert', 'Account') input_data <- tibble(Name=c("Test Account 1", "Test Account 2")) batches_result <- sf_create_batches_bulk(job_info$id, input_data) # pause a few seconds for operation to finish. Wait longer if job is not complete. Sys.sleep(3) # check status using - sf_get_job_bulk(job_info$id) job_record_details <- sf_get_job_records_bulk(job_id=job_info$id) ## End(Not run)
Retrieves results for an instance of a report run asynchronously with or without filters. Depending on your asynchronous report run request, data can be at the summary level or include details.
sf_get_report_instance_results( report_id, report_instance_id, labels = TRUE, guess_types = TRUE, bind_using_character_cols = deprecated(), fact_map_key = "T!T", verbose = FALSE )
sf_get_report_instance_results( report_id, report_instance_id, labels = TRUE, guess_types = TRUE, bind_using_character_cols = deprecated(), fact_map_key = "T!T", verbose = FALSE )
report_id |
|
report_instance_id |
|
labels |
|
guess_types |
|
bind_using_character_cols |
|
fact_map_key |
|
verbose |
|
tbl_df
; the detail report data. More specifically, the detailed
data from the "T!T" entry in the fact map.
Below are the fact map key patterns for three report types:
T!T
: The grand total of a report. Both record data
values and the grand total are represented by this key.
<First level row grouping_second level row grouping_third
level row grouping>!T
: T refers to the row grand total.
<First level row grouping_second level row grouping>!<First
level column grouping_second level column grouping>.
Each item in a row or column grouping is numbered starting with 0. Here are some examples of fact map keys:
The first item in the first-level grouping.
The second item in the first-level grouping.
The first item in the first-level grouping and the first item in the second-level grouping.
The first item in the first-level grouping and the second item in the second-level grouping.
Other Report Instance functions:
sf_delete_report_instance()
,
sf_list_report_instances()
## Not run: # execute a report asynchronously in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] results <- sf_execute_report(this_report_id, async=TRUE) # check if that report has succeeded, ... instance_list <- sf_list_report_instances(this_report_id) instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] # ... if so, then grab the results if(instance_status == "Success"){ report_data <- sf_get_report_instance_results(report_id = this_report_id, report_instance_id = results$id) } ## End(Not run)
## Not run: # execute a report asynchronously in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] results <- sf_execute_report(this_report_id, async=TRUE) # check if that report has succeeded, ... instance_list <- sf_list_report_instances(this_report_id) instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] # ... if so, then grab the results if(instance_status == "Success"){ report_data <- sf_get_report_instance_results(report_id = this_report_id, report_instance_id = results$id) } ## End(Not run)
Retrieves the list of individual records that have been inserted or updated within the given timespan in the specified object.
sf_get_updated(object_name, start, end, verbose = FALSE)
sf_get_updated(object_name, start, end, verbose = FALSE)
object_name |
|
start |
|
end |
|
verbose |
|
This API ignores the seconds portion of the supplied datetime values.
## Not run: # get all updated Contact records from midnight until now updated_recs <- sf_get_updated("Contact", Sys.Date(), Sys.time()) ## End(Not run)
## Not run: # get all updated Contact records from midnight until now updated_recs <- sf_get_updated("Contact", Sys.Date(), Sys.time()) ## End(Not run)
This function checks on and returns status information on an existing batch which has already been submitted to Bulk API Job
sf_job_batches_bulk(job_id, api_type = c("Bulk 1.0"), verbose = FALSE)
sf_job_batches_bulk(job_id, api_type = c("Bulk 1.0"), verbose = FALSE)
job_id |
|
api_type |
|
verbose |
|
A tbl_df
of parameters defining the batch identified by the batch_id
This is a legacy function used only with Bulk 1.0.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: job_info <- sf_create_job_bulk(operation = "query", object = "Account") soql <- "SELECT Id, Name FROM Account LIMIT 10" batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql) submitted_batches <- sf_job_batches_bulk(job_id=batch_query_info$jobId) job_close_ind <- sf_close_job_bulk(job_info$id) sf_get_job_bulk(job_info$id) ## End(Not run)
## Not run: job_info <- sf_create_job_bulk(operation = "query", object = "Account") soql <- "SELECT Id, Name FROM Account LIMIT 10" batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql) submitted_batches <- sf_job_batches_bulk(job_id=batch_query_info$jobId) job_close_ind <- sf_close_job_bulk(job_info$id) sf_get_job_bulk(job_info$id) ## End(Not run)
Lists information about limits in your org.
sf_list_api_limits()
sf_list_api_limits()
list
This resource is available in REST API version 29.0 and later for API users with the View Setup and Configuration permission. The resource returns these limits:
Daily API calls
Daily asynchronous Apex method executions (batch Apex, future methods, queueable Apex, and scheduled Apex)
Daily Bulk API calls
Daily Streaming API events (API version 36.0 and earlier)
Daily durable Streaming API events (API version 37.0 and later)
Streaming API concurrent clients (API version 36.0 and earlier)
Durable Streaming API concurrent clients (API version 37.0 and later)
Daily generic streaming events (API version 36.0 and earlier)
Daily durable generic streaming events (API version 37.0 and later)
Daily number of mass emails that are sent to external email addresses by using Apex or APIs
Daily number of single emails that are sent to external email addresses by using Apex or APIs
Concurrent REST API requests for results of asynchronous report runs
Concurrent synchronous report runs via REST API
Hourly asynchronous report runs via REST API
Hourly synchronous report runs via REST API
Hourly dashboard refreshes via REST API
Hourly REST API requests for dashboard results
Hourly dashboard status requests via REST API
Daily workflow emails
Hourly workflow time triggers
Hourly OData callouts
Daily and active scratch org counts
Data storage (MB)
File storage (MB)
## Not run: sf_list_api_limits() ## End(Not run)
## Not run: sf_list_api_limits() ## End(Not run)
Returns a list of recently used dashboards
sf_list_dashboards(as_tbl = TRUE, verbose = FALSE)
sf_list_dashboards(as_tbl = TRUE, verbose = FALSE)
as_tbl |
|
verbose |
|
list
or tbl_df
depending on the value of argument as_tbl
This function takes a query of metadata types and returns a summary of all objects in salesforce of the requested types
sf_list_metadata(queries, verbose = FALSE)
sf_list_metadata(queries, verbose = FALSE)
queries |
a |
verbose |
|
A tbl_dfs
containing the queried metadata types
Only 3 queries can be specified at one time, so the list length must not exceed 3.
https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta
## Not run: # pull back a list of all Custom Objects and Email Templates my_queries <- list(list(type='CustomObject'), list(folder='unfiled$public', type='EmailTemplate')) metadata_info <- sf_list_metadata(queries=my_queries) ## End(Not run)
## Not run: # pull back a list of all Custom Objects and Email Templates my_queries <- list(list(type='CustomObject'), list(folder='unfiled$public', type='EmailTemplate')) metadata_info <- sf_list_metadata(queries=my_queries) ## End(Not run)
Lists the available objects and their metadata for your organization’s data.
sf_list_objects()
sf_list_objects()
list
## Not run: sf_list_objects() ## End(Not run)
## Not run: sf_list_objects() ## End(Not run)
The Report Fields resource returns report fields available for specified reports. Use the resource to determine the best fields for use in dashboard filters by seeing which fields different source reports have in common. Available in API version 40.0 and later.
sf_list_report_fields( report_id, intersect_with = c(character(0)), verbose = FALSE )
sf_list_report_fields( report_id, intersect_with = c(character(0)), verbose = FALSE )
report_id |
|
intersect_with |
|
verbose |
|
list
representing the 4 different field report properties:
Fields available when adding a filter.
Fields available for each specified report. Each object in this array is a list of common fields categorized by report type.
Map of each field’s API name to the index of the field in the equivalentFields
array.
Merged fields.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: # first, grab all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # second, get the id of the report to check fields on this_report_id <- all_reports$Id[1] # third, pull that report and intersect its fields with up to three other reports fields <- sf_list_report_fields(this_report_id, intersect_with=head(all_reports[["Id"]],3)) ## End(Not run)
## Not run: # first, grab all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # second, get the id of the report to check fields on this_report_id <- all_reports$Id[1] # third, pull that report and intersect its fields with up to three other reports fields <- sf_list_report_fields(this_report_id, intersect_with=head(all_reports[["Id"]],3)) ## End(Not run)
Use the Filter Operators API to get information about which filter operators are available for reports and dashboards. The Filter Operators API is available in API version 40.0 and later.
sf_list_report_filter_operators(as_tbl = TRUE, verbose = FALSE)
sf_list_report_filter_operators(as_tbl = TRUE, verbose = FALSE)
as_tbl |
|
verbose |
|
tbl_df
by default, or a list
depending on the value of
argument as_tbl
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: report_filters <- sf_list_report_filter_operators() unique_supported_fields <- report_filters %>% distinct(supported_field_type) # operators to filter a picklist field picklist_field_operators <- report_filters %>% filter(supported_field_type == "picklist") ## End(Not run)
## Not run: report_filters <- sf_list_report_filter_operators() unique_supported_fields <- report_filters %>% distinct(supported_field_type) # operators to filter a picklist field picklist_field_operators <- report_filters %>% filter(supported_field_type == "picklist") ## End(Not run)
Returns a list of instances for a report that you requested to be run asynchronously. Each item in the list is treated as a separate instance of the report run with metadata in that snapshot of time.
sf_list_report_instances(report_id, as_tbl = TRUE, verbose = FALSE)
sf_list_report_instances(report_id, as_tbl = TRUE, verbose = FALSE)
report_id |
|
as_tbl |
|
verbose |
|
tbl_df
by default, or a list
depending on the value of
argument as_tbl
Other Report Instance functions:
sf_delete_report_instance()
,
sf_get_report_instance_results()
## Not run: # first, get the Id of a report in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] # second, execute an async report results <- sf_execute_report(this_report_id, async=TRUE) # third, pull a list of async requests ("instances") usually meant for checking # if a recently requested report has succeeded and the results can be retrieved instance_list <- sf_list_report_instances(this_report_id) instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] ## End(Not run)
## Not run: # first, get the Id of a report in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] # second, execute an async report results <- sf_execute_report(this_report_id, async=TRUE) # third, pull a list of async requests ("instances") usually meant for checking # if a recently requested report has succeeded and the results can be retrieved instance_list <- sf_list_report_instances(this_report_id) instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] ## End(Not run)
Return a list of report types.
sf_list_report_types(as_tbl = TRUE, verbose = FALSE)
sf_list_report_types(as_tbl = TRUE, verbose = FALSE)
as_tbl |
|
verbose |
|
tbl_df
by default, or a list
depending on the value of
argument as_tbl
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: report_types <- sf_list_report_types() unique_report_types <- report_types %>% select(reportTypes.type) # return the results as a list reports_as_list <- sf_list_report_types(as_tbl=FALSE) ## End(Not run)
## Not run: report_types <- sf_list_report_types() unique_report_types <- report_types %>% select(reportTypes.type) # return the results as a list reports_as_list <- sf_list_report_types(as_tbl=FALSE) ## End(Not run)
Displays a list of full list of reports based on the Report
object. If
recent
is up to 200 tabular, matrix, or summary reports that you
recently viewed. To get additional details on reports by format, name, and other
fields, use a SOQL query on the Report object.
sf_list_reports(recent = FALSE, as_tbl = TRUE, verbose = FALSE)
sf_list_reports(recent = FALSE, as_tbl = TRUE, verbose = FALSE)
recent |
|
as_tbl |
|
verbose |
|
tbl_df
by default, or a list
depending on the value of
argument as_tbl
This function will only return up to 200 of recently viewed reports when the
recent
argument is set to TRUE
. For a complete details you must
use sf_query
on the report object.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run: # to return all possible reports, which is queried from the Report object reports <- sf_list_reports() # return the results as a list reports_as_list <- sf_list_reports(as_tbl=FALSE) # return up to 200 recently viewed reports all_reports <- sf_list_reports(recent=TRUE) ## End(Not run)
## Not run: # to return all possible reports, which is queried from the Report object reports <- sf_list_reports() # return the results as a list reports_as_list <- sf_list_reports(as_tbl=FALSE) # return up to 200 recently viewed reports all_reports <- sf_list_reports(recent=TRUE) ## End(Not run)
Lists available resources for the specified API version, including resource name and URI.
sf_list_resources()
sf_list_resources()
list
## Not run: sf_list_resources() ## End(Not run)
## Not run: sf_list_resources() ## End(Not run)
Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version\'s root
sf_list_rest_api_versions()
sf_list_rest_api_versions()
list
## Not run: sf_list_rest_api_versions() ## End(Not run)
## Not run: sf_list_rest_api_versions() ## End(Not run)
This function combines records of the same object type into one of the records, known as the master record. The other records, known as the victim records, will be deleted. If a victim record has related records the master record the new parent of the related records.
sf_merge( master_id, victim_ids, object_name, master_fields = character(0), api_type = c("SOAP"), control = list(...), ..., verbose = FALSE )
sf_merge( master_id, victim_ids, object_name, master_fields = character(0), api_type = c("SOAP"), control = list(...), ..., verbose = FALSE )
master_id |
|
victim_ids |
|
object_name |
|
master_fields |
|
api_type |
|
control |
|
... |
arguments passed to |
verbose |
|
tbl_df
of records with success indicator
## Not run: n <- 3 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n), Description = paste0("Description", 1:n)) new_recs1 <- sf_create(new_contacts, object_name = "Contact") # merge the second and third into the first record, but set the # description field equal to the description of the second. All other fields # will from the first record or, if blank, from the other records merge_res <- sf_merge(master_id = new_recs1$id[1], victim_ids = new_recs1$id[2:3], object_name = "Contact", master_fields = tibble("Description" = new_contacts$Description[2])) # check the second and third records now have the same Master Record Id as the first merge_check <- sf_query(sprintf("SELECT Id, MasterRecordId, Description FROM Contact WHERE Id IN ('%s')", paste0(new_recs1$id, collapse="','")), queryall = TRUE) ## End(Not run)
## Not run: n <- 3 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n), Description = paste0("Description", 1:n)) new_recs1 <- sf_create(new_contacts, object_name = "Contact") # merge the second and third into the first record, but set the # description field equal to the description of the second. All other fields # will from the first record or, if blank, from the other records merge_res <- sf_merge(master_id = new_recs1$id[1], victim_ids = new_recs1$id[2:3], object_name = "Contact", master_fields = tibble("Description" = new_contacts$Description[2])) # check the second and third records now have the same Master Record Id as the first merge_check <- sf_query(sprintf("SELECT Id, MasterRecordId, Description FROM Contact WHERE Id IN ('%s')", paste0(new_recs1$id, collapse="','")), queryall = TRUE) ## End(Not run)
Executes a query against the specified object and returns data that matches the specified criteria.
sf_query( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"), control = list(...), ..., page_size = deprecated(), next_records_url = NULL, bind_using_character_cols = deprecated(), object_name_append = FALSE, object_name_as_col = FALSE, verbose = FALSE )
sf_query( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"), control = list(...), ..., page_size = deprecated(), next_records_url = NULL, bind_using_character_cols = deprecated(), object_name_append = FALSE, object_name_as_col = FALSE, verbose = FALSE )
soql |
|
object_name |
|
queryall |
|
guess_types |
|
api_type |
|
control |
|
... |
arguments passed to |
page_size |
|
next_records_url |
|
bind_using_character_cols |
|
object_name_append |
|
object_name_as_col |
|
verbose |
|
tbl_df
of records
Bulk API query doesn't support the following SOQL:
COUNT
ROLLUP
SUM
GROUP BY CUBE
OFFSET
Nested SOQL queries
Relationship fields
Additionally, Bulk API can't access or query compound address or compound geolocation fields.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: sf_query("SELECT Id, Account.Name, Email FROM Contact LIMIT 10") ## End(Not run)
## Not run: sf_query("SELECT Id, Account.Name, Email FROM Contact LIMIT 10") ## End(Not run)
This function is a convenience wrapper for submitting and retrieving query API jobs from the Bulk 1.0 API.
sf_query_bulk_v1( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, bind_using_character_cols = deprecated(), interval_seconds = 3, max_attempts = 200, control = list(...), ..., api_type = "Bulk 1.0", verbose = FALSE )
sf_query_bulk_v1( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, bind_using_character_cols = deprecated(), interval_seconds = 3, max_attempts = 200, control = list(...), ..., api_type = "Bulk 1.0", verbose = FALSE )
soql |
|
object_name |
|
queryall |
|
guess_types |
|
bind_using_character_cols |
|
interval_seconds |
|
max_attempts |
|
control |
|
... |
other arguments passed on to |
api_type |
|
verbose |
|
A tbl_df
of the recordset returned by the query
## Not run: # select all Ids from Account object (up to 1000) ids <- sf_query_bulk_v1(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account') # alternatively you can specify as ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account', api_type="Bulk 1.0") ## End(Not run)
## Not run: # select all Ids from Account object (up to 1000) ids <- sf_query_bulk_v1(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account') # alternatively you can specify as ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account', api_type="Bulk 1.0") ## End(Not run)
This function is a convenience wrapper for submitting and retrieving query API jobs from the Bulk 2.0 API.
sf_query_bulk_v2( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, bind_using_character_cols = deprecated(), interval_seconds = 3, max_attempts = 200, control = list(...), ..., api_type = "Bulk 2.0", verbose = FALSE )
sf_query_bulk_v2( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, bind_using_character_cols = deprecated(), interval_seconds = 3, max_attempts = 200, control = list(...), ..., api_type = "Bulk 2.0", verbose = FALSE )
soql |
|
object_name |
|
queryall |
|
guess_types |
|
bind_using_character_cols |
|
interval_seconds |
|
max_attempts |
|
control |
|
... |
other arguments passed on to |
api_type |
|
verbose |
|
A tbl_df
of the recordset returned by the query
## Not run: # select all Ids from Account object (up to 1000) ids <- sf_query_bulk_v2(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account') # alternatively you can specify as ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account', api_type="Bulk 2.0") ## End(Not run)
## Not run: # select all Ids from Account object (up to 1000) ids <- sf_query_bulk_v2(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account') # alternatively you can specify as ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account', api_type="Bulk 2.0") ## End(Not run)
Run a report without creating a new report or changing the existing one by making a POST request to the query resource. This allows you to get report data without filling up your Org with unnecessary reports.
sf_query_report(report_id, report_metadata = NULL, verbose = FALSE)
sf_query_report(report_id, report_metadata = NULL, verbose = FALSE)
report_id |
|
report_metadata |
.
|
verbose |
|
Note that you can query a report's data simply by providing its Id
.
However, the data will only be the detailed data from the tabular format
with no totals or other metadata. If you would like more control, for example,
filtering the results or grouping them in specific ways, then you will need
to specify a list to the report_metadata
argument. The report_metadata
argument requires specific knowledge on the structure the reportMetadata
property of a report. For more information, please review the Salesforce documentation
in detail HERE.
Additional references are provided in the "See Also"
section.
tbl_df
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_run_report()
,
sf_update_report()
This function returns the recordset of a bulk query which has already been submitted to the Bulk 1.0 or Bulk 2.0 API and has completed.
sf_query_result_bulk( job_id, batch_id = NULL, result_id = NULL, guess_types = TRUE, bind_using_character_cols = deprecated(), batch_size = 50000, api_type = c("Bulk 1.0", "Bulk 2.0"), verbose = FALSE )
sf_query_result_bulk( job_id, batch_id = NULL, result_id = NULL, guess_types = TRUE, bind_using_character_cols = deprecated(), batch_size = 50000, api_type = c("Bulk 1.0", "Bulk 2.0"), verbose = FALSE )
job_id |
|
batch_id |
|
result_id |
|
guess_types |
|
bind_using_character_cols |
|
batch_size |
|
api_type |
|
verbose |
|
tbl_df
, formatted by Salesforce, containing query results
Bulk 1.0 documentation and Bulk 2.0 documentation
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 1000" job_info <- sf_create_job_bulk(operation = 'query', object = 'Account') query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query) result <- sf_batch_details_bulk(job_id = query_info$jobId, batch_id = query_info$id) recordset <- sf_query_result_bulk(job_id = query_info$jobId, batch_id = query_info$id, result_id = result$result) sf_close_job_bulk(job_info$id) ## End(Not run)
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 1000" job_info <- sf_create_job_bulk(operation = 'query', object = 'Account') query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query) result <- sf_batch_details_bulk(job_id = query_info$jobId, batch_id = query_info$id) recordset <- sf_query_result_bulk(job_id = query_info$jobId, batch_id = query_info$id, result_id = result$result) sf_close_job_bulk(job_info$id) ## End(Not run)
This function returns the row-level recordset of a Bulk 1.0 query which has already been submitted to Bulk API Job and has Completed state
sf_query_result_bulk_v1( job_id, batch_id = NULL, result_id = NULL, guess_types = TRUE, bind_using_character_cols = deprecated(), api_type = c("Bulk 1.0"), verbose = FALSE )
sf_query_result_bulk_v1( job_id, batch_id = NULL, result_id = NULL, guess_types = TRUE, bind_using_character_cols = deprecated(), api_type = c("Bulk 1.0"), verbose = FALSE )
job_id |
|
batch_id |
|
result_id |
|
guess_types |
|
bind_using_character_cols |
|
api_type |
|
verbose |
|
tbl_df
, formatted by Salesforce, containing query results
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 1000" job_info <- sf_create_job_bulk(operation = 'query', object = 'Account', api_type="Bulk 1.0") query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query, api_type="Bulk 1.0") result <- sf_batch_details_bulk(job_id = query_info$jobId, batch_id = query_info$id) recordset <- sf_query_result_bulk(job_id = query_info$jobId, batch_id = query_info$id, result_id = result$result) sf_close_job_bulk(job_info$id, api_type="Bulk 1.0") ## End(Not run)
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 1000" job_info <- sf_create_job_bulk(operation = 'query', object = 'Account', api_type="Bulk 1.0") query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query, api_type="Bulk 1.0") result <- sf_batch_details_bulk(job_id = query_info$jobId, batch_id = query_info$id) recordset <- sf_query_result_bulk(job_id = query_info$jobId, batch_id = query_info$id, result_id = result$result) sf_close_job_bulk(job_info$id, api_type="Bulk 1.0") ## End(Not run)
This function returns the row-level recordset of a Bulk 2.0 query which has already been submitted as a Bulk 2.0 API job and has a JobComplete state.
sf_query_result_bulk_v2( job_id, guess_types = TRUE, bind_using_character_cols = deprecated(), batch_size = 50000, locator = NULL, api_type = c("Bulk 2.0"), verbose = FALSE )
sf_query_result_bulk_v2( job_id, guess_types = TRUE, bind_using_character_cols = deprecated(), batch_size = 50000, locator = NULL, api_type = c("Bulk 2.0"), verbose = FALSE )
job_id |
|
guess_types |
|
bind_using_character_cols |
|
batch_size |
|
locator |
|
api_type |
|
verbose |
|
tbl_df
, formatted by Salesforce, containing query results
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 1000" job_info <- sf_create_job_bulk(operation = 'query', object = 'Account', api_type="Bulk 2.0") query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query, api_type="Bulk 2.0") result <- sf_batch_details_bulk(job_id = query_info$jobId, batch_id = query_info$id) recordset <- sf_query_result_bulk(job_id = query_info$jobId, batch_id = query_info$id, result_id = result$result) sf_close_job_bulk(job_info$id, api_type="Bulk 2.0") ## End(Not run)
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 1000" job_info <- sf_create_job_bulk(operation = 'query', object = 'Account', api_type="Bulk 2.0") query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query, api_type="Bulk 2.0") result <- sf_batch_details_bulk(job_id = query_info$jobId, batch_id = query_info$id) recordset <- sf_query_result_bulk(job_id = query_info$jobId, batch_id = query_info$id, result_id = result$result) sf_close_job_bulk(job_info$id, api_type="Bulk 2.0") ## End(Not run)
This function takes a request of named elements in Salesforce and returns their metadata
sf_read_metadata(metadata_type, object_names, verbose = FALSE)
sf_read_metadata(metadata_type, object_names, verbose = FALSE)
metadata_type |
|
object_names |
a character vector of names that we wish to read metadata for |
verbose |
|
A list
containing a response for each requested object
https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta
## Not run: metadata_info <- sf_read_metadata(metadata_type='CustomObject', object_names=c('Account')) ## End(Not run)
## Not run: metadata_info <- sf_read_metadata(metadata_type='CustomObject', object_names=c('Account')) ## End(Not run)
sf_refresh_dashboard(dashboard_id, dashboard_filters = c(character(0)))
sf_refresh_dashboard(dashboard_id, dashboard_filters = c(character(0)))
dashboard_id |
|
dashboard_filters |
|
list
This function takes an old and new name for a metadata element in Salesforce and applies the new name
sf_rename_metadata(metadata_type, old_fullname, new_fullname, verbose = FALSE)
sf_rename_metadata(metadata_type, old_fullname, new_fullname, verbose = FALSE)
metadata_type |
|
old_fullname |
|
new_fullname |
|
verbose |
|
A data.frame
containing the creation result for each submitted metadata component
https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta
## Not run: renamed_custom_object <- sf_rename_metadata(metadata_type = 'CustomObject', old_fullname = 'Custom_Account32__c', new_fullname = 'Custom_Account99__c') ## End(Not run)
## Not run: renamed_custom_object <- sf_rename_metadata(metadata_type = 'CustomObject', old_fullname = 'Custom_Account32__c', new_fullname = 'Custom_Account99__c') ## End(Not run)
sf_report_folder_children(report_folder_id, page_size = 10, page = NULL)
sf_report_folder_children(report_folder_id, page_size = 10, page = NULL)
report_folder_id |
|
page_size |
|
page |
|
sf_report_folder_create(body)
sf_report_folder_create(body)
body |
|
list
sf_report_folder_delete(report_folder_id)
sf_report_folder_delete(report_folder_id)
report_folder_id |
|
logical
sf_report_folder_describe(report_folder_id)
sf_report_folder_describe(report_folder_id)
report_folder_id |
|
list
sf_report_folder_update(report_folder_id, body)
sf_report_folder_update(report_folder_id, body)
report_folder_id |
|
body |
|
list
Changes a user’s password to a temporary, system-generated value.
sf_reset_password(user_id, control = list(...), ..., verbose = FALSE)
sf_reset_password(user_id, control = list(...), ..., verbose = FALSE)
user_id |
|
control |
|
... |
arguments passed to |
verbose |
|
list
## Not run: # reset a user's password and ensure that an email is triggered to them sf_reset_password(user_id = "0056A000000ZZZaaBBB", EmailHeader = list(triggerAutoResponseEmail = FALSE, triggerOtherEmail = FALSE, triggerUserEmail = TRUE)) ## End(Not run)
## Not run: # reset a user's password and ensure that an email is triggered to them sf_reset_password(user_id = "0056A000000ZZZaaBBB", EmailHeader = list(triggerAutoResponseEmail = FALSE, triggerOtherEmail = FALSE, triggerUserEmail = TRUE)) ## End(Not run)
Retrieves one or more new records to your organization’s data.
sf_retrieve( ids, fields, object_name, api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., verbose = FALSE )
sf_retrieve( ids, fields, object_name, api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., verbose = FALSE )
ids |
|
fields |
|
object_name |
|
api_type |
|
guess_types |
|
control |
|
... |
arguments passed to |
verbose |
|
tibble
## Not run: n <- 3 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) new_contacts_result <- sf_create(new_contacts, object_name="Contact") retrieved_records <- sf_retrieve(ids=new_contacts_result$id, fields=c("LastName"), object_name="Contact") ## End(Not run)
## Not run: n <- 3 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) new_contacts_result <- sf_create(new_contacts, object_name="Contact") retrieved_records <- sf_retrieve(ids=new_contacts_result$id, fields=c("LastName"), object_name="Contact") ## End(Not run)
This function makes a request to retrieve metadata as a package XML files that can be modified and later deployed into an environment
sf_retrieve_metadata( retrieve_request, filename = "package.zip", check_interval = 3, max_tries = 20, verbose = FALSE )
sf_retrieve_metadata( retrieve_request, filename = "package.zip", check_interval = 3, max_tries = 20, verbose = FALSE )
retrieve_request |
a |
filename |
a file path to save the zip file in the event that it is downloaded. The name must have a .zip extension. The default behavior will be to save in the current working directory as "package.zip" |
check_interval |
|
max_tries |
|
verbose |
|
A list
of details from the created retrieve request
See the Salesforce documentation for the proper arguments to create a retrieveRequest. Here is a link to that documentation: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve_request.htm
https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm
## Not run: retrieve_request <- list(unpackaged=list(types=list(members='*', name='CustomObject'))) retrieve_info <- sf_retrieve_metadata(retrieve_request) ## End(Not run)
## Not run: retrieve_request <- list(unpackaged=list(types=list(members='*', name='CustomObject'))) retrieve_info <- sf_retrieve_metadata(retrieve_request) ## End(Not run)
This function is a convenience wrapper for submitting bulk API jobs
sf_run_bulk_operation( input_data, object_name, operation = c("insert", "delete", "upsert", "update", "hardDelete"), external_id_fieldname = NULL, guess_types = TRUE, api_type = c("Bulk 1.0", "Bulk 2.0"), batch_size = NULL, interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, record_types = c("successfulResults", "failedResults", "unprocessedRecords"), combine_record_types = TRUE, control = list(...), ..., verbose = FALSE ) sf_bulk_operation( input_data, object_name, operation = c("insert", "delete", "upsert", "update", "hardDelete"), external_id_fieldname = NULL, guess_types = TRUE, api_type = c("Bulk 1.0", "Bulk 2.0"), batch_size = NULL, interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, record_types = c("successfulResults", "failedResults", "unprocessedRecords"), combine_record_types = TRUE, control = list(...), ..., verbose = FALSE )
sf_run_bulk_operation( input_data, object_name, operation = c("insert", "delete", "upsert", "update", "hardDelete"), external_id_fieldname = NULL, guess_types = TRUE, api_type = c("Bulk 1.0", "Bulk 2.0"), batch_size = NULL, interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, record_types = c("successfulResults", "failedResults", "unprocessedRecords"), combine_record_types = TRUE, control = list(...), ..., verbose = FALSE ) sf_bulk_operation( input_data, object_name, operation = c("insert", "delete", "upsert", "update", "hardDelete"), external_id_fieldname = NULL, guess_types = TRUE, api_type = c("Bulk 1.0", "Bulk 2.0"), batch_size = NULL, interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, record_types = c("successfulResults", "failedResults", "unprocessedRecords"), combine_record_types = TRUE, control = list(...), ..., verbose = FALSE )
input_data |
|
object_name |
|
operation |
|
external_id_fieldname |
|
guess_types |
|
api_type |
|
batch_size |
|
interval_seconds |
|
max_attempts |
|
wait_for_results |
|
record_types |
|
combine_record_types |
|
control |
|
... |
other arguments passed on to |
verbose |
|
A tbl_df
of the results of the bulk job
With Bulk 2.0 the order of records in the response is not guaranteed to match the ordering of records in the original job data.
## Not run: n <- 20 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) # insert new records into the Contact object inserts <- sf_bulk_operation(input_data = new_contacts, object_name = "Contact", operation = "insert") ## End(Not run)
## Not run: n <- 20 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) # insert new records into the Contact object inserts <- sf_bulk_operation(input_data = new_contacts, object_name = "Contact", operation = "insert") ## End(Not run)
This function is a convenience wrapper for submitting and retrieving query API jobs from the Bulk 1.0 and Bulk 2.0 APIs.
sf_run_bulk_query( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, bind_using_character_cols = deprecated(), interval_seconds = 3, max_attempts = 200, control = list(...), ..., api_type = c("Bulk 2.0", "Bulk 1.0"), verbose = FALSE ) sf_query_bulk( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, bind_using_character_cols = deprecated(), interval_seconds = 3, max_attempts = 200, control = list(...), ..., api_type = c("Bulk 2.0", "Bulk 1.0"), verbose = FALSE )
sf_run_bulk_query( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, bind_using_character_cols = deprecated(), interval_seconds = 3, max_attempts = 200, control = list(...), ..., api_type = c("Bulk 2.0", "Bulk 1.0"), verbose = FALSE ) sf_query_bulk( soql, object_name = NULL, queryall = FALSE, guess_types = TRUE, bind_using_character_cols = deprecated(), interval_seconds = 3, max_attempts = 200, control = list(...), ..., api_type = c("Bulk 2.0", "Bulk 1.0"), verbose = FALSE )
soql |
|
object_name |
|
queryall |
|
guess_types |
|
bind_using_character_cols |
|
interval_seconds |
|
max_attempts |
|
control |
|
... |
other arguments passed on to |
api_type |
|
verbose |
|
A tbl_df
of the recordset returned by the query
Bulk 1.0 documentation and Bulk 2.0 documentation
## Not run: # select all Ids from Account object (up to 1000) ids <- sf_query_bulk(soql = 'SELECT Id FROM Account LIMIT 1000') # note that, by default, bulk queries are executed using the Bulk 2.0 API, which # does not required the object name, but the Bulk 1.0 API can be still be invoked # for queries by setting api_type="Bulk 1.0". # alternatively you can specify as: ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', api_type = "Bulk 2.0") ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account', api_type = "Bulk 1.0") ## End(Not run)
## Not run: # select all Ids from Account object (up to 1000) ids <- sf_query_bulk(soql = 'SELECT Id FROM Account LIMIT 1000') # note that, by default, bulk queries are executed using the Bulk 2.0 API, which # does not required the object name, but the Bulk 1.0 API can be still be invoked # for queries by setting api_type="Bulk 1.0". # alternatively you can specify as: ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', api_type = "Bulk 2.0") ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', object_name = 'Account', api_type = "Bulk 1.0") ## End(Not run)
This function is a convenience wrapper for retrieving the data from a report.
By default, it executes an asynchronous report and waits for the detailed data
summarized in a tabular format, before pulling them down and returning as a
tbl_df
.
sf_run_report( report_id, report_filters = NULL, report_boolean_logic = NULL, sort_by = character(0), decreasing = FALSE, top_n = NULL, async = TRUE, interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, guess_types = TRUE, bind_using_character_cols = deprecated(), fact_map_key = "T!T", verbose = FALSE )
sf_run_report( report_id, report_filters = NULL, report_boolean_logic = NULL, sort_by = character(0), decreasing = FALSE, top_n = NULL, async = TRUE, interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, guess_types = TRUE, bind_using_character_cols = deprecated(), fact_map_key = "T!T", verbose = FALSE )
report_id |
|
report_filters |
|
report_boolean_logic |
|
sort_by |
|
decreasing |
|
top_n |
|
async |
|
interval_seconds |
|
max_attempts |
|
wait_for_results |
|
guess_types |
|
bind_using_character_cols |
|
fact_map_key |
|
verbose |
|
This function is essentially a wrapper around sf_execute_report
.
Please review or use that function and/or sf_query_report
if you
want to have more control over how the report is run and what format should
be returned. In this case we've forced the reportFormat="TABULAR"
without total rows and given options to filter, and select the Top N as
function arguments rather than forcing the user to create an entire list of
reportMetadata
.
tbl_df
Below are the fact map key patterns for three report types:
T!T
: The grand total of a report. Both record data
values and the grand total are represented by this key.
<First level row grouping_second level row grouping_third
level row grouping>!T
: T refers to the row grand total.
<First level row grouping_second level row grouping>!<First
level column grouping_second level column grouping>.
Each item in a row or column grouping is numbered starting with 0. Here are some examples of fact map keys:
The first item in the first-level grouping.
The second item in the first-level grouping.
The first item in the first-level grouping and the first item in the second-level grouping.
The first item in the first-level grouping and the second item in the second-level grouping.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_update_report()
## Not run: # find a report in your org and run it all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] results <- sf_run_report(this_report_id) # apply your own filters to that same report # set up some filters, if needed # filter records that was created before this month filter1 <- list(column = "CREATED_DATE", operator = "lessThan", value = "THIS_MONTH") # filter records where the account billing address city is not empty filter2 <- list(column = "ACCOUNT.ADDRESS1_CITY", operator = "notEqual", value = "") # combine filter1 and filter2 using 'AND' so that records must meet both filters results_using_AND <- sf_run_report(my_report_id, report_boolean_logic = "1 AND 2", report_filters = list(filter1, filter2)) # combine filter1 and filter2 using 'OR' which means that records must meet one # of the filters but also throw in a row limit based on a specific sort order results_using_OR <- sf_run_report(my_report_id, report_boolean_logic = "1 OR 2", report_filters = list(filter1, filter2), sort_by = "Contact.test_number__c", decreasing = TRUE, top_n = 5) ## End(Not run)
## Not run: # find a report in your org and run it all_reports <- sf_query("SELECT Id, Name FROM Report") this_report_id <- all_reports$Id[1] results <- sf_run_report(this_report_id) # apply your own filters to that same report # set up some filters, if needed # filter records that was created before this month filter1 <- list(column = "CREATED_DATE", operator = "lessThan", value = "THIS_MONTH") # filter records where the account billing address city is not empty filter2 <- list(column = "ACCOUNT.ADDRESS1_CITY", operator = "notEqual", value = "") # combine filter1 and filter2 using 'AND' so that records must meet both filters results_using_AND <- sf_run_report(my_report_id, report_boolean_logic = "1 AND 2", report_filters = list(filter1, filter2)) # combine filter1 and filter2 using 'OR' which means that records must meet one # of the filters but also throw in a row limit based on a specific sort order results_using_OR <- sf_run_report(my_report_id, report_boolean_logic = "1 OR 2", report_filters = list(filter1, filter2), sort_by = "Contact.test_number__c", decreasing = TRUE, top_n = 5) ## End(Not run)
Searches for records in your organization’s data.
sf_search( search_string, is_sosl = FALSE, guess_types = TRUE, api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"), parameterized_search_options = list(...), verbose = FALSE, ... )
sf_search( search_string, is_sosl = FALSE, guess_types = TRUE, api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"), parameterized_search_options = list(...), verbose = FALSE, ... )
search_string |
|
is_sosl |
|
guess_types |
|
api_type |
|
parameterized_search_options |
|
verbose |
|
... |
arguments to be used to form the parameterized search options argument if it is not supplied directly. |
tibble
The maximum number of returned rows in the SOSL query results is 2,000. Please refer to the limits HERE for more detail.
https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_sosl.htm
## Not run: # free text search area_code_search_string <- "(336)" search_result <- sf_search(area_code_search_string) # free text search with parameters search_result <- sf_search(area_code_search_string, fields_scope = "PHONE", objects = "Lead", fields = c("id", "phone", "firstname", "lastname")) # using SOSL my_sosl_search <- paste("FIND {(336)} in phone fields returning", "contact(id, phone, firstname, lastname),", "lead(id, phone, firstname, lastname)") sosl_search_result <- sf_search(my_sosl_search, is_sosl=TRUE) ## End(Not run)
## Not run: # free text search area_code_search_string <- "(336)" search_result <- sf_search(area_code_search_string) # free text search with parameters search_result <- sf_search(area_code_search_string, fields_scope = "PHONE", objects = "Lead", fields = c("id", "phone", "firstname", "lastname")) # using SOSL my_sosl_search <- paste("FIND {(336)} in phone fields returning", "contact(id, phone, firstname, lastname),", "lead(id, phone, firstname, lastname)") sosl_search_result <- sf_search(my_sosl_search, is_sosl=TRUE) ## End(Not run)
Retrieves the current system timestamp from the API.
sf_server_timestamp()
sf_server_timestamp()
POSIXct
formatted timestamp
## Not run: sf_server_timestamp() ## End(Not run)
## Not run: sf_server_timestamp() ## End(Not run)
Set a default filter value which gets applied to a dashboard when you open
it. The default filter value you specify only applies to you (other people
won’t see it when they open the dashboard). If you change the filter value
while viewing the dashboard, then the filter value you set in the user
interface overwrites the value you set via the API. To set sticky filters for
a dashboard, canUseStickyFilter
must equal true.
Saves any dashboard filters set in the request so that they’re also set the
next time you open the dashboard. NOTE: You can only set dashboard filters for
yourself, not for other users.
sf_set_dashboard_sticky_filter( dashboard_id, dashboard_filters = c(character(0)) )
sf_set_dashboard_sticky_filter( dashboard_id, dashboard_filters = c(character(0)) )
dashboard_id |
|
dashboard_filters |
|
list
Sets the specified user’s password to the specified value.
sf_set_password(user_id, password, verbose = FALSE)
sf_set_password(user_id, password, verbose = FALSE)
user_id |
|
password |
|
verbose |
|
list
## Not run: sf_set_password(user_id = "0056A000000ZZZaaBBB", password="password123") ## End(Not run)
## Not run: sf_set_password(user_id = "0056A000000ZZZaaBBB", password="password123") ## End(Not run)
This function takes a SOQL text string and submits the query to an already existing Bulk API Job of operation "query"
sf_submit_query_bulk(job_id, soql, api_type = c("Bulk 1.0"), verbose = FALSE)
sf_submit_query_bulk(job_id, soql, api_type = c("Bulk 1.0"), verbose = FALSE)
job_id |
|
soql |
|
api_type |
|
verbose |
|
A list
parameters of the batch
Bulk API query doesn't support the following SOQL:
COUNT
ROLLUP
SUM
GROUP BY CUBE
OFFSET
Nested SOQL queries
Relationship fields
Additionally, Bulk API can't access or query compound address or compound geolocation fields.
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 1000" job_info <- sf_create_job_bulk(operation = 'query', object = 'Account') query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query) ## End(Not run)
## Not run: my_query <- "SELECT Id, Name FROM Account LIMIT 1000" job_info <- sf_create_job_bulk(operation = 'query', object = 'Account') query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query) ## End(Not run)
Undeletes records from the Recycle Bin.
sf_undelete( ids, api_type = c("SOAP"), control = list(...), ..., verbose = FALSE )
sf_undelete( ids, api_type = c("SOAP"), control = list(...), ..., verbose = FALSE )
ids |
|
api_type |
|
control |
|
... |
arguments passed to |
verbose |
|
tbl_df
of records with success indicator
Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.
https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_undelete.htm
## Not run: new_contact <- c(FirstName = "Test", LastName = "Contact") new_records <- sf_create(new_contact, object_name = "Contact") delete <- sf_delete(new_records$id[1], AllOrNoneHeader = list(allOrNone = TRUE)) is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", new_records$id[1]), queryall = TRUE) undelete <- sf_undelete(new_records$id[1]) is_not_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", new_records$id[1])) ## End(Not run)
## Not run: new_contact <- c(FirstName = "Test", LastName = "Contact") new_records <- sf_create(new_contact, object_name = "Contact") delete <- sf_delete(new_records$id[1], AllOrNoneHeader = list(allOrNone = TRUE)) is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", new_records$id[1]), queryall = TRUE) undelete <- sf_undelete(new_records$id[1]) is_not_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", new_records$id[1])) ## End(Not run)
Updates one or more records to your organization’s data.
sf_update( input_data, object_name, api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
sf_update( input_data, object_name, api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
input_data |
|
object_name |
|
api_type |
|
guess_types |
|
control |
|
... |
arguments passed to |
all_or_none |
|
verbose |
|
tbl_df
of records with success indicator
Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.
## Not run: n <- 2 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) new_records <- sf_create(new_contacts, "Contact") updated_contacts <- tibble(FirstName = rep("TestTest", n), LastName = paste0("Contact", 1:n), Id = new_records$id) # update and allow fields to be truncated if they are too long update <- sf_update(input_data = updated_contacts, object_name = "Contact", AllowFieldTruncationHeader=list(allowFieldTruncation=TRUE)) ## End(Not run)
## Not run: n <- 2 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact", 1:n)) new_records <- sf_create(new_contacts, "Contact") updated_contacts <- tibble(FirstName = rep("TestTest", n), LastName = paste0("Contact", 1:n), Id = new_records$id) # update and allow fields to be truncated if they are too long update <- sf_update(input_data = updated_contacts, object_name = "Contact", AllowFieldTruncationHeader=list(allowFieldTruncation=TRUE)) ## End(Not run)
This function will allow you to update attachments (and other blob data, such as
Documents) by providing the Id of the attachment record and the file paths
(absolute or relative) to media that you would like to upload to Salesforce
along with other supported metadata for this operation (Name
,
Body
, IsPrivate
, and OwnerId
).
sf_update_attachment( attachment_input_data, object_name = c("Attachment"), api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), control = list(...), ..., verbose = FALSE )
sf_update_attachment( attachment_input_data, object_name = c("Attachment"), api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), control = list(...), ..., verbose = FALSE )
attachment_input_data |
|
object_name |
|
api_type |
|
control |
|
... |
arguments passed to |
verbose |
|
tbl_df
with details of the created records
The length of any file name can’t exceed 512 bytes (per Bulk 1.0 API). The SOAP API create call restricts these files to a maximum size of 25 MB. For a file attached to a Solution, the limit is 1.5 MB. The maximum email attachment size is 3 MB. You can only create or update documents to a maximum size of 5 MB. The REST API allows you to insert or update blob data limited to 50 MB of text data or 37.5 MB of base64–encoded data.
Other Attachment functions:
check_and_encode_files()
,
sf_create_attachment()
,
sf_delete_attachment()
,
sf_download_attachment()
## Not run: # upload a PDF to a particular record as an Attachment file_path <- system.file("extdata", "data-wrangling-cheatsheet.pdf", package = "salesforcer") parent_record_id <- "0036A000002C6MmQAK" # replace with your own ParentId! attachment_details <- tibble(Body = file_path, ParentId = parent_record_id) create_result <- sf_create_attachment(attachment_details) # download, zip, and re-upload the PDF pdf_path <- sf_download_attachment(sf_id = create_result$id[1]) zipped_path <- paste0(pdf_path, ".zip") zip(zipped_path, pdf_path) attachment_details <- tibble(Id = create_result$id, Body = zipped_path) update_result <- sf_update_attachment(attachment_details) ## End(Not run)
## Not run: # upload a PDF to a particular record as an Attachment file_path <- system.file("extdata", "data-wrangling-cheatsheet.pdf", package = "salesforcer") parent_record_id <- "0036A000002C6MmQAK" # replace with your own ParentId! attachment_details <- tibble(Body = file_path, ParentId = parent_record_id) create_result <- sf_create_attachment(attachment_details) # download, zip, and re-upload the PDF pdf_path <- sf_download_attachment(sf_id = create_result$id[1]) zipped_path <- paste0(pdf_path, ".zip") zip(zipped_path, pdf_path) attachment_details <- tibble(Id = create_result$id, Body = zipped_path) update_result <- sf_update_attachment(attachment_details) ## End(Not run)
sf_update_dashboard(dashboard_id, body)
sf_update_dashboard(dashboard_id, body)
dashboard_id |
|
body |
|
list
This function takes a list of Metadata components and sends them to Salesforce to update an object that already exists
sf_update_metadata( metadata_type, metadata, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
sf_update_metadata( metadata_type, metadata, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
metadata_type |
|
metadata |
|
control |
|
... |
arguments passed to |
all_or_none |
|
verbose |
|
A tbl_df
containing the creation result for each submitted metadata component
The update key is based on the fullName parameter of the metadata, so updates are triggered when an existing Salesforce element matches the metadata type and fullName.
## Not run: # create an object that we can update base_obj_name <- "Custom_Account1" custom_object <- list() custom_object$fullName <- paste0(base_obj_name, "__c") custom_object$label <- paste0(gsub("_", " ", base_obj_name)) custom_object$pluralLabel <- paste0(base_obj_name, "s") custom_object$nameField <- list(displayFormat = 'AN-{0000}', label = paste0(base_obj_name, ' Number'), type = 'AutoNumber') custom_object$deploymentStatus <- 'Deployed' custom_object$sharingModel <- 'ReadWrite' custom_object$enableActivities <- 'true' custom_object$description <- paste0(base_obj_name, " created by the Metadata API") custom_object_result <- sf_create_metadata(metadata_type = 'CustomObject', metadata = custom_object) # now update the object that was created update_metadata <- custom_object update_metadata$fullName <- 'Custom_Account1__c' update_metadata$label <- 'New Label Custom_Account1' update_metadata$pluralLabel <- 'Custom_Account1s_new' updated_custom_object_result <- sf_update_metadata(metadata_type = 'CustomObject', metadata = update_metadata) ## End(Not run)
## Not run: # create an object that we can update base_obj_name <- "Custom_Account1" custom_object <- list() custom_object$fullName <- paste0(base_obj_name, "__c") custom_object$label <- paste0(gsub("_", " ", base_obj_name)) custom_object$pluralLabel <- paste0(base_obj_name, "s") custom_object$nameField <- list(displayFormat = 'AN-{0000}', label = paste0(base_obj_name, ' Number'), type = 'AutoNumber') custom_object$deploymentStatus <- 'Deployed' custom_object$sharingModel <- 'ReadWrite' custom_object$enableActivities <- 'true' custom_object$description <- paste0(base_obj_name, " created by the Metadata API") custom_object_result <- sf_create_metadata(metadata_type = 'CustomObject', metadata = custom_object) # now update the object that was created update_metadata <- custom_object update_metadata$fullName <- 'Custom_Account1__c' update_metadata$label <- 'New Label Custom_Account1' update_metadata$pluralLabel <- 'Custom_Account1s_new' updated_custom_object_result <- sf_update_metadata(metadata_type = 'CustomObject', metadata = update_metadata) ## End(Not run)
Save changes to a report by sending a PATCH request to the Report resource. Note that saving a report deletes any running async report jobs because they might be obsolete based on the updates.
sf_update_report(report_id, report_metadata, verbose = FALSE)
sf_update_report(report_id, report_metadata, verbose = FALSE)
report_id |
|
report_metadata |
|
verbose |
|
list
representing the newly cloned report with up to 4 properties
that describe the report:
Report type along with the URL to retrieve common objects and joined metadata.
Unique identifiers for groupings and summaries.
Fields in each section of a report type plus filter information for those fields.
Additional information about summaries and groupings.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
## Not run: # first, grab all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # second, get the id of the report to update this_report_id <- all_reports$Id[1] my_updated_report <- sf_update_report(this_report_id, report_metadata = list(reportMetadata = list(name = "Updated Report Name!"))) # alternatively, pull down its metadata and update the name report_details <- sf_describe_report(this_report_id) report_details$reportMetadata$name <- paste0(report_details$reportMetadata$name, " - UPDATED") # fourth, update the report by passing the metadata my_updated_report <- sf_update_report(this_report_id, report_metadata = report_details) ## End(Not run)
## Not run: # first, grab all possible reports in your Org all_reports <- sf_query("SELECT Id, Name FROM Report") # second, get the id of the report to update this_report_id <- all_reports$Id[1] my_updated_report <- sf_update_report(this_report_id, report_metadata = list(reportMetadata = list(name = "Updated Report Name!"))) # alternatively, pull down its metadata and update the name report_details <- sf_describe_report(this_report_id) report_details$reportMetadata$name <- paste0(report_details$reportMetadata$name, " - UPDATED") # fourth, update the report by passing the metadata my_updated_report <- sf_update_report(this_report_id, report_metadata = report_details) ## End(Not run)
This function signals that uploads are complete to a Job in the Salesforce Bulk API
sf_upload_complete_bulk(job_id, api_type = c("Bulk 2.0"), verbose = FALSE)
sf_upload_complete_bulk(job_id, api_type = c("Bulk 2.0"), verbose = FALSE)
job_id |
|
api_type |
|
verbose |
|
A list
of parameters defining the job after signaling a completed upload
This function is typically not used directly. It is used in sf_create_batches_bulk()
right after submitting the batches to signal to Salesforce that the batches should
no longer be queued.
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch
## Not run: upload_info <- sf_upload_complete_bulk(job_id=job_info$id) ## End(Not run)
## Not run: upload_info <- sf_upload_complete_bulk(job_id=job_info$id) ## End(Not run)
Upserts one or more new records to your organization’s data.
sf_upsert( input_data, object_name, external_id_fieldname, api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
sf_upsert( input_data, object_name, external_id_fieldname, api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"), guess_types = TRUE, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
input_data |
|
object_name |
|
external_id_fieldname |
|
api_type |
|
guess_types |
|
control |
|
... |
arguments passed to |
all_or_none |
|
verbose |
|
tbl_df
of records with success indicator
## Not run: n <- 2 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Create-", 1:n), My_External_Id__c=letters[1:n]) new_contacts_result <- sf_create(new_contacts, object_name="Contact") upserted_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Upsert-", 1:n), My_External_Id__c=letters[1:n]) new_record <- tibble(FirstName = "Test", LastName = paste0("Contact-Upsert-", n+1), My_External_Id__c=letters[n+1]) upserted_contacts <- bind_rows(upserted_contacts, new_record) upserted_contacts_result1 <- sf_upsert(upserted_contacts, object_name="Contact", "My_External_Id__c") ## End(Not run)
## Not run: n <- 2 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Create-", 1:n), My_External_Id__c=letters[1:n]) new_contacts_result <- sf_create(new_contacts, object_name="Contact") upserted_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Upsert-", 1:n), My_External_Id__c=letters[1:n]) new_record <- tibble(FirstName = "Test", LastName = paste0("Contact-Upsert-", n+1), My_External_Id__c=letters[n+1]) upserted_contacts <- bind_rows(upserted_contacts, new_record) upserted_contacts_result1 <- sf_upsert(upserted_contacts, object_name="Contact", "My_External_Id__c") ## End(Not run)
This function takes a list of Metadata components and sends them to Salesforce for creation or update if the object already exists
sf_upsert_metadata( metadata_type, metadata, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
sf_upsert_metadata( metadata_type, metadata, control = list(...), ..., all_or_none = deprecated(), verbose = FALSE )
metadata_type |
|
metadata |
|
control |
|
... |
arguments passed to |
all_or_none |
|
verbose |
|
A tbl_df
containing the creation result for each submitted metadata component
The upsert key is based on the fullName parameter of the metadata, so updates are triggered when an existing Salesforce element matches the metadata type and fullName.
## Not run: # create an object that we can confirm the update portion of the upsert base_obj_name <- "Custom_Account1" custom_object <- list() custom_object$fullName <- paste0(base_obj_name, "__c") custom_object$label <- paste0(gsub("_", " ", base_obj_name)) custom_object$pluralLabel <- paste0(base_obj_name, "s") custom_object$nameField <- list(displayFormat = 'AN-{0000}', label = paste0(base_obj_name, ' Number'), type = 'AutoNumber') custom_object$deploymentStatus <- 'Deployed' custom_object$sharingModel <- 'ReadWrite' custom_object$enableActivities <- 'true' custom_object$description <- paste0(base_obj_name, " created by the Metadata API") custom_object_result <- sf_create_metadata(metadata_type = 'CustomObject', metadata = custom_object) # now update the object that was created upsert_metadata <- list(custom_object, custom_object) upsert_metadata[[1]]$fullName <- 'Custom_Account1__c' upsert_metadata[[1]]$label <- 'New Label Custom_Account1' upsert_metadata[[1]]$pluralLabel <- 'Custom_Account1s_new' upsert_metadata[[2]]$fullName <- 'Custom_Account2__c' upsert_metadata[[2]]$label <- 'New Label Custom_Account2' upsert_metadata[[2]]$pluralLabel <- 'Custom_Account2s_new' upserted_custom_object_result <- sf_upsert_metadata(metadata_type = 'CustomObject', metadata = upsert_metadata) ## End(Not run)
## Not run: # create an object that we can confirm the update portion of the upsert base_obj_name <- "Custom_Account1" custom_object <- list() custom_object$fullName <- paste0(base_obj_name, "__c") custom_object$label <- paste0(gsub("_", " ", base_obj_name)) custom_object$pluralLabel <- paste0(base_obj_name, "s") custom_object$nameField <- list(displayFormat = 'AN-{0000}', label = paste0(base_obj_name, ' Number'), type = 'AutoNumber') custom_object$deploymentStatus <- 'Deployed' custom_object$sharingModel <- 'ReadWrite' custom_object$enableActivities <- 'true' custom_object$description <- paste0(base_obj_name, " created by the Metadata API") custom_object_result <- sf_create_metadata(metadata_type = 'CustomObject', metadata = custom_object) # now update the object that was created upsert_metadata <- list(custom_object, custom_object) upsert_metadata[[1]]$fullName <- 'Custom_Account1__c' upsert_metadata[[1]]$label <- 'New Label Custom_Account1' upsert_metadata[[1]]$pluralLabel <- 'Custom_Account1s_new' upsert_metadata[[2]]$fullName <- 'Custom_Account2__c' upsert_metadata[[2]]$label <- 'New Label Custom_Account2' upsert_metadata[[2]]$pluralLabel <- 'Custom_Account2s_new' upserted_custom_object_result <- sf_upsert_metadata(metadata_type = 'CustomObject', metadata = upsert_metadata) ## End(Not run)
Retrieves personal information for the user associated with the current session.
sf_user_info(api_type = c("SOAP", "Chatter"), verbose = FALSE)
sf_user_info(api_type = c("SOAP", "Chatter"), verbose = FALSE)
api_type |
|
verbose |
|
list
## Not run: sf_user_info() ## End(Not run)
## Not run: sf_user_info() ## End(Not run)
A list of data types that are valid for the Metadata API service.
valid_metadata_list()
valid_metadata_list()
list
; contains name and valid inputs for data types