SOAP API Developer's Guide - Salesforce.com

hungryhorsecabinSoftware and s/w Development

Dec 14, 2013 (3 years and 8 months ago)

2,314 views

Version 29.0: Winter ’14
SOAP API Developer's Guide
Last updated: November 13, 2013
©
Copyright 2000–2013 salesforce.com, inc. All rights reserved. Salesforce.com is a registered trademark of salesforce.com, inc., as are other
names and marks. Other marks appearing herein may be trademarks of their respective owners.
Table of Contents
GETTING STARTED.......................................................................................................................1
Chapter 1: Introducing SOAP API..............................................................................................1
When to Use the SOAP API........................................................................................................................................2
Customize, Integrate, and Extend Your Salesforce Solutions.......................................................................................3
Supported Salesforce Editions.......................................................................................................................................3
Standards Compliance...................................................................................................................................................3
Development Platforms.................................................................................................................................................4
SOAP API Support Policy............................................................................................................................................4
Choosing a WSDL........................................................................................................................................................5
Related Resources .........................................................................................................................................................5
What’s New in Version 29.0..........................................................................................................................................5
Quick Start....................................................................................................................................................................6
Step 1: Obtain a Salesforce Developer Edition Organization............................................................................6
Step 2: Generate or Obtain the Web Service WSDL.......................................................................................6
Step 3: Import the WSDL File Into Your Development Platform...................................................................7
Step 4: Walk Through the Sample Code..........................................................................................................8
Chapter 2: Standard and Custom Object Basics..........................................................................20
Primitive Data Types...................................................................................................................................................21
Field Types..................................................................................................................................................................23
API Data Types and Salesforce Field Types...............................................................................................................27
Core Data Types Used in API Calls...........................................................................................................................28
sObject.............................................................................................................................................................28
API Fault Element..........................................................................................................................................28
ExceptionCode................................................................................................................................................29
Error................................................................................................................................................................34
StatusCode.......................................................................................................................................................34
System Fields...............................................................................................................................................................45
Required Fields............................................................................................................................................................50
Frequently-Occurring Fields.......................................................................................................................................50
API Field Properties....................................................................................................................................................51
Relationships Among Objects.....................................................................................................................................52
Relabeling Fields and Tabs and the API.....................................................................................................................52
Force.com AppExchange Object Prefixes and the API...............................................................................................53
Custom Objects...........................................................................................................................................................53
Chapter 3: Call Basics................................................................................................................56
Characteristics of API Calls........................................................................................................................................57
Factors that Affect Data Access..................................................................................................................................57
Package Version Settings.............................................................................................................................................59
Chapter 4: Error Handling.........................................................................................................61
Error Handling for Session Expiration .......................................................................................................................62
i
Table of Contents
More About Error Handling.......................................................................................................................................62
Chapter 5: Security....................................................................................................................63
User Authentication....................................................................................................................................................64
User Profile and Permission Sets Configuration.........................................................................................................64
Security Token.............................................................................................................................................................64
Sharing........................................................................................................................................................................65
Implicit Restrictions for Objects and Fields................................................................................................................66
API Access in Force.com AppExchange Packages......................................................................................................66
Outbound Port Restrictions........................................................................................................................................68
Chapter 6: Using the Partner WSDL..........................................................................................69
Obtaining the Partner WSDL File.............................................................................................................................70
Calls and the Partner WSDL .....................................................................................................................................70
Objects, Fields, and Field Data and the Partner WSDL.............................................................................................71
Queries and the Partner WSDL..................................................................................................................................71
Namespaces in the Partner WSDL.............................................................................................................................72
Package Versions and the Partner WSDL..................................................................................................................72
User Interface Themes.................................................................................................................................................73
Examples Using the Partner WSDL...........................................................................................................................73
Sample query and queryMore Calls.................................................................................................................76
Sample search Call...........................................................................................................................................77
Sample create Call...........................................................................................................................................80
Sample update Call..........................................................................................................................................82
REFERENCE...................................................................................................................................85
Chapter 7: Data Model..............................................................................................................85
Sales Objects................................................................................................................................................................86
Task and Event Objects...............................................................................................................................................87
Support Objects...........................................................................................................................................................88
Document, Note, and Attachment Objects.................................................................................................................89
User, Sharing, and Permission Objects........................................................................................................................90
Profile and Permission Objects....................................................................................................................................91
Record Type Objects...................................................................................................................................................92
Product and Schedule Objects.....................................................................................................................................92
Sharing and Team Selling Objects..............................................................................................................................93
Customizable Forecasting Objects..............................................................................................................................94
Forecasts Objects.........................................................................................................................................................94
Territory Management................................................................................................................................................96
Process Objects............................................................................................................................................................97
Content Objects..........................................................................................................................................................98
Chatter Objects...........................................................................................................................................................98
Chatter Feed Objects.....................................................................................................................................100
Salesforce Knowledge Objects...................................................................................................................................101
ii
Table of Contents
Chapter 8: Standard Objects....................................................................................................102
AcceptedEventRelation.............................................................................................................................................118
Account.....................................................................................................................................................................119
AccountCleanInfo ....................................................................................................................................................138
AccountContactRole.................................................................................................................................................159
AccountFeed..............................................................................................................................................................161
AccountHistory.........................................................................................................................................................167
AccountOwnerSharingRule.......................................................................................................................................169
AccountPartner..........................................................................................................................................................172
AccountShare............................................................................................................................................................173
AccountTag...............................................................................................................................................................177
AccountTeamMember..............................................................................................................................................178
AccountTerritoryAssignmentRule............................................................................................................................180
AccountTerritoryAssignmentRuleItem.....................................................................................................................181
AccountTerritorySharingRule...................................................................................................................................183
ActivityHistory..........................................................................................................................................................186
AdditionalNumber....................................................................................................................................................193
AllowedEmailDomain...............................................................................................................................................194
ApexClass..................................................................................................................................................................194
ApexComponent.......................................................................................................................................................197
ApexLog....................................................................................................................................................................199
ApexPage...................................................................................................................................................................201
ApexTestQueueItem.................................................................................................................................................204
ApexTestResult.........................................................................................................................................................206
ApexTrigger..............................................................................................................................................................208
AppMenuItem...........................................................................................................................................................212
Approval....................................................................................................................................................................215
Article Type__DataCategorySelection......................................................................................................................218
Article Type__Feed...................................................................................................................................................219
Asset..........................................................................................................................................................................224
AssetFeed..................................................................................................................................................................227
AssetTag....................................................................................................................................................................233
AssignmentRule........................................................................................................................................................234
AsyncApexJob...........................................................................................................................................................235
AttachedContentDocument......................................................................................................................................238
Attachment................................................................................................................................................................238
AuthSession...............................................................................................................................................................242
Bookmark..................................................................................................................................................................244
BrandTemplate..........................................................................................................................................................245
BusinessHours...........................................................................................................................................................247
BusinessProcess.........................................................................................................................................................250
CallCenter.................................................................................................................................................................252
Campaign..................................................................................................................................................................254
CampaignFeed..........................................................................................................................................................262
iii
Table of Contents
CampaignMember.....................................................................................................................................................269
CampaignMemberStatus...........................................................................................................................................272
CampaignOwnerSharingRule...................................................................................................................................273
CampaignShare.........................................................................................................................................................275
CampaignTag............................................................................................................................................................277
Case...........................................................................................................................................................................278
CaseArticle................................................................................................................................................................286
CaseComment...........................................................................................................................................................288
CaseContactRole ......................................................................................................................................................290
CaseFeed...................................................................................................................................................................292
CaseHistory...............................................................................................................................................................298
CaseMilestone...........................................................................................................................................................299
CaseOwnerSharingRule............................................................................................................................................302
CaseShare..................................................................................................................................................................304
CaseSolution..............................................................................................................................................................306
CaseStatus.................................................................................................................................................................307
CaseTag.....................................................................................................................................................................308
CaseTeamMember....................................................................................................................................................310
CaseTeamRole..........................................................................................................................................................311
CaseTeamTemplate...................................................................................................................................................311
CaseTeamTemplateMember.....................................................................................................................................312
CaseTeamTemplateRecord.......................................................................................................................................313
CategoryData............................................................................................................................................................313
CategoryNode...........................................................................................................................................................315
CategoryNodeLocalization........................................................................................................................................316
ChatterActivity..........................................................................................................................................................319
ChatterAnswersActivity............................................................................................................................................321
ChatterAnswersReputationLevel...............................................................................................................................325
ChatterConversation.................................................................................................................................................326
ChatterConversationMember....................................................................................................................................327
ChatterMessage.........................................................................................................................................................328
ClientBrowser............................................................................................................................................................723
CollaborationGroup..................................................................................................................................................330
CollaborationGroupFeed...........................................................................................................................................334
CollaborationGroupMember.....................................................................................................................................341
CollaborationGroupMemberRequest........................................................................................................................342
CollaborationInvitation.............................................................................................................................................344
CombinedAttachment...............................................................................................................................................346
Community (Zone)...................................................................................................................................................347
Contact......................................................................................................................................................................349
ContactCleanInfo .....................................................................................................................................................359
ContactFeed..............................................................................................................................................................368
ContactHistory..........................................................................................................................................................374
ContactOwnerSharingRule.......................................................................................................................................376
iv
Table of Contents
ContactShare.............................................................................................................................................................377
ContactTag................................................................................................................................................................379
ContentDocument.....................................................................................................................................................380
ContentDocumentFeed.............................................................................................................................................384
ContentDocumentHistory........................................................................................................................................390
ContentDocumentLink.............................................................................................................................................392
ContentVersion.........................................................................................................................................................394
ContentVersionHistory.............................................................................................................................................403
ContentWorkspace....................................................................................................................................................404
ContentWorkspaceDoc.............................................................................................................................................406
Contract.....................................................................................................................................................................408
ContractContactRole ...............................................................................................................................................416
ContractFeed.............................................................................................................................................................418
ContractHistory.........................................................................................................................................................424
ContractLineItem......................................................................................................................................................425
ContractLineItemHistory..........................................................................................................................................429
ContractStatus...........................................................................................................................................................431
ContractTag..............................................................................................................................................................432
CronJobDetail...........................................................................................................................................................433
CronTrigger..............................................................................................................................................................434
CurrencyType............................................................................................................................................................437
CustomBrand ...........................................................................................................................................................438
CustomBrandAsset ...................................................................................................................................................439
Custom Object__Feed...............................................................................................................................................441
DandBCompany........................................................................................................................................................447
Dashboard.................................................................................................................................................................464
DashboardComponent..............................................................................................................................................469
DashboardComponentFeed......................................................................................................................................470
DashboardFeed..........................................................................................................................................................476
DashboardTag...........................................................................................................................................................482
DatedConversionRate...............................................................................................................................................483
DeclinedEventRelation.............................................................................................................................................484
Division.....................................................................................................................................................................486
DivisionLocalization..................................................................................................................................................487
Document..................................................................................................................................................................489
DocumentAttachmentMap.......................................................................................................................................493
DocumentTag...........................................................................................................................................................494
Domain......................................................................................................................................................................496
DomainSite...............................................................................................................................................................497
EmailMessage............................................................................................................................................................498
EmailServicesAddress................................................................................................................................................501
EmailServicesFunction..............................................................................................................................................503
EmailStatus...............................................................................................................................................................508
EmailTemplate..........................................................................................................................................................510
v
Table of Contents
Entitlement................................................................................................................................................................514
EntitlementContact...................................................................................................................................................517
EntitlementFeed........................................................................................................................................................518
EntitlementHistory...................................................................................................................................................524
EntitlementTemplate................................................................................................................................................526
EntityHistory.............................................................................................................................................................527
EntitySubscription.....................................................................................................................................................529
EnvironmentHubMember.........................................................................................................................................531
Event.........................................................................................................................................................................534
EventFeed..................................................................................................................................................................545
EventRelation............................................................................................................................................................551
EventTag...................................................................................................................................................................555
EventWhoRelation....................................................................................................................................................557
ExternalDataSource...................................................................................................................................................558
ExternalDataUserAuth..............................................................................................................................................560
FeedComment...........................................................................................................................................................561
FeedItem...................................................................................................................................................................564
FeedLike....................................................................................................................................................................571
FeedPollChoice.........................................................................................................................................................572
FeedPollVote.............................................................................................................................................................572
FeedPost....................................................................................................................................................................573
FeedTrackedChange..................................................................................................................................................577
FieldHistoryArchive..................................................................................................................................................580
FieldPermissions........................................................................................................................................................581
FiscalYearSettings......................................................................................................................................................584
Folder........................................................................................................................................................................587
ForecastingAdjustment..............................................................................................................................................589
ForecastingFact..........................................................................................................................................................592
ForecastingItem.........................................................................................................................................................594
ForecastingQuota......................................................................................................................................................598
ForecastShare.............................................................................................................................................................600
GoogleDoc................................................................................................................................................................601
Group........................................................................................................................................................................603
GroupMember...........................................................................................................................................................606
HashtagDefinition.....................................................................................................................................................606
Holiday......................................................................................................................................................................608
Idea............................................................................................................................................................................611
IdeaComment............................................................................................................................................................617
IdeaReputation..........................................................................................................................................................620
IdeaReputationLevel..................................................................................................................................................622
IdeaTheme.................................................................................................................................................................623
KnowledgeArticle......................................................................................................................................................625
KnowledgeArticleVersion..........................................................................................................................................627
KnowledgeArticleVersionHistory..............................................................................................................................634
vi
Table of Contents
KnowledgeArticleViewStat.......................................................................................................................................636
KnowledgeArticleVoteStat........................................................................................................................................638
Lead...........................................................................................................................................................................640
LeadCleanInfo ..........................................................................................................................................................655
LeadFeed...................................................................................................................................................................668
LeadHistory...............................................................................................................................................................675
LeadOwnerSharingRule............................................................................................................................................676
LeadShare..................................................................................................................................................................678
LeadStatus.................................................................................................................................................................680
LeadTag....................................................................................................................................................................681
LineitemOverride......................................................................................................................................................682
LiveAgentSession......................................................................................................................................................685
LiveAgentSessionHistory..........................................................................................................................................688
LiveAgentSessionOwnerSharingRule.......................................................................................................................689
LiveAgentSessionShare.............................................................................................................................................691
LiveChatButton.........................................................................................................................................................692
LiveChatButtonDeployment.....................................................................................................................................700
LiveChatButtonSkill.................................................................................................................................................700
LiveChatDeployment................................................................................................................................................701
LiveChatTranscript...................................................................................................................................................703
LiveChatTranscriptEvent..........................................................................................................................................709
LiveChatTranscriptHistory.......................................................................................................................................711
LiveChatTranscriptOwnerSharingRule....................................................................................................................712
LiveChatTranscriptShare..........................................................................................................................................714
LiveChatTranscriptSkill............................................................................................................................................715
LiveChatUserConfig.................................................................................................................................................716
LiveChatUserConfigProfile.......................................................................................................................................721
LiveChatUserConfigUser..........................................................................................................................................722
LiveChatVisitor.........................................................................................................................................................722
LoginIp......................................................................................................................................................................723
LoginHistory.............................................................................................................................................................724
MailmergeTemplate..................................................................................................................................................727
MilestoneType...........................................................................................................................................................729
Name.........................................................................................................................................................................730
Network.....................................................................................................................................................................734
NetworkMember.......................................................................................................................................................738
NetworkMemberGroup.............................................................................................................................................743
NewsFeed..................................................................................................................................................................744
Note...........................................................................................................................................................................751
NoteAndAttachment.................................................................................................................................................752
NoteTag....................................................................................................................................................................754
ObjectPermissions.....................................................................................................................................................755
OpenActivity.............................................................................................................................................................758
Opportunity...............................................................................................................................................................764
vii
Table of Contents
OpportunityCompetitor............................................................................................................................................774
OpportunityContactRole...........................................................................................................................................775
OpportunityFeed.......................................................................................................................................................777
OpportunityFieldHistory...........................................................................................................................................783
OpportunityHistory...................................................................................................................................................784
OpportunityLineItem................................................................................................................................................786
OpportunityLineItemSchedule..................................................................................................................................792
OpportunityOverride.................................................................................................................................................795
OpportunityOwnerSharingRule................................................................................................................................798
OpportunityPartner...................................................................................................................................................800
OpportunityShare......................................................................................................................................................802
OpportunitySplit.......................................................................................................................................................803
OpportunitySplitType ..............................................................................................................................................805
OpportunityStage......................................................................................................................................................807
OpportunityTag........................................................................................................................................................810
OpportunityTeamMember........................................................................................................................................811
Organization..............................................................................................................................................................813
OrgWideEmailAddress.............................................................................................................................................830
Partner.......................................................................................................................................................................831
PartnerNetworkConnection......................................................................................................................................834
PartnerNetworkRecordConnection...........................................................................................................................836
PartnerRole................................................................................................................................................................839
Period........................................................................................................................................................................840
PermissionSet............................................................................................................................................................842
PermissionSetAssignment.........................................................................................................................................847
PermissionSetLicense................................................................................................................................................849
PermissionSetLicenseAssign.....................................................................................................................................851
Pricebook2.................................................................................................................................................................852
Pricebook2History.....................................................................................................................................................855
PricebookEntry..........................................................................................................................................................857
ProcessInstance..........................................................................................................................................................859
ProcessInstanceHistory..............................................................................................................................................861
ProcessInstanceStep...................................................................................................................................................863
ProcessInstanceWorkitem.........................................................................................................................................864
Product2....................................................................................................................................................................866
Product2Feed............................................................................................................................................................871
ProductEntitlementTemplate....................................................................................................................................877
Profile........................................................................................................................................................................878
PushTopic.................................................................................................................................................................881
QuantityForecast.......................................................................................................................................................883
QuantityForecastHistory...........................................................................................................................................891
Question....................................................................................................................................................................893
QuestionDataCategorySelection...............................................................................................................................898
QuestionReportAbuse...............................................................................................................................................899
viii
Table of Contents
QuestionSubscription................................................................................................................................................900
QueueSobject.............................................................................................................................................................902
QuickText..................................................................................................................................................................903
QuickTextHistory.....................................................................................................................................................904
QuickTextOwnerSharingRule...................................................................................................................................905
QuickTextShare.........................................................................................................................................................907
Quote.........................................................................................................................................................................908
QuoteDocument........................................................................................................................................................920
QuoteLineItem..........................................................................................................................................................922
RecentlyViewed.........................................................................................................................................................926
RecordType...............................................................................................................................................................929
RecordTypeLocalization............................................................................................................................................932
Reply..........................................................................................................................................................................934
ReplyReportAbuse.....................................................................................................................................................936
Report........................................................................................................................................................................937
ReportFeed................................................................................................................................................................940
ReportTag.................................................................................................................................................................946
RevenueForecast........................................................................................................................................................947
RevenueForecastHistory............................................................................................................................................956
Scontrol.....................................................................................................................................................................958
ScontrolLocalization..................................................................................................................................................961
SelfServiceUser..........................................................................................................................................................965
ServiceContract.........................................................................................................................................................968
ServiceContractFeed..................................................................................................................................................976
ServiceContractHistory.............................................................................................................................................981
ServiceContractOwnerSharingRule...........................................................................................................................983
ServiceContractShare................................................................................................................................................985
SetupEntityAccess.....................................................................................................................................................986
SignupRequest...........................................................................................................................................................988
Site.............................................................................................................................................................................994
SiteDomain...............................................................................................................................................................999
SiteHistory...............................................................................................................................................................1000
Skill..........................................................................................................................................................................1001
SkillProfile...............................................................................................................................................................1002
SkillUser..................................................................................................................................................................1002
SlaProcess................................................................................................................................................................1003
Solution...................................................................................................................................................................1006
SolutionFeed............................................................................................................................................................1009
SolutionHistory.......................................................................................................................................................1015
SolutionStatus..........................................................................................................................................................1017
SolutionTag.............................................................................................................................................................1018
StaticResource.........................................................................................................................................................1019
TagDefinition..........................................................................................................................................................1022
Task.........................................................................................................................................................................1023
ix
Table of Contents
TaskFeed.................................................................................................................................................................1031
TaskPriority.............................................................................................................................................................1037
TaskRelation............................................................................................................................................................1039
TaskStatus...............................................................................................................................................................1040
TaskTag...................................................................................................................................................................1042
TaskWhoRelation...................................................................................................................................................1043
Territory..................................................................................................................................................................1044
Topic.......................................................................................................................................................................1047
TopicAssignment....................................................................................................................................................1048
TopicFeed................................................................................................................................................................1049
UndecidedEventRelation.........................................................................................................................................1055
User.........................................................................................................................................................................1056
UserAccountTeamMember.....................................................................................................................................1091
UserFeed..................................................................................................................................................................1093
UserLicense.............................................................................................................................................................1100
UserLogin................................................................................................................................................................1102
UserMembershipSharingRule.................................................................................................................................1103
UserPreference.........................................................................................................................................................1105
UserProfile...............................................................................................................................................................1106
UserProfileFeed.......................................................................................................................................................1123
UserRecordAccess...................................................................................................................................................1130
UserRole..................................................................................................................................................................1132
UserShare................................................................................................................................................................1136
UserTeamMember..................................................................................................................................................1137
UserTerritory...........................................................................................................................................................1139
Vote.........................................................................................................................................................................1140
WebLink.................................................................................................................................................................1142
WebLinkLocalization..............................................................................................................................................1147
WorkAccess ............................................................................................................................................................1150
WorkAccessShare ...................................................................................................................................................1151
WorkBadge .............................................................................................................................................................1152
WorkBadgeDefinition ............................................................................................................................................1153
WorkBadgeDefinitionHistory ................................................................................................................................1155
WorkCoaching .......................................................................................................................................................1156
WorkCoachingFeed ...............................................................................................................................................1157
WorkFeedback .......................................................................................................................................................1161
WorkFeedbackQuestion .........................................................................................................................................1162
WorkFeedbackQuestionSet ....................................................................................................................................1165
WorkFeedbackRequest ...........................................................................................................................................1166
WorkFeedbackRequestHistory ...............................................................................................................................1170
WorkGoal ...............................................................................................................................................................1171
WorkGoalCollaborator ..........................................................................................................................................1176
WorkGoalCollaboratorHistory ..............................................................................................................................1177
WorkGoalFeed .......................................................................................................................................................1178
x
Table of Contents
WorkGoalHistory ..................................................................................................................................................1182
WorkGoalLink .......................................................................................................................................................1183
WorkGoalShare ......................................................................................................................................................1184
WorkPerformanceCycle .........................................................................................................................................1186
WorkPerformanceCycleFeed ..................................................................................................................................1187
WorkReward ..........................................................................................................................................................1191
WorkRewardFund ..................................................................................................................................................1192
WorkRewardFundHistory ......................................................................................................................................1193
WorkRewardFundShare .........................................................................................................................................1194
WorkRewardHistory ..............................................................................................................................................1195
WorkRewardShare .................................................................................................................................................1196
WorkThanks ..........................................................................................................................................................1197
WorkThanksShare .................................................................................................................................................1198
Chapter 9: Core Calls.............................................................................................................1200
convertLead()...........................................................................................................................................................1201
LeadConvertResult......................................................................................................................................1206
create().....................................................................................................................................................................1206
SaveResult....................................................................................................................................................1214
delete().....................................................................................................................................................................1215
DeleteResult................................................................................................................................................1217
emptyRecycleBin()...................................................................................................................................................1218
EmptyRecycleBinResult..............................................................................................................................1220
getDeleted().............................................................................................................................................................1220
GetDeletedResult........................................................................................................................................1223
getUpdated()............................................................................................................................................................1224
GetUpdatedResult.......................................................................................................................................1227
invalidateSessions()..................................................................................................................................................1228
InvalidateSessionsResult..............................................................................................................................1229
login()......................................................................................................................................................................1229
LoginResult.................................................................................................................................................1233
logout()....................................................................................................................................................................1234
merge()....................................................................................................................................................................1235
MergeResult................................................................................................................................................1239
performQuickActions()...........................................................................................................................................1239
PerformQuickActionResult.........................................................................................................................1240
process()...................................................................................................................................................................1241
ProcessResult...............................................................................................................................................1243
query().....................................................................................................................................................................1244
QueryResult.................................................................................................................................................1247
QueryLocator...............................................................................................................................................1249
queryAll().................................................................................................................................................................1249
queryMore().............................................................................................................................................................1252
QueryResult.................................................................................................................................................1254
QueryLocator...............................................................................................................................................1255
xi
Table of Contents
retrieve()..................................................................................................................................................................1255
search()....................................................................................................................................................................1257
SearchResult................................................................................................................................................1260
undelete().................................................................................................................................................................1260
UndeleteResult.............................................................................................................................................1263
update()....................................................................................................................................................................1263
SaveResult....................................................................................................................................................1268
upsert().....................................................................................................................................................................1269
UpsertResult................................................................................................................................................1274
Chapter 10: Describe Calls.....................................................................................................1275
describeAppMenu().................................................................................................................................................1276
DescribeAppMenuResult............................................................................................................................1277
describeAvailableQuickActions().............................................................................................................................1277
DescribeAvailableQuickActionResult..........................................................................................................1278
describeCompactLayouts()......................................................................................................................................1279
DescribeCompactLayoutsResult..................................................................................................................1281
describeDataCategoryGroups()...............................................................................................................................1282
DescribeDataCategoryGroupResult............................................................................................................1283
describeDataCategoryGroupStructures().................................................................................................................1284
DescribeDataCategoryGroupStructureResult..............................................................................................1287
describeFlexiPages().................................................................................................................................................1287
DescribeFlexiPageResult..............................................................................................................................1289
describeGlobal().......................................................................................................................................................1290
DescribeGlobalResult..................................................................................................................................1291
describeGlobalTheme()...........................................................................................................................................1293
DescribeGlobalTheme.................................................................................................................................1294
describeLayout()......................................................................................................................................................1294
DescribeLayoutResult..................................................................................................................................1299
describeQuickActions()...........................................................................................................................................1306
DescribeQuickActionResult........................................................................................................................1307
describeSearchScopeOrder()....................................................................................................................................1310
DescribeSearchScopeOrderResult...............................................................................................................1311
describeSearchLayouts()..........................................................................................................................................1312
DescribeSearchLayoutResult.......................................................................................................................1313
describeSObject().....................................................................................................................................................1313
describeSObjectResult.................................................................................................................................1316
describeSObjects()...................................................................................................................................................1316
DescribeSObjectResult................................................................................................................................1319
describeSoftphoneLayout()......................................................................................................................................1329
describeTabs()..........................................................................................................................................................1332
describeTabSetResult...................................................................................................................................1334
describeTheme()......................................................................................................................................................1336
DescribeThemeResult..................................................................................................................................1338
DescribeThemeItem....................................................................................................................................1338
xii
Table of Contents
Chapter 11: Utility Calls.........................................................................................................1339
getServerTimestamp().............................................................................................................................................1339
getServerTimestampResult..........................................................................................................................1341
getUserInfo()...........................................................................................................................................................1341
getUserInfoResult........................................................................................................................................1342
resetPassword()........................................................................................................................................................1343
sendEmail().............................................................................................................................................................1345
SendEmailResult.........................................................................................................................................1352
sendEmailMessage()................................................................................................................................................1353
setPassword()...........................................................................................................................................................1355
Chapter 12: SOAP Headers....................................................................................................1357
AllOrNoneHeader...................................................................................................................................................1358
AllowFieldTruncationHeader.................................................................................................................................1359
AssignmentRuleHeader...........................................................................................................................................1360
CallOptions.............................................................................................................................................................1361
DisableFeedTrackingHeader...................................................................................................................................1363
EmailHeader...........................................................................................................................................................1364
LimitInfoHeader.....................................................................................................................................................1365
LocaleOptions.........................................................................................................................................................1366
LoginScopeHeader..................................................................................................................................................1367
MruHeader..............................................................................................................................................................1368
OwnerChangeOptions............................................................................................................................................1368
PackageVersionHeader............................................................................................................................................1370
QueryOptions..........................................................................................................................................................1371
SessionHeader.........................................................................................................................................................1371
UserTerritoryDeleteHeader.....................................................................................................................................1372
USING THE API WITH SALESFORCE FEATURES.................................................................1373
Chapter 13: Implementation Considerations...........................................................................1373
Choosing a User for an Integration.........................................................................................................................1374
Login Server URL...................................................................................................................................................1374
Log in to the Login Server......................................................................................................................................1375
Typical API Call Sequence......................................................................................................................................1375
Salesforce Sandbox..................................................................................................................................................1375
Multiple Instances of Salesforce.com Database Servers...........................................................................................1376
Content Type Requirement.....................................................................................................................................1376