SOAP API Developer Guide
User Manual:
Open the PDF directly: View PDF
Page Count: 2547 [warning: Documents this large are best viewed by clicking the View PDF Link!]
- Getting Started
- Introducing SOAP API
- Object Basics
- Primitive Data Types
- Field Types
- Compound Fields
- API Data Types and Salesforce Field Types
- Core Data Types Used in API Calls
- System Fields
- Required Fields
- Frequently-Occurring Fields
- API Field Properties
- Relationships Among Objects
- Relabeling Fields and Tabs and the API
- Tooling API Objects in the Enterprise WSDL
- Force.com AppExchange Object Prefixes and the API
- Custom Objects
- External Objects
- Call Basics
- Error Handling
- Security
- Using the Partner WSDL
- Reference
- Data Model
- Sales Objects
- Task and Event Objects
- Support Objects
- Document, Note, and Attachment Objects
- User, Sharing, and Permission Objects
- Profile and Permission Objects
- Record Type Objects
- Product and Schedule Objects
- Sharing and Team Selling Objects
- Customizable Forecasting Objects
- Forecasts Objects
- Territory Management 2.0 Objects
- Territory Management
- Process Objects
- Content Objects
- ContentNote Objects
- Chatter Objects
- Salesforce Knowledge Objects
- Work.com Badge and Reward Objects
- Work.com Feedback and Performance Cycle Objects
- Standard Objects
- AcceptedEventRelation
- Account
- AccountContactRelation
- AccountCleanInfo
- AccountContactRole
- AccountFeed
- AccountHistory
- AccountOwnerSharingRule
- AccountPartner
- AccountShare
- AccountTag
- AccountTeamMember
- AccountTerritoryAssignmentRule
- AccountTerritoryAssignmentRuleItem
- AccountTerritorySharingRule
- ActionLinkGroupTemplate
- ActionLinkTemplate
- ActivityHistory
- AdditionalNumber
- AgentWork
- AllowedEmailDomain
- Announcement
- ApexClass
- ApexComponent
- ApexLog
- ApexPage
- ApexTestQueueItem
- ApexTestResult
- ApexTestResultLimits
- ApexTestRunResult
- ApexTestSuite
- ApexTrigger
- AppMenuItem
- Approval
- Article Type__DataCategorySelection
- Article Type__Feed
- Asset
- AssetFeed
- AssetOwnerSharingRule
- AssetShare
- AssetTag
- AssetTokenEvent
- AssignedResource
- AssignmentRule
- AsyncApexJob
- AttachedContentDocument
- AttachedContentNote
- Attachment
- AuraDefinition
- AuraDefinitionBundle
- AuthConfig
- AuthConfigProviders
- AuthProvider
- AuthSession
- BackgroundOperation
- BackgroundOperationResult
- Bookmark
- BrandTemplate
- BusinessHours
- BusinessProcess
- CallCenter
- Campaign
- CampaignFeed
- CampaignInfluence
- CampaignInfluenceModel
- CampaignMember
- CampaignMemberStatus
- CampaignOwnerSharingRule
- CampaignShare
- CampaignTag
- Case
- CaseArticle
- CaseComment
- CaseContactRole
- CaseFeed
- CaseHistory
- CaseMilestone
- CaseOwnerSharingRule
- CaseShare
- CaseSolution
- CaseStatus
- CaseTag
- CaseTeamMember
- CaseTeamRole
- CaseTeamTemplate
- CaseTeamTemplateMember
- CaseTeamTemplateRecord
- CategoryData
- CategoryNode
- CategoryNodeLocalization
- ChatterActivity
- ChatterAnswersActivity
- ChatterAnswersReputationLevel
- ChatterConversation
- ChatterConversationMember
- ChatterMessage
- ClientBrowser
- CollaborationGroup
- CollaborationGroupFeed
- CollaborationGroupMember
- CollaborationGroupMemberRequest
- CollaborationGroupRecord
- CollaborationInvitation
- CombinedAttachment
- Community (Zone)
- ConnectedApplication
- Contact
- ContactCleanInfo
- ContactFeed
- ContactHistory
- ContactOwnerSharingRule
- ContactShare
- ContactTag
- ContentAsset
- ContentDistribution
- ContentDistributionView
- ContentDocument
- ContentDocumentFeed
- ContentDocumentHistory
- ContentDocumentLink
- ContentFolder
- ContentFolderItem
- ContentFolderLink
- ContentFolderMember
- ContentHubItem
- ContentHubRepository
- ContentNote
- ContentVersion
- ContentVersionHistory
- ContentWorkspace
- ContentWorkspaceDoc
- Contract
- ContractContactRole
- ContractFeed
- ContractHistory
- ContractLineItem
- ContractLineItemHistory
- ContractStatus
- ContractTag
- CorsWhitelistEntry
- CronJobDetail
- CronTrigger
- CurrencyType
- CustomBrand
- CustomBrandAsset
- Custom Metadata Type__mdt
- Custom Object__Feed
- CustomPermission
- CustomPermissionDependency
- DandBCompany
- Dashboard
- DashboardComponent
- DashboardComponentFeed
- DashboardFeed
- DashboardTag
- DataAssessmentFieldMetric
- DataAssessmentMetric
- DataAssessmentValueMetric
- DatacloudCompany
- DatacloudContact
- DatacloudDandBCompany
- DatacloudOwnedEntity
- DatacloudPurchaseUsage
- DatacloudSocialHandle
- DatedConversionRate
- DcSocialProfile
- DcSocialProfileHandle
- DeclinedEventRelation
- Division
- DivisionLocalization
- Document
- DocumentAttachmentMap
- DocumentTag
- Domain
- DomainSite
- DuplicateRecordItem
- DuplicateRecordSet
- DuplicateRule
- EmailDomainKey
- EmailMessage
- EmailMessageRelation
- EmailServicesAddress
- EmailServicesFunction
- EmailStatus
- EmailTemplate
- EmbeddedServiceDetail
- Entitlement
- EntitlementContact
- EntitlementFeed
- EntitlementHistory
- EntitlementTemplate
- EntityHistory
- EntityMilestone
- EntitySubscription
- EnvironmentHubMember
- Event
- EventFeed
- EventLogFile
- EventRelation
- EventTag
- EventWhoRelation
- ExternalDataSource
- ExternalDataUserAuth
- FeedAttachment
- FeedComment
- FeedItem
- FeedLike
- FeedPollChoice
- FeedPollVote
- FeedPost
- FeedRevision
- FeedTrackedChange
- FieldHistoryArchive
- FieldPermissions
- FiscalYearSettings
- FlexQueueItem
- FlowInterview
- FlowInterviewOwnerSharingRule
- FlowInterviewShare
- Folder
- FolderedContentDocument
- ForecastingAdjustment
- ForecastingFact
- ForecastingItem
- ForecastingOwnerAdjustment
- ForecastingQuota
- ForecastingType
- ForecastingUserPreference
- ForecastShare
- Goal
- GoalFeed
- GoalHistory
- GoalLink
- GoalShare
- GoogleDoc
- Group
- GroupMember
- HashtagDefinition
- Holiday
- Idea
- IdeaComment
- IdeaReputation
- IdeaReputationLevel
- IdeaTheme
- KnowledgeableUser
- KnowledgeArticle
- KnowledgeArticleVersion
- KnowledgeArticleVersionHistory
- KnowledgeArticleViewStat
- KnowledgeArticleVoteStat
- Lead
- LeadCleanInfo
- LeadFeed
- LeadHistory
- LeadOwnerSharingRule
- LeadShare
- LeadStatus
- LeadTag
- LimitAllocationPerApp
- LineitemOverride
- LinkedArticle
- LinkedArticleFeed
- LinkedArticleHistory
- ListView
- ListViewChart
- ListViewChartInstance
- LiveAgentSession
- LiveAgentSessionHistory
- LiveAgentSessionOwnerSharingRule
- LiveAgentSessionShare
- LiveChatBlockingRule
- LiveChatButton
- LiveChatButtonDeployment
- LiveChatButtonSkill
- LiveChatDeployment
- LiveChatSensitiveDataRule
- LiveChatTranscript
- LiveChatTranscriptEvent
- LiveChatTranscriptHistory
- LiveChatTranscriptOwnerSharingRule
- LiveChatTranscriptShare
- LiveChatTranscriptSkill
- LiveChatUserConfig
- LiveChatUserConfigProfile
- LiveChatUserConfigUser
- LiveChatVisitor
- LoginEvent
- LoginGeo
- LoginHistory
- LoginIp
- LookedUpFromActivity
- Macro
- MacroInstruction
- MailmergeTemplate
- MatchingRule
- MatchingRuleItem
- MetadataPackage
- MetadataPackageVersion
- Metric
- MetricDataLink
- MetricDataLinkHistory
- MetricFeed
- MetricHistory
- MetricsDataFile
- MetricShare
- MilestoneType
- Name
- NamedCredential
- NavigationLinkSet
- NavigationMenuItem
- NavigationMenuItemLocalization
- Network
- NetworkActivityAudit
- NetworkMember
- NetworkMemberGroup
- NetworkModeration
- NetworkPageOverride
- NetworkSelfRegistration
- NewsFeed
- Note
- OauthToken
- NoteAndAttachment
- NoteTag
- ObjectPermissions
- ObjectTerritory2AssignmentRule
- ObjectTerritory2AssignmentRuleItem
- ObjectTerritory2Association
- OpenActivity
- OperatingHours
- OperatingHoursFeed
- OperatingHoursHistory
- Opportunity
- OpportunityCompetitor
- OpportunityContactRole
- OpportunityFeed
- OpportunityFieldHistory
- OpportunityHistory
- OpportunityLineItem
- OpportunityLineItemSchedule
- OpportunityOverride
- OpportunityOwnerSharingRule
- OpportunityPartner
- OpportunityShare
- OpportunitySplit
- OpportunitySplitType
- OpportunityStage
- OpportunityTag
- OpportunityTeamMember
- Order
- OrderFeed
- OrderHistory
- OrderItem
- OrderItemFeed
- OrderItemHistory
- OrderOwnerSharingRule
- Organization
- OrgWideEmailAddress
- OwnedContentDocument
- PackageLicense
- PackagePushError
- PackagePushJob
- PackagePushRequest
- PackageSubscriber
- Partner
- PartnerNetworkConnection
- PartnerNetworkRecordConnection
- PartnerNetworkSyncLog
- PartnerRole
- Period
- PermissionSet
- PermissionSetAssignment
- PermissionSetLicense
- PermissionSetLicenseAssign
- PlatformAction
- PresenceUserConfig
- PresenceUserConfigProfile
- PresenceUserConfigUser
- Pricebook2
- Pricebook2History
- PricebookEntry
- ProcessDefinition
- ProcessInstance
- ProcessInstanceHistory
- ProcessInstanceStep
- ProcessInstanceNode
- ProcessInstanceWorkitem
- ProcessNode
- Product2
- Product2Feed
- ProductEntitlementTemplate
- Profile
- ProfileSkill
- ProfileSkillEndorsement
- ProfileSkillEndorsementFeed
- ProfileSkillEndorsementHistory
- ProfileSkillFeed
- ProfileSkillHistory
- ProfileSkillShare
- ProfileSkillUser
- ProfileSkillUserFeed
- ProfileSkillUserHistory
- PushTopic
- QuantityForecast
- QuantityForecastHistory
- QueueRoutingConfig
- Question
- QuestionDataCategorySelection
- QuestionReportAbuse
- QuestionSubscription
- QueueSobject
- QuickText
- QuickTextHistory
- QuickTextOwnerSharingRule
- QuickTextShare
- Quote
- QuoteDocument
- QuoteFeed
- QuoteLineItem
- RecentlyViewed
- RecordType
- RecordTypeLocalization
- Reply
- ReplyReportAbuse
- Report
- ReportFeed
- ReportTag
- ReputationLevel
- ReputationLevelLocalization
- ReputationPointsRule
- ResourceAbsence
- ResourceAbsenceFeed
- ResourceAbsenceHistory
- RevenueForecast
- RevenueForecastHistory
- RuleTerritory2Association
- SamlSsoConfig
- Scontrol
- ScontrolLocalization
- SearchPromotionRule
- SecureAgent
- SecureAgentsCluster
- SecurityCustomBaseline (Beta)
- SelfServiceUser
- ServiceAppointment
- ServiceAppointmentFeed
- ServiceAppointmentHistory
- ServiceAppointmentOwnerSharingRule
- ServiceAppointmentShare
- ServiceChannel
- ServiceChannelStatus
- ServiceContract
- ServiceContractFeed
- ServiceContractHistory
- ServiceContractOwnerSharingRule
- ServiceContractShare
- ServicePresenceStatus
- ServiceResource
- ServiceResourceCapacity
- ServiceResourceCapacityFeed
- ServiceResourceCapacityHistory
- ServiceResourceFeed
- ServiceResourceHistory
- ServiceResourceOwnerSharingRule
- ServiceResourceShare
- ServiceResourceSkill
- ServiceResourceSkillFeed
- ServiceResourceSkillHistory
- ServiceTerritory
- ServiceTerritoryFeed
- ServiceTerritoryHistory
- ServiceTerritoryMember
- ServiceTerritoryMemberFeed
- ServiceTerritoryMemberHistory
- SessionPermSetActivation
- SetupAuditTrail
- SetupEntityAccess
- SignupRequest
- Site
- SiteDomain
- SiteHistory
- Skill
- SkillProfile
- SkillRequirement
- SkillRequirementFeed
- SkillRequirementHistory
- SkillUser
- SlaProcess
- Solution
- SolutionFeed
- SolutionHistory
- SolutionStatus
- SolutionTag
- SOSDeployment
- SOSSession
- SOSSessionActivity
- SOSSessionHistory
- SOSSessionOwnerSharingRule
- SOSSessionShare
- Stamp
- StampAssignment
- StaticResource
- StreamingChannel
- TagDefinition
- Task
- TaskFeed
- TaskPriority
- TaskRelation
- TaskStatus
- TaskTag
- TaskWhoRelation
- TenantSecret
- Territory
- Territory2
- Territory2Model
- Territory2ModelHistory
- Territory2Type
- TestSuiteMembership
- ThirdPartyAccountLink
- TimeSlot
- TimeSlotHistory
- Topic
- TopicAssignment
- TopicFeed
- TopicLocalization—Beta
- TwoFactorInfo
- TwoFactorMethodsInfo
- TwoFactorTempCode
- UndecidedEventRelation
- User
- UserAccountTeamMember
- UserAppInfo
- UserAppMenuCustomization
- UserAppMenuCustomizationShare
- UserAppMenuItem
- UserConfigTransferButton
- UserConfigTransferSkill
- UserCustomBadge
- UserCustomBadgeLocalization
- UserFeed
- UserLicense
- UserLogin
- UserMembershipSharingRule
- UserPackageLicense
- UserPreference
- UserProfile
- UserProfileFeed
- UserProvAccount
- UserProvAccountStaging
- UserProvMockTarget
- UserProvisioningConfig
- UserProvisioningLog
- UserProvisioningRequest
- UserProvisioningRequestOwnerSharingRule
- UserProvisioningRequestShare
- UserRecordAccess
- UserRole
- UserServicePresence
- UserShare
- UserTeamMember
- UserTerritory
- UserTerritory2Association
- VerificationHistory
- VoiceCall
- VoiceCallList
- VoiceCallListItem
- VoiceCallListShare
- VoiceCallShare
- VoiceMailContent
- VoiceMailContentShare
- VoiceUserLine
- VoiceUserLineShare
- VoiceVendorInfo
- VoiceVendorLine
- VoiceVendorLineShare
- Vote
- WebLink
- WebLinkLocalization
- WorkAccess
- WorkAccessShare
- WorkBadge
- WorkBadgeDefinition
- WorkBadgeDefinitionHistory
- WorkBadgeDefinitionShare
- WorkCoaching
- WorkCoachingFeed
- WorkCoachingHistory
- WorkCoachingShare
- WorkFeedback
- WorkFeedbackHistory
- WorkFeedbackQuestion
- WorkFeedbackQuestionHistory
- WorkFeedbackQuestionSet
- WorkFeedbackQuestionSetHistory
- WorkFeedbackQuestionSetShare
- WorkFeedbackQuestionShare
- WorkFeedbackRequest
- WorkFeedbackRequestFeed
- WorkFeedbackRequestHistory
- WorkFeedbackRequestShare
- WorkFeedbackShare
- WorkGoal
- WorkGoalCollaborator
- WorkGoalCollaboratorHistory
- WorkGoalFeed
- WorkGoalHistory
- WorkGoalLink
- WorkGoalShare
- WorkOrder
- WorkOrderFeed
- WorkOrderHistory
- WorkOrderLineItem
- WorkOrderLineItemFeed
- WorkOrderLineItemHistory
- WorkOrderShare
- WorkPerformanceCycle
- WorkPerformanceCycleFeed
- WorkPerformanceCycleHistory
- WorkPerformanceCycleShare
- WorkReward
- WorkRewardFund
- WorkRewardFundHistory
- WorkRewardFundShare
- WorkRewardFundType
- WorkRewardFundTypeHistory
- WorkRewardFundTypeShare
- WorkRewardHistory
- WorkRewardShare
- WorkThanks
- WorkThanksShare
- WorkType
- WorkTypeFeed
- WorkTypeHistory
- Reusable Terms for API Objects
- Core Calls
- Describe Calls
- describeAllTabs()
- describeAppMenu()
- describeApprovalLayout()
- describeAvailableQuickActions()
- describeCompactLayouts()
- describeDataCategoryGroups()
- describeDataCategoryGroupStructures()
- describeGlobal()
- describeGlobalTheme()
- describeKnowledge()Call Name
- describeLayout()
- DescribeLayoutResult
- DescribeLayout
- DescribeLayoutButtonSection
- DescribeLayoutComponent
- DescribeLayoutFeedFilter
- DescribeLayoutFeedView
- DescribeLayoutItem
- DescribeLayoutRow
- DescribeLayoutSection
- DescribeQuickActionListResult
- DescribeQuickActionListItemResult
- CustomLinkComponent
- FieldLayoutComponent
- LayoutComponentType
- PicklistForRecordType
- RecordTypeMapping
- RelatedContent
- RelatedList
- RelatedListColumn
- RelatedListSort
- DescribeLayoutSaveOption
- WebLinkPosition
- DescribeLayoutResult
- describePrimaryCompactLayouts()
- describeQuickActions()
- describeSearchScopeOrder()
- describeSearchLayouts()
- describeSObject()
- describeSObjects()
- describeSoftphoneLayout()
- describeSoqlListViews()
- describeTabs()
- describeTheme()
- Utility Calls
- SOAP Headers
- Data Model
- Using the API with Salesforce Features
- Implementation Considerations
- Choosing a User for an Integration
- Login Server URL
- Log in to the Login Server
- Typical API Call Sequence
- Salesforce Sandbox
- Multiple Instances of Salesforce Database Servers
- Content Type Requirement
- Monitoring API Traffic
- API Usage Metering
- Compression
- HTTP Persistent Connections
- HTTP Chunking
- Internationalization and Character Sets
- XML Compliance
- .NET, Non-String Fields, and the Enterprise WSDL
- Outbound Messaging
- Data Loading and Integration
- Data Replication
- Feature-Specific Considerations
- Implementation Considerations
- Glossary
- Index