SOAP API Developer Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 2547

Download
Open PDF In Browser	View PDF

SOAP API Developer Guide
Version 39.0, Spring ’17

@salesforcedocs
Last updated: April 27, 2017

as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Development Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
SOAP API Support Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Choosing a WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Related Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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: Object Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Primitive Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Field Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Compound Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Address Compound Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Geolocation Compound Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Compound Field Considerations and Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
API Data Types and Salesforce Field Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Core Data Types Used in API Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
sObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
API Fault Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
ExceptionCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
StatusCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
ExtendedErrorDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Duplicate Management Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
System Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Required Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Frequently-Occurring Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
API Field Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Relationships Among Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Relabeling Fields and Tabs and the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Contents

Tooling API Objects in the Enterprise WSDL . . . . . . . .
Force.com AppExchange Object Prefixes and the API .
Custom Objects . . . . . . . . . . . . . . . . . . . . . . . . . .
External Objects . . . . . . . . . . . . . . . . . . . . . . . . . .

.
.
.
.

73
74
74
76

Chapter 3: Call Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Characteristics of API Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Factors that Affect Data Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Package Version Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Chapter 4: Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Error Handling for Session Expiration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
More About Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Chapter 5: Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
User Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
User Profile and Permission Sets Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Security Token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Implicit Restrictions for Objects and Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
API Access in Force.com AppExchange Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Outbound Port Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Chapter 6: Using the Partner WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Obtaining the Partner WSDL File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Calls and the Partner WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Objects, Fields, and Field Data and the Partner WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Queries and the Partner WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Namespaces in the Partner WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Package Versions and the Partner WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
User Interface Themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Examples Using the Partner WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Sample query and queryMore Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Sample search Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Sample create Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Sample update Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

REFERENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Chapter 7: Data Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Sales Objects . . . . . . . . . . . . . . . . . . . .
Task and Event Objects . . . . . . . . . . . . . .
Support Objects . . . . . . . . . . . . . . . . . .
Document, Note, and Attachment Objects .
User, Sharing, and Permission Objects . . .

.
.
.
.
.

112
113
114
115
116

Contents

Profile and Permission Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Record Type Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Product and Schedule Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Sharing and Team Selling Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Customizable Forecasting Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Forecasts Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Territory Management 2.0 Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Territory Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Process Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Content Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
ContentNote Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Chatter Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Chatter Feed Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Salesforce Knowledge Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Work.com Badge and Reward Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Work.com Feedback and Performance Cycle Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Chapter 8: Standard Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
AcceptedEventRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
AccountContactRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
AccountCleanInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
AccountContactRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
AccountFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
AccountHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
AccountOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
AccountPartner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
AccountShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
AccountTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
AccountTeamMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
AccountTerritoryAssignmentRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
AccountTerritoryAssignmentRuleItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
AccountTerritorySharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
ActionLinkGroupTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
ActionLinkTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
ActivityHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
AdditionalNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
AgentWork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
AllowedEmailDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Announcement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
ApexClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
ApexComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
ApexLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
ApexPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Contents

ApexTestQueueItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
ApexTestResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
ApexTestResultLimits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
ApexTestRunResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
ApexTestSuite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
ApexTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
AppMenuItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Article Type__DataCategorySelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Article Type__Feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
AssetFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
AssetOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
AssetShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
AssetTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
AssetTokenEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
AssignedResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
AssignmentRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
AsyncApexJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
AttachedContentDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
AttachedContentNote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Attachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
AuraDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
AuraDefinitionBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
AuthConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
AuthConfigProviders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
AuthProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
AuthSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
BackgroundOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
BackgroundOperationResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Bookmark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
BrandTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
BusinessHours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
BusinessProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
CallCenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
CampaignFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
CampaignInfluence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
CampaignInfluenceModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
CampaignMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
CampaignMemberStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
CampaignOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
CampaignShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
CampaignTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

Contents

Case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
CaseArticle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
CaseComment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
CaseContactRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
CaseFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
CaseHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
CaseMilestone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
CaseOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
CaseShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
CaseSolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
CaseStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
CaseTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
CaseTeamMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
CaseTeamRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
CaseTeamTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
CaseTeamTemplateMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
CaseTeamTemplateRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
CategoryData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
CategoryNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
CategoryNodeLocalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
ChatterActivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
ChatterAnswersActivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
ChatterAnswersReputationLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
ChatterConversation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
ChatterConversationMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
ChatterMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
ClientBrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
CollaborationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
CollaborationGroupFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
CollaborationGroupMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
CollaborationGroupMemberRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
CollaborationGroupRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
CollaborationInvitation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
CombinedAttachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Community (Zone) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
ConnectedApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
ContactCleanInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
ContactFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
ContactHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
ContactOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
ContactShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
ContactTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
ContentAsset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

Contents

ContentDistribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
ContentDistributionView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
ContentDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
ContentDocumentFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
ContentDocumentHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
ContentDocumentLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
ContentFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
ContentFolderItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
ContentFolderLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
ContentFolderMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
ContentHubItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
ContentHubRepository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
ContentNote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
ContentVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
ContentVersionHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
ContentWorkspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
ContentWorkspaceDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Contract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
ContractContactRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
ContractFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
ContractHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
ContractLineItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
ContractLineItemHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
ContractStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
ContractTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
CorsWhitelistEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
CronJobDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
CronTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
CurrencyType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
CustomBrand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
CustomBrandAsset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Custom Metadata Type__mdt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
Custom Object__Feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
CustomPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
CustomPermissionDependency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
DandBCompany . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
DashboardComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
DashboardComponentFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
DashboardFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
DashboardTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
DataAssessmentFieldMetric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
DataAssessmentMetric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
DataAssessmentValueMetric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694

Contents

DatacloudCompany . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
DatacloudContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
DatacloudDandBCompany . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
DatacloudOwnedEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
DatacloudPurchaseUsage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
DatacloudSocialHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
DatedConversionRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
DcSocialProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
DcSocialProfileHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
DeclinedEventRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Division . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
DivisionLocalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
DocumentAttachmentMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
DocumentTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
DomainSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
DuplicateRecordItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
DuplicateRecordSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
DuplicateRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
EmailDomainKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
EmailMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
EmailMessageRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
EmailServicesAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
EmailServicesFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
EmailStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
EmailTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
EmbeddedServiceDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
Entitlement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
EntitlementContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
EntitlementFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
EntitlementHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
EntitlementTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
EntityHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
EntityMilestone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
EntitySubscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
EnvironmentHubMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
EventFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
EventLogFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
EventRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
EventTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
EventWhoRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
ExternalDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000

Contents

ExternalDataUserAuth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
FeedAttachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
FeedComment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
FeedItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
FeedLike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
FeedPollChoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025
FeedPollVote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
FeedPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
FeedRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
FeedTrackedChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
FieldHistoryArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
FieldPermissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
FiscalYearSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043
FlexQueueItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1046
FlowInterview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048
FlowInterviewOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049
FlowInterviewShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052
FolderedContentDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
ForecastingAdjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056
ForecastingFact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
ForecastingItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
ForecastingOwnerAdjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069
ForecastingQuota . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
ForecastingType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1076
ForecastingUserPreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1078
ForecastShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1080
Goal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1082
GoalFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1084
GoalHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090
GoalLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
GoalShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
GoogleDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093
Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1094
GroupMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1097
HashtagDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098
Holiday . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1100
Idea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1103
IdeaComment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1109
IdeaReputation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1112
IdeaReputationLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1114
IdeaTheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
KnowledgeableUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
KnowledgeArticle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118

Contents

KnowledgeArticleVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1120
KnowledgeArticleVersionHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
KnowledgeArticleViewStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
KnowledgeArticleVoteStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
Lead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
LeadCleanInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1151
LeadFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1165
LeadHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
LeadOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174
LeadShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176
LeadStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1178
LeadTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1180
LimitAllocationPerApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1181
LineitemOverride . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
LinkedArticle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185
LinkedArticleFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187
LinkedArticleHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1190
ListView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1192
ListViewChart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
ListViewChartInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1195
LiveAgentSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1199
LiveAgentSessionHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1203
LiveAgentSessionOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1204
LiveAgentSessionShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1206
LiveChatBlockingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1207
LiveChatButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1209
LiveChatButtonDeployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1217
LiveChatButtonSkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1218
LiveChatDeployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1219
LiveChatSensitiveDataRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
LiveChatTranscript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
LiveChatTranscriptEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1232
LiveChatTranscriptHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234
LiveChatTranscriptOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
LiveChatTranscriptShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
LiveChatTranscriptSkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1239
LiveChatUserConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1240
LiveChatUserConfigProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
LiveChatUserConfigUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
LiveChatVisitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
LoginEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
LoginGeo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
LoginHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
LoginIp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263

Contents

LookedUpFromActivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1265
Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1271
MacroInstruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1274
MailmergeTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1275
MatchingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1278
MatchingRuleItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1281
MetadataPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1283
MetadataPackageVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284
Metric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1287
MetricDataLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1290
MetricDataLinkHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1291
MetricFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1292
MetricHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1297
MetricsDataFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1298
MetricShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301
MilestoneType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1303
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1304
NamedCredential . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1307
NavigationLinkSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
NavigationMenuItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1311
NavigationMenuItemLocalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1314
Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1315
NetworkActivityAudit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1323
NetworkMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
NetworkMemberGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331
NetworkModeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
NetworkPageOverride . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1334
NetworkSelfRegistration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
NewsFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1336
Note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
OauthToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
NoteAndAttachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1347
NoteTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
ObjectPermissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350
ObjectTerritory2AssignmentRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1353
ObjectTerritory2AssignmentRuleItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1355
ObjectTerritory2Association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
OpenActivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1358
OperatingHours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
OperatingHoursFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
OperatingHoursHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1370
Opportunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
OpportunityCompetitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1381
OpportunityContactRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382

Contents

OpportunityFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1384
OpportunityFieldHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392
OpportunityHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
OpportunityLineItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
OpportunityLineItemSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1402
OpportunityOverride . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1406
OpportunityOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1409
OpportunityPartner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1411
OpportunityShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1412
OpportunitySplit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1414
OpportunitySplitType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1416
OpportunityStage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419
OpportunityTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1422
OpportunityTeamMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1423
Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
OrderFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1435
OrderHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
OrderItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443
OrderItemFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446
OrderItemHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1453
OrderOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1454
Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1457
OrgWideEmailAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1477
OwnedContentDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
PackageLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1480
PackagePushError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1482
PackagePushJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1484
PackagePushRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1487
PackageSubscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1490
Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1494
PartnerNetworkConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1496
PartnerNetworkRecordConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1499
PartnerNetworkSyncLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1503
PartnerRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505
Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506
PermissionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1508
PermissionSetAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1514
PermissionSetLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1516
PermissionSetLicenseAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1519
PlatformAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1520
PresenceUserConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1527
PresenceUserConfigProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1529
PresenceUserConfigUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1530
Pricebook2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1530

Contents

Pricebook2History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1534
PricebookEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1535
ProcessDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1538
ProcessInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1540
ProcessInstanceHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1543
ProcessInstanceStep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545
ProcessInstanceNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1548
ProcessInstanceWorkitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
ProcessNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552
Product2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
Product2Feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1560
ProductEntitlementTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1567
Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1568
ProfileSkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1571
ProfileSkillEndorsement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1573
ProfileSkillEndorsementFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1574
ProfileSkillEndorsementHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1579
ProfileSkillFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1580
ProfileSkillHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1585
ProfileSkillShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1586
ProfileSkillUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1588
ProfileSkillUserFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1589
ProfileSkillUserHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1593
PushTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1594
QuantityForecast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1597
QuantityForecastHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1604
QueueRoutingConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1607
Question . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1609
QuestionDataCategorySelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1614
QuestionReportAbuse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1616
QuestionSubscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1617
QueueSobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1618
QuickText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1619
QuickTextHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1621
QuickTextOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1622
QuickTextShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1624
Quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1626
QuoteDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1639
QuoteFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1641
QuoteLineItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1645
RecentlyViewed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1650
RecordType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1653
RecordTypeLocalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1656
Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1658

Contents

ReplyReportAbuse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1660
Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1661
ReportFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1665
ReportTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1673
ReputationLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1674
ReputationLevelLocalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1675
ReputationPointsRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1677
ResourceAbsence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1679
ResourceAbsenceFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1682
ResourceAbsenceHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685
RevenueForecast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1686
RevenueForecastHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1694
RuleTerritory2Association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1697
SamlSsoConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1698
Scontrol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1703
ScontrolLocalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1706
SearchPromotionRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1711
SecureAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1712
SecureAgentsCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1714
SecurityCustomBaseline (Beta) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1715
SelfServiceUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1717
ServiceAppointment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1720
ServiceAppointmentFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1728
ServiceAppointmentHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1730
ServiceAppointmentOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1731
ServiceAppointmentShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1733
ServiceChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1735
ServiceChannelStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1736
ServiceContract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1737
ServiceContractFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1746
ServiceContractHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1753
ServiceContractOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1754
ServiceContractShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1756
ServicePresenceStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1758
ServiceResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1759
ServiceResourceCapacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1762
ServiceResourceCapacityFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1765
ServiceResourceCapacityHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1767
ServiceResourceFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1768
ServiceResourceHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1771
ServiceResourceOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1772
ServiceResourceShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1774
ServiceResourceSkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1775
ServiceResourceSkillFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1777

Contents

ServiceResourceSkillHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1779
ServiceTerritory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1780
ServiceTerritoryFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1785
ServiceTerritoryHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1787
ServiceTerritoryMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1788
ServiceTerritoryMemberFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1793
ServiceTerritoryMemberHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1795
SessionPermSetActivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1796
SetupAuditTrail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1798
SetupEntityAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1800
SignupRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1802
Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1809
SiteDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1815
SiteHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1816
Skill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1817
SkillProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1819
SkillRequirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1819
SkillRequirementFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1821
SkillRequirementHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1824
SkillUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
SlaProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1826
Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1829
SolutionFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1833
SolutionHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1840
SolutionStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1842
SolutionTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1843
SOSDeployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1845
SOSSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1847
SOSSessionActivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1850
SOSSessionHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1851
SOSSessionOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1852
SOSSessionShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1854
Stamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1856
StampAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1856
StaticResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1857
StreamingChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1860
TagDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1861
Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1863
TaskFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1874
TaskPriority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
TaskRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1883
TaskStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1885
TaskTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1887
TaskWhoRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1888

Contents

TenantSecret . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1889
Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1893
Territory2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1896
Territory2Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1899
Territory2ModelHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1901
Territory2Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1902
TestSuiteMembership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1903
ThirdPartyAccountLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1904
TimeSlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1907
TimeSlotHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1909
Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1910
TopicAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1911
TopicFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1913
TopicLocalization—Beta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1919
TwoFactorInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1924
TwoFactorMethodsInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1925
TwoFactorTempCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1927
UndecidedEventRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1928
User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1930
UserAccountTeamMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1970
UserAppInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1973
UserAppMenuCustomization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
UserAppMenuCustomizationShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
UserAppMenuItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1976
UserConfigTransferButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1980
UserConfigTransferSkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1980
UserCustomBadge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
UserCustomBadgeLocalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1982
UserFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1984
UserLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1992
UserLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
UserMembershipSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
UserPackageLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1998
UserPreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1999
UserProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2000
UserProfileFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2018
UserProvAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2025
UserProvAccountStaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2028
UserProvMockTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2031
UserProvisioningConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2033
UserProvisioningLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2037
UserProvisioningRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2038
UserProvisioningRequestOwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2044
UserProvisioningRequestShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2045

Contents

UserRecordAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2047
UserRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2049
UserServicePresence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2053
UserShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2054
UserTeamMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2056
UserTerritory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2057
UserTerritory2Association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2059
VerificationHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2060
VoiceCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2066
VoiceCallList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2069
VoiceCallListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2070
VoiceCallListShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2071
VoiceCallShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2072
VoiceMailContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2073
VoiceMailContentShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2075
VoiceUserLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2076
VoiceUserLineShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2077
VoiceVendorInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2078
VoiceVendorLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2079
VoiceVendorLineShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2081
Vote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2082
WebLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2084
WebLinkLocalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2089
WorkAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2094
WorkAccessShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2095
WorkBadge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2096
WorkBadgeDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2099
WorkBadgeDefinitionHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2102
WorkBadgeDefinitionShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2103
WorkCoaching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2105
WorkCoachingFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2106
WorkCoachingHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2112
WorkCoachingShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2113
WorkFeedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2115
WorkFeedbackHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2116
WorkFeedbackQuestion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2117
WorkFeedbackQuestionHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2120
WorkFeedbackQuestionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2121
WorkFeedbackQuestionSetHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2122
WorkFeedbackQuestionSetShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2123
WorkFeedbackQuestionShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2124
WorkFeedbackRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2126
WorkFeedbackRequestFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2131
WorkFeedbackRequestHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2136

Contents

WorkFeedbackRequestShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2137
WorkFeedbackShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2139
WorkGoal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2140
WorkGoalCollaborator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2146
WorkGoalCollaboratorHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2147
WorkGoalFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2149
WorkGoalHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2155
WorkGoalLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2156
WorkGoalShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2157
WorkOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2158
WorkOrderFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2168
WorkOrderHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2172
WorkOrderLineItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2173
WorkOrderLineItemFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2181
WorkOrderLineItemHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2185
WorkOrderShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2186
WorkPerformanceCycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2187
WorkPerformanceCycleFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2190
WorkPerformanceCycleHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2195
WorkPerformanceCycleShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2196
WorkReward . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2198
WorkRewardFund . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2200
WorkRewardFundHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2202
WorkRewardFundShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2203
WorkRewardFundType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2204
WorkRewardFundTypeHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2207
WorkRewardFundTypeShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208
WorkRewardHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210
WorkRewardShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2211
WorkThanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2212
WorkThanksShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2213
WorkType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2214
WorkTypeFeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2216
WorkTypeHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2219
Reusable Terms for API Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2220

Chapter 9: Core Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2221
convertLead() . . . . . . . .
LeadConvertResult
create() . . . . . . . . . . . .
SaveResult . . . . . .
delete() . . . . . . . . . . . .
DeleteResult . . . . .
emptyRecycleBin() . . . . .

.
.
.
.
.
.
.

2222
2228
2229
2238
2239
2242
2242

Contents

EmptyRecycleBinResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2245
executeListView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2245
ExecuteListViewRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2246
ExecuteListViewResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2246
ListViewColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2247
ListViewRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2247
ListViewRecordColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2248
findDuplicates() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2248
getDeleted() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2252
GetDeletedResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2256
getUpdated() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2256
GetUpdatedResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
invalidateSessions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
InvalidateSessionsResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2262
login() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2262
LoginResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2267
logout() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2268
merge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2269
MergeResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2275
performQuickActions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2275
PerformQuickActionResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2277
process() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2277
ProcessResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2280
query() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2281
QueryResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2284
QueryLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2287
queryAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2287
queryMore() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2290
QueryResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2293
QueryLocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2294
retrieve() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2294
search() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2297
SearchResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2300
undelete() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2300
UndeleteResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2303
update() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2304
SaveResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2310
upsert() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2311
UpsertResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2316

Chapter 10: Describe Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2317
describeAllTabs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2318
describeAppMenu() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2319
DescribeAppMenuResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2320

Contents

describeApprovalLayout() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2321
DescribeApprovalLayoutResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2323
describeAvailableQuickActions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2323
DescribeAvailableQuickActionResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2324
describeCompactLayouts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2325
DescribeCompactLayoutsResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2327
describeDataCategoryGroups() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2328
DescribeDataCategoryGroupResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2330
describeDataCategoryGroupStructures() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2331
describeDataCategoryGroupStructures() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2335
describeGlobal() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2335
DescribeGlobalResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2337
describeGlobalTheme() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2339
DescribeGlobalTheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2340
describeKnowledge()Call Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2341
describeLayout() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2342
DescribeLayoutResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2347
describePrimaryCompactLayouts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2360
describeQuickActions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2361
DescribeQuickActionResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2363
describeSearchScopeOrder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2367
DescribeSearchScopeOrderResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2368
describeSearchLayouts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2369
DescribeSearchLayoutResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2370
describeSObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2371
describeSObjectResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2374
describeSObjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2374
DescribeSObjectResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2378
describeSoftphoneLayout() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2390
describeSoqlListViews() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2394
DescribeSoqlListView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2395
DescribeSoqlListViewParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2395
DescribeSoqlListViewResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2396
DescribeSoqlListViewsRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2396
ListViewColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2396
ListViewOrderBy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2397
describeTabs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2397
describeTabSetResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2400
describeTheme() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2402
DescribeThemeResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2404
DescribeThemeItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2404

Chapter 11: Utility Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2405
getServerTimestamp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2405

Contents

getServerTimestampResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2407
getUserInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2407
getUserInfoResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2409
renderEmailTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2410
RenderEmailTemplateResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2413
resetPassword() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2414
sendEmail() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2416
SendEmailResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2425
sendEmailMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2426
setPassword() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2429

Chapter 12: SOAP Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2431
AllOrNoneHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2432
AllowFieldTruncationHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2433
AssignmentRuleHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2435
CallOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2436
DisableFeedTrackingHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2437
DuplicateRuleHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2438
EmailHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2439
LimitInfoHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2441
LocaleOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2442
LoginScopeHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2443
MruHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2444
OwnerChangeOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2445
PackageVersionHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2448
QueryOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2449
SessionHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2450
UserTerritoryDeleteHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2450

USING THE API WITH SALESFORCE FEATURES . . . . . . . . . . . . . . . . . . . . . 2451
Chapter 13: Implementation Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2451
Choosing a User for an Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2452
Login Server URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2452
Log in to the Login Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453
Typical API Call Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453
Salesforce Sandbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453
Multiple Instances of Salesforce Database Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2454
Content Type Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2454
Monitoring API Traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2454
API Usage Metering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2454
Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2456
HTTP Persistent Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457
HTTP Chunking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457

Contents

Internationalization and Character Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457
XML Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457
.NET, Non-String Fields, and the Enterprise WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2458

Chapter 14: Outbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2459
Understanding Outbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2460
Understanding Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2461
Setting Up Outbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2461
Setting Up User Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2462
Defining Outbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2462
Downloading the Salesforce Client Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2463
Viewing Outbound Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2463
Tracking Outbound Message Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2464
Considerations for Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2464
Understanding the Outbound Messaging WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2464
Building a Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2466

Chapter 15: Data Loading and Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2468
Choosing the Right API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2469
Client Application Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2469
Salesforce Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2470
Best Practices with Any Data Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2470
Integration and Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2471

Chapter 16: Data Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2472
API Calls for Data Replication . . . . . . . . . . . . . .
Scope of Data Replication . . . . . . . . . . . . . . . .
Data Replication Steps . . . . . . . . . . . . . . . . . .
Object-Specific Requirements for Data Replication
Polling for Changes . . . . . . . . . . . . . . . . . . . .
Checking for Structural Changes in the Object . . .

.
.
.
.
.
.

2473
2473
2473
2474
2474
2475

Chapter 17: Feature-Specific Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2476
Archived Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2477
Person Account Record Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2477
Opportunity Forecast Override Business Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2478
OpportunityOverride Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2479
LineitemOverride Object Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2481
External Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2482
Call Centers and the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2482
Implementing Salesforce Integrations on Force.com . . . . . . . . . . . . . . . . . . . . . . . . . . . 2484
Articles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2485
Data Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2488

GLOSSARY

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2491

Contents

INDEX

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2507

GETTING STARTED

CHAPTER 1
In this chapter ...
•

When to Use the
SOAP API

•

Customize, Integrate,
and Extend Your
Salesforce Solutions

•

Supported Salesforce
Editions

•

Standards
Compliance

•

Development
Platforms

•

SOAP API Support
Policy

•

Choosing a WSDL

•

Related Resources

•

Quick Start

Introducing SOAP API
Salesforce provides programmatic access to your org’s information using simple, powerful, and secure
application programming interfaces. To use this document, you should have a basic familiarity with
software development, Web services, and the Salesforce user interface.
Any functionality described in this guide is available if your organization has the API feature enabled.
This feature is enabled by default for Performance, Unlimited, Enterprise, and Developer Editions. Some
Professional Edition organizations may also have the API enabled. If you cannot access the features you
see in this guide, contact Salesforce.
Note: Salesforce Education Services offers a suite of training courses to enable developers to
design, create, integrate, and extend applications built on the Force.com platform. Be sure to visit
http://www.salesforce.com/training to learn more.

Introducing SOAP API

When to Use the SOAP API

When to Use the SOAP API
The Salesforce prebuilt applications provide powerful CRM functionality. In addition, Salesforce provides the ability to customize the
prebuilt applications to fit your organization. However, your organization may have complex business processes that are unsupported
by the existing functionality. When this is the case, the Force.com platform includes a number of ways for advanced administrators and
developers to implement custom functionality. These include the SOAP API, Apex, and Visualforce.

SOAP API
Use SOAP API to create, retrieve, update or delete records, such as accounts, leads, and custom objects. With more than 20 different
calls, SOAP API also allows you to maintain passwords, perform searches, and much more. Use SOAP API in any language that supports
Web services.

REST API
REST API provides a powerful, convenient, and simple REST-based web services interface for interacting with Salesforce. Its advantages
include ease of integration and development, and it’s an excellent choice of technology for use with mobile applications and web
projects. However, if you have many records to process, consider using Bulk API, which is based on REST principles and optimized for
large sets of data.

Bulk API
Bulk API is based on REST principles and is optimized for loading or deleting large sets of data. You can use it to query, queryAll, insert,
update, upsert, or delete many records asynchronously by submitting batches. Salesforce processes batches in the background.
SOAP API, in contrast, is optimized for real-time client applications that update a few records at a time. You can use SOAP API for processing
many records, but when the data sets contain hundreds of thousands of records, SOAP API is less practical. Bulk API is designed to make
it simple to process data from a few thousand to millions of records.

Metadata API
Use Metadata API to retrieve, deploy, create, update, or delete customizations for your org. The most common use is to migrate changes
from a sandbox or testing org to your production environment. Metadata API is intended for managing customizations and for building
tools that can manage the metadata model, not the data itself.
The easiest way to access the functionality in Metadata API is to use the Force.com IDE or Force.com Migration Tool. Both tools are built
on top of Metadata API and use the standard Eclipse and Ant tools, respectively, to simplify working with Metadata API.
• Force.com IDE is built on the Eclipse platform, for programmers familiar with integrated development environments. Code, compile,
test, and deploy from within the IDE.
• The Force.com Migration Tool is ideal if you use a script or the command line for moving metadata between a local directory and a
Salesforce org.

Apex
Use Apex if you want to:
• Create Web services.
• Create email services.

Introducing SOAP API

Customize, Integrate, and Extend Your Salesforce Solutions

• Perform complex validation over multiple objects.
• Create complex business processes that are not supported by workflow.
• Create custom transactional logic (logic that occurs over the entire transaction, not just with a single record or object).
• Attach custom logic to another operation, such as saving a record, so that it occurs whenever the operation is executed, regardless
of whether it originates in the user interface, a Visualforce page, or from SOAP API.
For more information, see the Apex Developer Guide.

Visualforce
Visualforce consists of a tag-based markup language that gives developers a more powerful way of building applications and customizing
the Salesforce user interface. With Visualforce you can:
• Build wizards and other multistep processes.
• Create your own custom flow control through an application.
• Define navigation patterns and data-specific rules for optimal, efficient application interaction.
For more information, see the Visualforce Developer's Guide.

Customize, Integrate, and Extend Your Salesforce Solutions
The Force.com platform allows you to customize, integrate, and extend your Salesforce organization using the language and platform
of your choice:
• Customize Salesforce with custom fields, links, objects, page layouts, buttons, record types, s-controls, and tabs to meet specific
business requirements.
• Integrate Salesforce with your organization’s ERP and finance systems, deliver real-time sales and support information to company
portals, and populate critical business systems with customer information.
• Extend Salesforce in presentation, business logic, and data services with new functionality that reflects the business requirements
of your organization.
For more information about Force.com solutions, developer resources, and community resources, go to Salesforce Developers.

Supported Salesforce Editions
To use SOAP API, your organization must use Enterprise Edition, Performance Edition, Unlimited Edition, or Developer Edition. If you are
an existing Salesforce customer and want to upgrade to Enterprise, Unlimited, or Performance Edition, contact your account representative.
To develop Web service client applications, it is strongly recommended that you use Developer Sandbox, which is an exact replica of
your Salesforce deployment, including all customization and data. For more information, see
http://www.salesforce.com/products/sandbox.jsp.
Developer Edition provides access to all of the features available with Enterprise Edition. Developer Edition is constrained only by the
number of users and the amount of storage space. Developer Edition provides a development context that allows you to build and test
your solutions without affecting your organization’s live data. Developer Edition accounts are available for free at
https://developer.salesforce.com/page/Getting_Started.

Introducing SOAP API

Standards Compliance

Standards Compliance
SOAP API is implemented to comply with the following specifications:
Standard Name

Website

Simple Object Access Protocol (SOAP) 1.1
Web Service Description Language (WSDL) 1.1

http://www.w3.org/TR/2001/NOTE-wsdl-20010315

WS-I Basic Profile 1.1

http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html

Development Platforms
SOAP API works with current SOAP development environments, including, but not limited to, Visual Studio .NET 2005. In this document,
we provide examples in Java and C# (.NET). The Java examples are based on WSC 20.0 (WSC) and JDK 6 (Java Platform Standard Edition
Development Kit 6). Additional versions of WSC are available at https://github.com/forcedotcom/wsc and
http://mvnrepository.com/artifact/com.force.api/force-wsc. To see a complete list of compatible
development platforms and more sample code, go to developer.salesforce.com.
Note: Development platforms vary in their SOAP implementations. Implementation differences in certain development platforms
might prevent access to some or all of the features in the API. If you are using Visual Studio for .NET development, we recommend
that you use Visual Studio 2003 or higher.

SOAP API Support Policy
Salesforce recommends that your new client applications use the most recent version of the Force.com WSDL file to fully exploit the
benefits of richer features and greater efficiency. You can navigate to the most recent WSDL for your organization from Setup by entering
“API” in the Quick Find box, then selecting API. When a new version is released, use the following steps in Quick Start to update
your WSDL:
• Regenerate the WSDL file (see Step 2: Generate or Obtain the Web Service WSDL)
• Import it into your environment (see Step 3: Import the WSDL File Into Your Development Platform)

Backward Compatibility
Salesforce strives to make backward compatibility easy when using the Force.com platform.
Each new Salesforce release consists of two components:
• A new release of platform software that resides on Salesforce systems
• A new version of SOAP API
For example, the Winter ’07 release included SOAP API version 9.0 and the Summer ’07 release included SOAP API version 10.0.
We maintain support for each SOAP API version across releases of the platform software. SOAP API is backward compatible in that an
application created to work with a given SOAP API version will continue to work with that same SOAP API version in future platform
software releases.

Introducing SOAP API

Choosing a WSDL

Salesforce does not guarantee that an application written against one SOAP API version will work with future SOAP API versions: Changes
in method signatures and data representations are often required as we continue to enhance SOAP API. However, we strive to keep
SOAP API consistent from version to version with minimal if any changes required to port applications to newer SOAP API versions.
For example, an application written using SOAP API version 9.0 which shipped with the Winter ’07 release will continue to work with
SOAP API version 9.0 on the Summer ’07 release and on future releases beyond that. However, that same application may not work with
SOAP API version 10 without modifications to the application.

SOAP API End-of-Life
Salesforce is committed to supporting each SOAP API version for a minimum of three years from the date of first release. In order to
improve the quality and performance of SOAP API, versions that are more than three years old may cease to be supported.
When a SOAP API version is scheduled to be unsupported, an advance end-of-life notice will be given at least one year before support
for SOAP API version is ended. Salesforce will directly notify customers using SOAP API versions scheduled for end of life.

Choosing a WSDL
There are two Force.com Web services for which you can obtain WSDL files for API access:
• Force.com Enterprise WSDL—This API is for most enterprise users who are developing client applications for their organization.
The enterprise WSDL file is a strongly typed representation of your organization’s data. It provides information about your schema,
data types, and fields to your development environment, allowing for a tighter integration between it and the Force.com Web
service. This WSDL changes if custom fields or custom objects are added to, renamed, or removed from, your organization’s Salesforce
configuration. If you are downloading an enterprise WSDL and you have managed packages installed in your organization, you need
to take an extra step to select the version of each installed package to include in the generated WSDL.
Note the following when generating the enterprise WSDL:
– If new custom fields or objects are added to, renamed, or removed from your organization’s information, you need to regenerate
the WSDL file in order to access them.
– The generated WSDL contains the objects and fields in your organization, including those available in the selected versions of
each installed package. If a field or object is added in a later package version, you must generate the enterprise WSDL with that
package version to work with the object or field in your API integration.
• Force.com Partner WSDL—This API is for Salesforce partners who are developing client applications for multiple organizations.
As a loosely-typed representation of the Salesforce object model, the partner WSDL can be used to access data within any organization.

Related Resources
The Salesforce developer website provides a full suite of developer toolkits, sample code, sample SOAP messages, community-based
support, and other resources to help you with your development projects. Be sure to visit
https://developer.salesforce.com/page/Getting_Started for more information, or visit
https://developer.salesforce.com/signup to sign up for a free Developer Edition account.
You can visit these websites to find out more about Salesforce applications:
• Salesforce for information about the Salesforce application.
• Force.com AppExchange for access to apps created for Salesforce.
• Salesforce.com Community for services to ensure Salesforce customer success.

Introducing SOAP API

Quick Start

Quick Start
Use this quick start to create a sample application in your development environment.
Note: Before you begin building an integration or other client application:
• Install your development platform according to its product documentation.
• Read through all the steps before beginning this quick start. You may also wish to review the rest of this document to familiarize
yourself with terms and concepts.

Step 1: Obtain a Salesforce Developer Edition Organization
If you are not already a member of the Force.com developer community, go to developer.salesforce.com/signup and
follow the instructions for signing up for a Developer Edition organization. Even if you already have Enterprise Edition, Unlimited Edition,
or Performance Edition, use Developer Edition for developing, staging, and testing your solutions against sample data to protect your
organization’s live data. This is especially true for applications that insert, update, or delete data (as opposed to simply reading data).
If you already have a Developer Edition organization, verify that you have the “API Enabled” permission. This permission is enabled by
default, but may have been changed by an administrator. For more information, see the help in the Salesforce user interface.

Step 2: Generate or Obtain the Web Service WSDL
To access the Force.com Web service, you need a Web Service Description Language (WSDL) file. The WSDL file defines the Web service
that is available to you. Your development platform uses this WSDL to generate an API to access the Force.com Web service it defines.
You can either obtain the WSDL file from your organization’s Salesforce administrator or you can generate it yourself if you have access
to the WSDL download page in the Salesforce user interface. You can navigate to the most recent WSDL for your organization from
Setup by entering “API” in the Quick Find box, then selecting API.
For more information about WSDL, see http://www.w3.org/TR/wsdl.

Generating the WSDL File for Your Organization
Any user with the “Modify All Data” permission can download the Web Services Description Language (WSDL) file to integrate and
extend Salesforce using the API. (The System Administrator profile has this permission.)
The WSDL file is dynamically generated based on which type of WSDL file (enterprise or partner) you download. The generated WSDL
defines all of the API calls, objects (including standard and custom objects), and fields that are available for API access for your organization.
To generate the WSDL file for your organization:
1. Log in to your Enterprise, Unlimited, Performance, or Developer Edition Salesforce account. You must log in as an administrator or
as a user who has the “Modify All Data” permission. Logins are checked to ensure they are from a known IP address. For more
information, see “Restrict Where and When Users Can Log In to Salesforce” in the Salesforce online help.
2. From Setup, enter “API” in the Quick Find box, then select API to display the WSDL download page.
3. Download the appropriate WSDL:
• If you’re downloading an enterprise WSDL and you have managed packages installed in your org, click Generate Enterprise
WSDL. Salesforce prompts you to select the version of each installed package to include in the generated WSDL.
• Otherwise, right-click the link for the appropriate WSDL document to save it to a local directory. In the menu, Internet Explorer
users can choose Save Target As, while Mozilla Firefox users can choose Save Link As.

Introducing SOAP API

Step 3: Import the WSDL File Into Your Development Platform

Step 3: Import the WSDL File Into Your Development Platform
Once you have the WSDL file, you need to import it into your development platform so that your development environment can generate
the necessary objects for use in building client Web service applications in that environment. This section provides sample instructions
for WSC and Microsoft Visual Studio. For instructions about other development platforms, see your platform’s product documentation.
Note: The process for importing WSDL files is identical for the enterprise and partner WSDL files.

Instructions for Java Environments (WSC)
Java environments access the API through Java objects that serve as proxies for their server-side counterparts. Before using the API, you
must first generate these objects from your organization’s WSDL file.
Each SOAP client has its own tool for this process. For WSC, use the wsdlc utility.
Note: Before you run wsdlc, you must have the WSC JAR file installed on your system and referenced in your classpath.
The basic syntax for wsdlc is:
java –classpath pathToJAR/wsc-22.jar com.sforce.ws.tools.wsdlc pathToWsdl/WsdlFilename
pathToOutputJar/OutputJarFilename

This command generates an output jar file based on the specified WSDL file. After the output jar file is created, reference it along with
the wsc jar file (for example, wsc-22.jar) in your Java program to create a client application.

Instructions for Microsoft Visual Studio
Visual Studio languages access the API through objects that serve as proxies for their server-side counterparts. Before using the API, you
must first generate these objects from your organization’s WSDL file.
Once you have the proxy classes for the server-side objects, you need to ensure that you specify whether you have set any values on
non-string fields. For more information, see Implementation Considerations.
Visual Studio provides two approaches for importing your WSDL file and generating an XML Web service client: an IDE-based approach
and a command line approach. This walkthrough describes how to import your WSDL file through the IDE.
Note: Before you begin, the first step is to create a new application or open an existing application in Visual Studio. In addition,
you need to have generated the WSDL file, as described in Generating the WSDL File for Your Organization.
An XML Web service client is any component or application that references and uses an XML Web service. This does not necessarily
need to be a client-based application. In fact, in many cases, your XML Web service clients might be other Web applications, such as
Web Forms or even other XML Web services. When accessing XML Web services in managed code, a proxy class and the .NET Framework
handle all of the infrastructure coding.
To access an XML Web service from managed code:
1. Name your project Walkthrough or change the using directive in the following sample to
your_project_name.web_reference_name. Then, add a Web reference to your project for the XML Web service that
you want to access. The Web reference creates a proxy class with methods that serve as proxies for each exposed method of the
XML Web service.
2. Add the namespace for the Web reference.
3. Create an instance of the proxy class and then access the methods of that class as you would the methods of any other class.
You can add either a .NET 2.0 style Web reference, or a .NET 3.0 style Service reference, depending on your version of Visual Studio and
preferred developer environment. A .NET 3.0 style reference uses services like SoapClient instead of SforceService.

Introducing SOAP API

Step 4: Walk Through the Sample Code

To add a Web reference:
Note: These steps may be different depending on the version of Visual Studio that you’re using. For more information, see “Adding
and Removing Web References” in the Visual Studio documentation.
1. If you are using Visual Studio 2010 or earlier, on the Project menu, choose Add Web Reference. For later versions of Visual Studio,
on the Project menu, choose Add Service Reference, select Advanced and then select Add Web Reference.
2. In the URL box of the Add Web Reference dialog box, type the URL to obtain the service description of the XML Web service you
want to access, such as:
c:\WSDLFiles\enterprise.wsdl

3. Click Go to retrieve information about the XML Web service.
4. In the Web reference name box, rename the Web reference to sforce, which is the name you will use for this Web reference.
5. Click Add Reference to add a Web reference for the target XML Web service.
6. Visual Studio retrieves the service description and generates a proxy class to interface between your application and the XML Web
service.
Note: If you are using Visual Basic .Net 1.1 and the enterprise WSDL, you will need to modify the generated Web service client to
overcome a bug in Visual Studio's client generation utility. The API exposes two objects (Case and Event) whose names conflict
with Visual Basic keywords. When the classes that represent these objects are created, Visual Studio wraps the class names with
brackets ([Case] and [Event]). This is the method by which you can reuse keywords.
Unfortunately, in the definition of the SObject class, Visual Studio does not wrap Case and Event to class references in the
System.Xml.Serialization.XmlIncludeAttribute that are part of the SObject definition. To work around this
problem in Visual Studio, you need to edit the XmlIncludeAttribute settings for Case and Event as shown below. This does not
apply to C# and only applies when using the enterprise version of the WSDL.
System.Xml.Serialization.XmlIncludeAttribute(GetType([Event])), _
System.Xml.Serialization.XmlIncludeAttribute(GetType([Case])), _

Step 4: Walk Through the Sample Code
Once you have imported your WSDL file, you can begin building client applications that use the API. Use the following samples to create
a basic client application. Comments embedded in the sample explain each section of code.

Java Sample Code
This section walks through a sample Java client application that uses the WSC SOAP client. The purpose of this sample application is to
show the required steps for logging into the login server and to demonstrate the invocation and subsequent handling of several API
calls.
To run this sample, you must pass the authentication endpoint URL as an argument for your program. You can obtain this URL from the
WSDL file. This sample application performs the following main tasks:
1. Prompts the user for their Salesforce username and password.
2. Calls login() to log in to the single login server and, if the login succeeds, retrieves user information and writes it to the console
along with session information.

Introducing SOAP API

Step 4: Walk Through the Sample Code

3. Calls describeGlobal() to retrieve a list of all available objects for the organization’s data. The describeGlobal method
determines the objects that are available to the logged in user. This call should not be made more than once per session, since the
data returned from the call is not likely to change frequently. The DescribeGlobalResult is echoed to the console.
4. Calls describeSObjects() to retrieve metadata (field list and object properties) for a specified object. The
describeSObject method illustrates the type of metadata information that can be obtained for each object available to the
user. The sample client application executes a describeSObjects() call on the object that the user specifies and then echoes
the returned metadata information to the console. Object metadata information includes permissions, field types and lengths, and
available values for picklist fields and types for referenceTo fields.
5. Calls query(), passing a simple query string ("SELECT FirstName, LastName FROM Contact"), and iterating
through the returned QueryResult.
6. Calls logout() to the log the user out.
The following sample code uses try/catch blocks to handle exceptions that might be thrown by the API calls.
package com.example.samples;
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import

java.io.BufferedReader;
java.io.FileNotFoundException;
java.io.InputStreamReader;
java.io.IOException;
com.sforce.soap.enterprise.DeleteResult;
com.sforce.soap.enterprise.DescribeGlobalResult;
com.sforce.soap.enterprise.DescribeGlobalSObjectResult;
com.sforce.soap.enterprise.DescribeSObjectResult;
com.sforce.soap.enterprise.EnterpriseConnection;
com.sforce.soap.enterprise.Error;
com.sforce.soap.enterprise.Field;
com.sforce.soap.enterprise.FieldType;
com.sforce.soap.enterprise.GetUserInfoResult;
com.sforce.soap.enterprise.LoginResult;
com.sforce.soap.enterprise.PicklistEntry;
com.sforce.soap.enterprise.QueryResult;
com.sforce.soap.enterprise.SaveResult;
com.sforce.soap.enterprise.sobject.Account;
com.sforce.soap.enterprise.sobject.Contact;
com.sforce.soap.enterprise.sobject.SObject;
com.sforce.ws.ConnectorConfig;
com.sforce.ws.ConnectionException;

public class QuickstartApiSample {
private static BufferedReader reader = new BufferedReader(
new InputStreamReader(System.in));
EnterpriseConnection connection;
String authEndPoint = "";
public static void main(String[] args) {
if (args.length < 1) {
System.out.println("Usage: com.example.samples."
+ "QuickstartApiSamples ");
System.exit(-1);

Introducing SOAP API

Step 4: Walk Through the Sample Code

}
QuickstartApiSample sample = new QuickstartApiSample(args[0]);
sample.run();
}
public void run() {
// Make a login call
if (login()) {
// Do a describe global
describeGlobalSample();
// Describe an object
describeSObjectsSample();
// Retrieve some data using a query
querySample();
// Log out
logout();
}
}
// Constructor
public QuickstartApiSample(String authEndPoint) {
this.authEndPoint = authEndPoint;
}
private String getUserInput(String prompt) {
String result = "";
try {
System.out.print(prompt);
result = reader.readLine();
} catch (IOException ioe) {
ioe.printStackTrace();
}
return result;
}
private boolean login() {
boolean success = false;
String username = getUserInput("Enter username: ");
String password = getUserInput("Enter password: ");
try {
ConnectorConfig config = new ConnectorConfig();
config.setUsername(username);
config.setPassword(password);
System.out.println("AuthEndPoint: " + authEndPoint);
config.setAuthEndpoint(authEndPoint);
connection = new EnterpriseConnection(config);

Introducing SOAP API

Step 4: Walk Through the Sample Code

printUserInfo(config);
success = true;
} catch (ConnectionException ce) {
ce.printStackTrace();
}
return success;
}
private void printUserInfo(ConnectorConfig config) {
try {
GetUserInfoResult userInfo = connection.getUserInfo();
System.out.println("\nLogging in ...\n");
System.out.println("UserID: " + userInfo.getUserId());
System.out.println("User Full Name: " + userInfo.getUserFullName());
System.out.println("User Email: " + userInfo.getUserEmail());
System.out.println();
System.out.println("SessionID: " + config.getSessionId());
System.out.println("Auth End Point: " + config.getAuthEndpoint());
System.out
.println("Service End Point: " + config.getServiceEndpoint());
System.out.println();
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
private void logout() {
try {
connection.logout();
System.out.println("Logged out.");
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
/**
* To determine the objects that are available to the logged-in user, the
* sample client application executes a describeGlobal call, which returns
* all of the objects that are visible to the logged-in user. This call
* should not be made more than once per session, as the data returned from
* the call likely does not change frequently. The DescribeGlobalResult is
* simply echoed to the console.
*/
private void describeGlobalSample() {
try {
// describeGlobal() returns an array of object results that
// includes the object names that are available to the logged-in user.
DescribeGlobalResult dgr = connection.describeGlobal();
System.out.println("\nDescribe Global Results:\n");
// Loop through the array echoing the object names to the console

Introducing SOAP API

Step 4: Walk Through the Sample Code

for (int i = 0; i < dgr.getSobjects().length; i++) {
System.out.println(dgr.getSobjects()[i].getName());
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
/**
* The following method illustrates the type of metadata information that can
* be obtained for each object available to the user. The sample client
* application executes a describeSObject call on a given object and then
* echoes the returned metadata information to the console. Object metadata
* information includes permissions, field types and length and available
* values for picklist fields and types for referenceTo fields.
*/
private void describeSObjectsSample() {
String objectToDescribe = getUserInput("\nType the name of the object to "
+ "describe (try Account): ");
try {
// Call describeSObjects() passing in an array with one object type
// name
DescribeSObjectResult[] dsrArray = connection
.describeSObjects(new String[] { objectToDescribe });
// Since we described only one sObject, we should have only
// one element in the DescribeSObjectResult array.
DescribeSObjectResult dsr = dsrArray[0];
// First, get some object properties
System.out.println("\n\nObject Name: " + dsr.getName());
if (dsr.getCustom())
System.out.println("Custom Object");
if (dsr.getLabel() != null)
System.out.println("Label: " + dsr.getLabel());
// Get the permissions on the object
if (dsr.getCreateable())
System.out.println("Createable");
if (dsr.getDeletable())
System.out.println("Deleteable");
if (dsr.getQueryable())
System.out.println("Queryable");
if (dsr.getReplicateable())
System.out.println("Replicateable");
if (dsr.getRetrieveable())
System.out.println("Retrieveable");
if (dsr.getSearchable())
System.out.println("Searchable");
if (dsr.getUndeletable())
System.out.println("Undeleteable");

Introducing SOAP API

Step 4: Walk Through the Sample Code

if (dsr.getUpdateable())
System.out.println("Updateable");
System.out.println("Number of fields: " + dsr.getFields().length);
// Now, retrieve metadata for each field
for (int i = 0; i < dsr.getFields().length; i++) {
// Get the field
Field field = dsr.getFields()[i];
// Write some field properties
System.out.println("Field name: " + field.getName());
System.out.println("\tField Label: " + field.getLabel());
//
//
//
if

This next property indicates that this
field is searched when using
the name search group in SOSL
(field.getNameField())
System.out.println("\tThis is a name field.");

if (field.getRestrictedPicklist())
System.out.println("This is a RESTRICTED picklist field.");
System.out.println("\tType is: " + field.getType());
if (field.getLength() > 0)
System.out.println("\tLength: " + field.getLength());
if (field.getScale() > 0)
System.out.println("\tScale: " + field.getScale());
if (field.getPrecision() > 0)
System.out.println("\tPrecision: " + field.getPrecision());
if (field.getDigits() > 0)
System.out.println("\tDigits: " + field.getDigits());
if (field.getCustom())
System.out.println("\tThis is a custom field.");
// Write the permissions of this field
if (field.getNillable())
System.out.println("\tCan be nulled.");
if (field.getCreateable())
System.out.println("\tCreateable");
if (field.getFilterable())
System.out.println("\tFilterable");
if (field.getUpdateable())
System.out.println("\tUpdateable");
// If this is a picklist field, show the picklist values
if (field.getType().equals(FieldType.picklist)) {
System.out.println("\t\tPicklist values: ");
PicklistEntry[] picklistValues = field.getPicklistValues();

Introducing SOAP API

Step 4: Walk Through the Sample Code

for (int j = 0; j < field.getPicklistValues().length; j++) {
System.out.println("\t\tValue: "
+ picklistValues[j].getValue());
}
}
// If this is a foreign key field (reference),
// show the values
if (field.getType().equals(FieldType.reference)) {
System.out.println("\tCan reference these objects:");
for (int j = 0; j < field.getReferenceTo().length; j++) {
System.out.println("\t\t" + field.getReferenceTo()[j]);
}
}
System.out.println("");
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
private void querySample() {
String soqlQuery = "SELECT FirstName, LastName FROM Contact";
try {
QueryResult qr = connection.query(soqlQuery);
boolean done = false;
if (qr.getSize() > 0) {
System.out.println("\nLogged-in user can see "
+ qr.getRecords().length + " contact records.");
while (!done) {
System.out.println("");
SObject[] records = qr.getRecords();
for (int i = 0; i < records.length; ++i) {
Contact con = (Contact) records[i];
String fName = con.getFirstName();
String lName = con.getLastName();
if (fName == null) {
System.out.println("Contact " + (i + 1) + ": " + lName);
} else {
System.out.println("Contact " + (i + 1) + ": " + fName
+ " " + lName);
}
}
if (qr.isDone()) {
done = true;
} else {
qr = connection.queryMore(qr.getQueryLocator());
}
}

Introducing SOAP API

Step 4: Walk Through the Sample Code

} else {
System.out.println("No records found.");
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
}

C# Sample Code
This section walks through a sample C# client application. The purpose of this sample application is to show the required steps for
logging in and to demonstrate the invocation and subsequent handling of several API calls.
This sample application performs the following main tasks:
1. Prompts the user for their Salesforce username and password.
2. Calls login() to log in to the single login server and, if the login succeeds:
• Sets the returned sessionId into the session header, which is required for session authentication on subsequent API calls.
• Resets the Force.com endpoint to the returned serverUrl, which is the target of subsequent API calls.
All client applications that access the API must complete the tasks in this step before attempting any subsequent API calls.
• Retrieves user information and writes it to the console along with session information.
3. Calls describeGlobal() to retrieve a list of all available objects for the organization’s data. The describeGlobal method
determines the objects that are available to the logged in user. This call should not be made more than once per session, since the
data returned from the call is not likely to change frequently. The DescribeGlobalResult is echoed to the console.
4. Calls describeSObjects() to retrieve metadata (field list and object properties) for a specified object. The
describeSObject method illustrates the type of metadata information that can be obtained for each object available to the
user. The sample client application executes a describeSObjects() call on the object that the user specifies and then echoes
the returned metadata information to the console. Object metadata information includes permissions, field types and lengths, and
available values for picklist fields and types for referenceTo fields.
5. Calls query(), passing a simple query string ("SELECT FirstName, LastName FROM Contact"), and iterating
through the returned QueryResult.
6. Calls logout() to the log the user out.
The following sample code uses try/catch blocks to handle exceptions that might be thrown by the API calls.
The following code begins the sample C# client application.
using
using
using
using
using
using

System;
System.Collections.Generic;
System.Linq;
System.Text;
System.Web.Services.Protocols;
Walkthrough.sforce;

namespace Walkthrough
{
class QuickstartApiSample
{

Introducing SOAP API

Step 4: Walk Through the Sample Code

private SforceService binding;
[STAThread]
static void Main(string[] args)
{
QuickstartApiSample sample = new QuickstartApiSample();
sample.run();
}
public void run()
{
// Make a login call
if (login())
{
// Do a describe global
describeGlobalSample();
// Describe an account object
describeSObjectsSample();
// Retrieve some data using a query
querySample();
// Log out
logout();
}
}
private bool login()
{
Console.Write("Enter username: ");
string username = Console.ReadLine();
Console.Write("Enter password: ");
string password = Console.ReadLine();
// Create a service object
binding = new SforceService();
// Timeout after a minute
binding.Timeout = 60000;
// Try logging in
LoginResult lr;
try
{
Console.WriteLine("\nLogging in...\n");
lr = binding.login(username, password);
}
// ApiFault is a proxy stub generated from the WSDL contract when
// the web service was imported
catch (SoapException e)
{

Introducing SOAP API

Step 4: Walk Through the Sample Code

// Write the fault code to the console
Console.WriteLine(e.Code);
// Write the fault message to the console
Console.WriteLine("An unexpected error has occurred: " + e.Message);
// Write the stack trace to the console
Console.WriteLine(e.StackTrace);
// Return False to indicate that the login was not successful
return false;
}

// Check if the password has expired
if (lr.passwordExpired)
{
Console.WriteLine("An error has occurred. Your password has expired.");
return false;
}

/** Once the client application has logged in successfully, it will use
* the results of the login call to reset the endpoint of the service
* to the virtual server instance that is servicing your organization
*/
// Save old authentication end point URL
String authEndPoint = binding.Url;
// Set returned service endpoint URL
binding.Url = lr.serverUrl;
/** The sample client application now has an instance of the SforceService
* that is pointing to the correct endpoint. Next, the sample client
* application sets a persistent SOAP header (to be included on all
* subsequent calls that are made with SforceService) that contains the
* valid sessionId for our login credentials. To do this, the sample
* client application creates a new SessionHeader object and persist it to
* the SforceService. Add the session ID returned from the login to the
* session header
*/
binding.SessionHeaderValue = new SessionHeader();
binding.SessionHeaderValue.sessionId = lr.sessionId;
printUserInfo(lr, authEndPoint);
// Return true to indicate that we are logged in, pointed
// at the right URL and have our security token in place.
return true;
}
private void printUserInfo(LoginResult lr, String authEP)
{
try

Introducing SOAP API

Step 4: Walk Through the Sample Code

{
GetUserInfoResult userInfo = lr.userInfo;
Console.WriteLine("\nLogging in ...\n");
Console.WriteLine("UserID: " + userInfo.userId);
Console.WriteLine("User Full Name: " +
userInfo.userFullName);
Console.WriteLine("User Email: " +
userInfo.userEmail);
Console.WriteLine();
Console.WriteLine("SessionID: " +
lr.sessionId);
Console.WriteLine("Auth End Point: " +
authEP);
Console.WriteLine("Service End Point: " +
lr.serverUrl);
Console.WriteLine();
}
catch (SoapException e)
{
Console.WriteLine("An unexpected error has occurred: " + e.Message +
" Stack trace: " + e.StackTrace);
}
}
private void logout()
{
try
{
binding.logout();
Console.WriteLine("Logged out.");
}
catch (SoapException e)
{
// Write the fault code to the console
Console.WriteLine(e.Code);
// Write the fault message to the console
Console.WriteLine("An unexpected error has occurred: " + e.Message);
// Write the stack trace to the console
Console.WriteLine(e.StackTrace);
}
}
/**
* To determine the objects that are available to the logged-in
* user, the sample client application executes a describeGlobal
* call, which returns all of the objects that are visible to
* the logged-in user. This call should not be made more than
* once per session, as the data returned from the call likely
* does not change frequently. The DescribeGlobalResult is
* simply echoed to the console.
*/

Introducing SOAP API

Step 4: Walk Through the Sample Code

private void describeGlobalSample()
{
try
{
// describeGlobal() returns an array of object results that
// includes the object names that are available to the logged-in user.
DescribeGlobalResult dgr = binding.describeGlobal();
Console.WriteLine("\nDescribe Global Results:\n");
// Loop through the array echoing the object names to the console
for (int i = 0; i < dgr.sobjects.Length; i++)
{
Console.WriteLine(dgr.sobjects[i].name);
}
}
catch (SoapException e)
{
Console.WriteLine("An exception has occurred: " + e.Message +
"\nStack trace: " + e.StackTrace);
}
}
/**
* The following method illustrates the type of metadata
* information that can be obtained for each object available
* to the user. The sample client application executes a
* describeSObject call on a given object and then echoes
* the returned metadata information to the console. Object
* metadata information includes permissions, field types
* and length and available values for picklist fields
* and types for referenceTo fields.
*/
private void describeSObjectsSample()
{
Console.Write("\nType the name of the object to " +
"describe (try Account): ");
string objectType = Console.ReadLine();
try
{
// Call describeSObjects() passing in an array with one object type name
DescribeSObjectResult[] dsrArray =
binding.describeSObjects(new string[] { objectType });
// Since we described only one sObject, we should have only
// one element in the DescribeSObjectResult array.
DescribeSObjectResult dsr = dsrArray[0];
// First, get some object properties
Console.WriteLine("\n\nObject Name: " + dsr.name);
if (dsr.custom) Console.WriteLine("Custom Object");
if (dsr.label != null) Console.WriteLine("Label: " + dsr.label);

Introducing SOAP API

Step 4: Walk Through the Sample Code

//
if
if
if
if
if
if
if
if

Get the permissions on the object
(dsr.createable) Console.WriteLine("Createable");
(dsr.deletable) Console.WriteLine("Deleteable");
(dsr.queryable) Console.WriteLine("Queryable");
(dsr.replicateable) Console.WriteLine("Replicateable");
(dsr.retrieveable) Console.WriteLine("Retrieveable");
(dsr.searchable) Console.WriteLine("Searchable");
(dsr.undeletable) Console.WriteLine("Undeleteable");
(dsr.updateable) Console.WriteLine("Updateable");

Console.WriteLine("Number of fields: " + dsr.fields.Length);
// Now, retrieve metadata for each field
for (int i = 0; i < dsr.fields.Length; i++)
{
// Get the field
Field field = dsr.fields[i];
// Write some field properties
Console.WriteLine("Field name: " + field.name);
Console.WriteLine("\tField Label: " + field.label);
//
//
//
if

This next property indicates that this
field is searched when using
the name search group in SOSL
(field.nameField)
Console.WriteLine("\tThis is a name field.");

if (field.restrictedPicklist)
Console.WriteLine("This is a RESTRICTED picklist field.");
Console.WriteLine("\tType is: " + field.type.ToString());
if (field.length > 0)
Console.WriteLine("\tLength: " + field.length);
if (field.scale > 0)
Console.WriteLine("\tScale: " + field.scale);
if (field.precision > 0)
Console.WriteLine("\tPrecision: " + field.precision);
if (field.digits > 0)
Console.WriteLine("\tDigits: " + field.digits);
if (field.custom)
Console.WriteLine("\tThis is a custom field.");
//
if
if
if
if

Write the permissions of this field
(field.nillable) Console.WriteLine("\tCan be nulled.");
(field.createable) Console.WriteLine("\tCreateable");
(field.filterable) Console.WriteLine("\tFilterable");
(field.updateable) Console.WriteLine("\tUpdateable");

Introducing SOAP API

Step 4: Walk Through the Sample Code

// If this is a picklist field, show the picklist values
if (field.type.Equals(fieldType.picklist))
{
Console.WriteLine("\tPicklist Values");
for (int j = 0; j < field.picklistValues.Length; j++)
Console.WriteLine("\t\t" + field.picklistValues[j].value);
}
// If this is a foreign key field (reference),
// show the values
if (field.type.Equals(fieldType.reference))
{
Console.WriteLine("\tCan reference these objects:");
for (int j = 0; j < field.referenceTo.Length; j++)
Console.WriteLine("\t\t" + field.referenceTo[j]);
}
Console.WriteLine("");
}
}
catch (SoapException e)
{
Console.WriteLine("An exception has occurred: " + e.Message +
"\nStack trace: " + e.StackTrace);
}
Console.WriteLine("Press ENTER to continue...");
Console.ReadLine();
}
private void querySample()
{
String soqlQuery = "SELECT FirstName, LastName FROM Contact";
try
{
QueryResult qr = binding.query(soqlQuery);
bool done = false;
if (qr.size > 0)
{
Console.WriteLine("Logged-in user can see "
+ qr.records.Length + " contact records.");
while (!done)
{
Console.WriteLine("");
sObject[] records = qr.records;
for (int i = 0; i < records.Length; i++)
{
Contact con = (Contact)records[i];
string fName = con.FirstName;
string lName = con.LastName;
if (fName == null)
Console.WriteLine("Contact " + (i + 1) + ": " + lName);
else

Introducing SOAP API

Step 4: Walk Through the Sample Code

Console.WriteLine("Contact " + (i + 1) + ": " + fName
+ " " + lName);
}
if (qr.done)
{
done = true;
}
else
{
qr = binding.queryMore(qr.queryLocator);
}
}
}
else
{
Console.WriteLine("No records found.");
}
}
catch (Exception ex)
{
Console.WriteLine("\nFailed to execute query succesfully," +
"error message was: \n{0}", ex.Message);
}
Console.WriteLine("\nPress ENTER to continue...");
Console.ReadLine();
}
}
}

The following C# example is the same as the previous C# example, except it uses .NET 3.0 SoapClient services instead of .NET 2.0
SforceService services.
using
using
using
using
using

System;
System.Collections.Generic;
System.Linq;
System.Text;
System.Threading.Tasks;

using System.ServiceModel;
using Walkthrough.sforce;
namespace Walkthrough
{
class QuickstartApiSample
{
private static SoapClient loginClient; // for login endpoint
private static SoapClient client; // for API endpoint
private static SessionHeader header;
private static EndpointAddress endpoint;
static void Main(string[] args)
{
QuickstartApiSample sample = new QuickstartApiSample();
sample.run();

Introducing SOAP API

Step 4: Walk Through the Sample Code

}
public void run()
{
// Make a login call
if (login())
{
// Do a describe global
describeGlobalSample();
// Describe an account object
describeSObjectsSample();
// Retrieve some data using a query
querySample();
// Log out
logout();
}
}
private bool login()
{
Console.Write("Enter username: ");
string username = Console.ReadLine();
Console.Write("Enter password: ");
string password = Console.ReadLine();
// Create a SoapClient specifically for logging in
loginClient = new SoapClient();
// (combine pw and token if necessary)
LoginResult lr;
try
{
Console.WriteLine("\nLogging in...\n");
lr = loginClient.login(null, username, password);
}
catch (Exception e)
{
// Write the fault message to the console
Console.WriteLine("An unexpected error has occurred: " + e.Message);
// Write the stack trace to the console
Console.WriteLine(e.StackTrace);
return false;
}
// Check if the password has expired
if (lr.passwordExpired)
{
Console.WriteLine("An error has occurred. Your password has expired.");
return false;
}

Introducing SOAP API

Step 4: Walk Through the Sample Code

/** Once the client application has logged in successfully, it will use
* the results of the login call to reset the endpoint of the service
* to the virtual server instance that is servicing your organization
*/
// On successful login, cache session info and API endpoint info
endpoint = new EndpointAddress(lr.serverUrl);
/** The sample client application now has a cached EndpointAddress
* that is pointing to the correct endpoint. Next, the sample client
* application sets a persistent SOAP header that contains the
* valid sessionId for our login credentials. To do this, the sample
* client application creates a new SessionHeader object. Add the session
* ID returned from the login to the session header
*/
header = new SessionHeader();
header.sessionId = lr.sessionId;
// Create and cache an API endpoint client
client = new SoapClient("Soap", endpoint);
printUserInfo(lr, lr.serverUrl);
// Return true to indicate that we are logged in, pointed
// at the right URL and have our security token in place.
return true;
}
private void printUserInfo(LoginResult lr, String authEP)
{
try
{
GetUserInfoResult userInfo = lr.userInfo;
Console.WriteLine("\nLogging in ...\n");
Console.WriteLine("UserID: " + userInfo.userId);
Console.WriteLine("User Full Name: " +
userInfo.userFullName);
Console.WriteLine("User Email: " +
userInfo.userEmail);
Console.WriteLine();
Console.WriteLine("SessionID: " +
lr.sessionId);
Console.WriteLine("Auth End Point: " +
authEP);
Console.WriteLine("Service End Point: " +
lr.serverUrl);
Console.WriteLine();
}
catch (Exception e)
{
Console.WriteLine("An unexpected error has occurred: " + e.Message +
" Stack trace: " + e.StackTrace);

Introducing SOAP API

Step 4: Walk Through the Sample Code

}
}
private void logout()
{
try
{
client.logout(header);
Console.WriteLine("Logged out.");
}
catch (Exception e)
{
// Write the fault message to the console
Console.WriteLine("An unexpected error has occurred: " + e.Message);
// Write the stack trace to the console
Console.WriteLine(e.StackTrace);
}
}
/**
* To determine the objects that are available to the logged-in
* user, the sample client application executes a describeGlobal
* call, which returns all of the objects that are visible to
* the logged-in user. This call should not be made more than
* once per session, as the data returned from the call likely
* does not change frequently. The DescribeGlobalResult is
* simply echoed to the console.
*/
private void describeGlobalSample()
{
try
{
// describeGlobal() returns an array of object results that
// includes the object names that are available to the logged-in user.
DescribeGlobalResult dgr = client.describeGlobal(
header, // session header
null // package version header
);
Console.WriteLine("\nDescribe Global Results:\n");
// Loop through the array echoing the object names to the console
for (int i = 0; i < dgr.sobjects.Length; i++)
{
Console.WriteLine(dgr.sobjects[i].name);
}
}
catch (Exception e)
{
Console.WriteLine("An exception has occurred: " + e.Message +
"\nStack trace: " + e.StackTrace);
}
}

Introducing SOAP API

Step 4: Walk Through the Sample Code

/**
* The following method illustrates the type of metadata
* information that can be obtained for each object available
* to the user. The sample client application executes a
* describeSObject call on a given object and then echoes
* the returned metadata information to the console. Object
* metadata information includes permissions, field types
* and length and available values for picklist fields
* and types for referenceTo fields.
*/
private void describeSObjectsSample()
{
Console.Write("\nType the name of the object to " +
"describe (try Account): ");
string objectType = Console.ReadLine();
try
{
// Call describeSObjects() passing in an array with one object type name
DescribeSObjectResult[] dsrArray =
client.describeSObjects(
header, // session header
null, // package version header
null, // locale options
new string[] { objectType } // object name array
);
// Since we described only one sObject, we should have only
// one element in the DescribeSObjectResult array.
DescribeSObjectResult dsr = dsrArray[0];
// First, get some object properties
Console.WriteLine("\n\nObject Name: " + dsr.name);
if (dsr.custom) Console.WriteLine("Custom Object");
if (dsr.label != null) Console.WriteLine("Label: " + dsr.label);
//
if
if
if
if
if
if
if
if

Console.WriteLine("Number of fields: " + dsr.fields.Length);
// Now, retrieve metadata for each field
for (int i = 0; i < dsr.fields.Length; i++)
{

Introducing SOAP API

Step 4: Walk Through the Sample Code

// Get the field
Field field = dsr.fields[i];
// Write some field properties
Console.WriteLine("Field name: " + field.name);
Console.WriteLine("\tField Label: " + field.label);
//
//
//
if

This next property indicates that this
field is searched when using
the name search group in SOSL
(field.nameField)
Console.WriteLine("\tThis is a name field.");

Introducing SOAP API

Step 4: Walk Through the Sample Code

}
Console.WriteLine("");
}
}
catch (Exception e)
{
Console.WriteLine("An exception has occurred: " + e.Message +
"\nStack trace: " + e.StackTrace);
}
Console.WriteLine("Press ENTER to continue...");
Console.ReadLine();
}
private void querySample()
{
String soqlQuery = "SELECT FirstName, LastName FROM Contact";
try
{
QueryResult qr = client.query(
header, // session header
null, // query options
null, // mru options
null, // package version header
soqlQuery // query string
);
bool done = false;
if (qr.size > 0)
{
Console.WriteLine("Logged-in user can see "
+ qr.records.Length + " contact records.");
while (!done)
{
Console.WriteLine("");
sObject[] records = qr.records;
for (int i = 0; i < records.Length; i++)
{
Contact con = (Contact)records[i];
string fName = con.FirstName;
string lName = con.LastName;
if (fName == null)
Console.WriteLine("Contact " + (i + 1) + ": " + lName);
else
Console.WriteLine("Contact " + (i + 1) + ": " + fName
+ " " + lName);
}
if (qr.done)
{
done = true;
}
else

Introducing SOAP API

Step 4: Walk Through the Sample Code

{
qr = client.queryMore(
header, // session header
null, // query options
qr.queryLocator // query locator
);
}
}
}
else
{
Console.WriteLine("No records found.");
}
}
catch (Exception ex)
{
Console.WriteLine("\nFailed to execute query succesfully," +
"error message was: \n{0}", ex.Message);
}
Console.WriteLine("\nPress ENTER to continue...");
Console.ReadLine();
}
}
}

CHAPTER 2

Object Basics

•

Primitive Data Types

•

Field Types

•

Compound Fields

Generally speaking, API objects represent database tables that contain your organization's information.
For example, the central object in the Salesforce data model represents accounts—companies and
organizations involved with your business, such as customers, partners, and competitors. The term
“record” describes a particular occurrence of an object (such as a specific account like “IBM” or “United
Airlines” that is represented by an Account object). A record is analogous to a row in a database table.

•

API Data Types and
Salesforce Field
Types

Objects already created for you by Salesforce are called standard objects. Objects you create in your
organization are called custom objects. Objects you create that map to data stored outside your
organization are called external objects.

•

Core Data Types
Used in API Calls

•

System Fields

•

Required Fields

•

Frequently-Occurring
Fields

While this document describes all of the objects available in the API, your applications work with only
the objects that you are authorized to access. Programmatic access to objects is determined by the
objects defined in your organization, your organization configuration, your user permissions and access
settings (which are configured by your organization’s system administrator), your data sharing model,
and other factors related specifically to the object.

•

API Field Properties

•

Relationships Among
Objects

•

Relabeling Fields and
Tabs and the API

•

Tooling API Objects
in the Enterprise
WSDL

•

Force.com
AppExchange Object
Prefixes and the API

•

Custom Objects

•

External Objects

In this chapter ...

Most of the objects accessible through the API are read-write objects. However, there are a few objects
that are read-only. This fact is noted in the description for the object.

Object Basics

Primitive Data Types

Primitive Data Types
The API uses the following primitive data types:
Value

Details

base64

Base 64-encoded binary data. Fields of this type are used for storing binary files in Attachment records,
Document records, and Scontrol records. In these objects, the Body or Binary field contains the (base64
encoded) data, while the BodyLength field defines the length of the data in the Body or Binary
field. In the Document object, you can specify a URL to the document instead of storing the document
directly in the record.

boolean

Boolean fields have one of these values: true (or 1), or false (or 0).

byte

A set of bits.

date

Date data. Fields of this type contain date values, such as ActivityDate in the Event object. Unlike
dateTime fields, date fields contain no time value—the time portion of a date field is not relevant and is
always set to midnight in the Coordinated Universal Time (UTC) time zone.
If you specify a date value in a query, you can filter on date fields only.

dateTime

Date/time values (timestamps). Fields of this type handle date/time values (timestamps), such as
ActivityDateTime in the Event object or the CreatedDate, LastModifiedDate, or
SystemModstamp in many objects. Regular dateTime fields are full timestamps with a precision of one
second. They are always transferred in the Coordinated Universal Time (UTC) time zone. In your client
application, you might need to translate the timestamp to or from a local time zone.
If you specify a dateTime value in a query, you can filter on dateTime fields only.
Development tools differ in the way that they handle time data. Some development tools report the local
time, while others report only the Coordinated Universal Time (UTC) time zone. To determine how your
development tool handles time values, refer to its documentation.
Note: The Event object has a DurationInMinutes field that specifies the number of minutes
for an event. Even though this is a temporal value, it is an integer type—not a dateTime type.

double

Double values. Fields of this type can contain fractional portions (digits to the right of the decimal place),
such as ConversionRate in CurrencyType. In the API, all non-integer values (such as Currency Field
Type and Percent Field Type) contain values of type double. Some restrictions may be applied to double
values:
• scale: Maximum number of digits to the right of the decimal place.
• precision: Total number of digits, including those to the left and the right of the decimal place
The maximum number of digits to the left of the decimal place is equal to precision minus scale.
In the online application, precision is defined differently—it is the maximum number of digits allowed to
the left of the decimal place.
Values can be stored in scientific notation if the number is large enough (or, for negative numbers, small
enough), as indicated by the W3C XML Schema Part 2: Datatypes Second Edition specification.
Warning: When the user sets the precision in custom fields in the Salesforce application, it displays
the precision set by the user, even if the user enters a more precise value than defined for those

Object Basics

Value

Field Types

Details
fields. However, when you set the precision in custom fields using the API, no rounding occurs when
the user retrieves the number field.

int

Fields of this type contain numbers with no fractional portion (digits to the right of a decimal place), such
as the NumberOfEmployees in an Account. For integer fields, the digits field specifies the maximum
number of digits that an integer can have.

string

Character strings. Fields that are of data type string contain text and some have length restrictions
depending on the data being stored. For example, in the Contact object, the FirstName field is 40
characters, the LastName field is 80 characters, the MailingStreet is 255 characters.
Note: For fields that contain strings, behavior is different beginning with API version 15.0. In API
versions previous to 15.0, if you specify a value for a field, and that value is too large, the value is
truncated. For API version 15.0 and later, if a value is specified that is too large, the operation fails
and the fault code STRING_TOO_LONG is returned. AllowFieldTruncationHeader allows you to
specify that the previous behavior, truncation, be used instead of the new behavior in API versions
15.0 and later. This header has no effect in versions 14.0 and earlier. The affected fields are: anyType,
email, encryptedstring, multipicklist, phone, picklist, string, and textarea.

time

Time values. Fields of this type handle time values, such as FridayEndTime in the BusinessHours object.
Development tools differ in the way that they handle time data. Some development tools report the local
time, while others report only the Coordinated Universal Time (UTC) time zone. To determine how your
development tool handles time values, refer to its documentation.

These data types are used in the SOAP messages that are exchanged between your client application and the API. When writing your
client application, follow the data typing rules defined for your programming language and development environment. Your development
tool handles the mapping of typed data in your programming language with these SOAP data types.
The primitive data types are:
• specified in the World Wide Web Consortium’s publication XML Schema Part 2: Data Types at the following URL:
http://www.w3.org/TR/xmlschema-2/.
• enumerated in the SOAPType field of the Field type, which is described in the fields property of the DescribeSObjectResult.
Primitive types are used as a standardized way to define, send, receive, and interpret basic data types in the SOAP messages exchanged
between client applications and the API. In addition, primitive data types are interpreted in a Salesforce-specific way, which is useful for
display formatting and for numeric conversion (adding values of different currencies).
For example, Salesforce chooses to interpret a double value passed via SOAP as a double in a number of possible ways, depending
on the field definition. If the field type for that data is currency, Salesforce handles the display of the data by prepending it with a currency
symbol and inserting a decimal for precision. Similarly, if the field type is percent, Salesforce handles the display of the data by appending
a percent sign (%). Regardless of the field type, however, the value is sent in the SOAP message as a double.
The API uses data types called field types that are defined in the WSDLs. For more information, see Field Types.

Field Types
In addition to the primitive data types, the API defines the following data types for fields:

Object Basics

Field Types

Note: For fields that contain strings, behavior is different beginning with API version 15.0. In API versions previous to 15.0, if you
specify a value for a field, and that value is too large, the value is truncated. For API version 15.0 and later, if a value is specified that
is too large, the operation fails and the fault code STRING_TOO_LONG is returned. AllowFieldTruncationHeader allows you to
specify that the previous behavior, truncation, be used instead of the new behavior in API versions 15.0 and later. This header has
no effect in versions 14.0 and earlier. The affected fields are: anyType, email, encryptedstring, multipicklist, phone, picklist, string,
and textarea.
Field Type

What the Field Contains

address

A compound data type that contains address field data. See Address Compound Fields.

anyType

Polymorphic data type that returns string, picklist, reference, Boolean, currency, int, double, percent,
ID, date, datetime, url, or email data depending on the kind of field involved. See AnyType Field Type.

calculated

Fields that are defined by a formula. See Calculated Field Type.

combobox

A combobox, which includes a set of enumerated values and allows the user to specify a value not in
the list. See ComboBox Field Type.

currency

Currency values. See Currency Field Type.

DataCategoryGroupReference Reference to a data category group or a category unique name. See DataCategoryGroupReference
Field Type.
email

Email addresses. See Email Field Type.

encryptedstring

Encrypted text fields contain any combination of letters, numbers, or symbols that are stored in
encrypted form. You can set a maximum length of up to 175 characters. Available in API versions 11.0
and later.

Primary key field for the object. See ID Field Type.
Note that most Web services tools, including .NET andWSC, map the ID simple type defined in the
API WSDL (Enterprise or Partner) to a string. However, other tools generate a specific ID class to
represent the ID simple type. Please consult your Web services toolkit documentation for more
information.

JunctionIdList

A string array of referenced ID values that represent the many-to-many relationship of an underlying
junction entity. Query and manipulate the string array to query and manipulate the underlying junction
entities in a single API call. See: JunctionIdList Field Type
Warning: Adding a JunctionIdList field name to the fieldsToNull property
deletes all related junction records. This action can’t be undone.

location

A compound data type that contains latitude and longitude values for geolocation fields. See
Geolocation Compound Field.

masterrecord

When records are merged, the ID of the record that is saved (the other records are deleted).

multipicklist

Multi-select picklists, which include a set of enumerated values from which multiple values can be
selected. See Multi-Select Picklist Field Type.

percent

Percentage values. See Percent Field Type.

Object Basics

Field Types

Field Type

What the Field Contains

phone

Phone numbers. Values can include alphabetic characters. Client applications are responsible for
phone number formatting. See Phone Field Type.

picklist

Picklists, which include a set of enumerated values from which one value can be selected. See Picklist
Field Type.

reference

Cross-references to a different object. Analogous to a foreign key field in SQL. See Reference Field
Type.

textarea

String that is displayed as a multiline text field. See Textarea Field Type.

url

URL values. Client applications should commonly display these as hyperlinks. See URL Field Type.

These field types extend primitive data types. While many of these field types follow common data typing conventions that are made
explicit in their metadata, certain field types have unique characteristics that you need to understand before using them in your client
application.
These field types apply to both standard and custom fields. They are enumerated in the type field of the Field type, which is described
in the fields property of the DescribeSObjectResult.
Note: Some numeric fields have precision and scale limits. In addition, certain text fields have length restrictions. These restrictions
are enforced when you create() or update() objects. However, the API may return data that does not meet these
restrictions.

AnyType Field Type
The anyType field type is dynamic and returns string, date, number, or boolean data depending on the kind of field
involved. For example, the element in a SOAP message has an xsi:type="xsd:string" attribute if the field is of type string.
This field type is used in history objects for the NewValue and OldValue fields. It is also a valid field type for fieldType and
soapType.
Note: Most SOAP toolkits automatically deserialize this element into the correct native type.

Calculated Field Type
Calculated fields are read-only fields in the API. These are fields defined by a formula, which is an algorithm that derives its value from
other fields, expressions, or values. You can filter on these fields in SOQL, but you should not replicate these fields. The length of text
calculated fields is 3900 characters or less—anything longer will be truncated.
Calculated fields are called formula fields in the Salesforce user interface.

ComboBox Field Type
A combobox is a picklist that also allows users to type a value that is not already specified in the list. A combobox is defined as a string
value.

Currency Field Type
Currency fields contain currency values, such as the ExpectedRevenue field in a Campaign, and are defined as type double.

Object Basics

Field Types

For organizations that have the multicurrency option enabled, the CurrencyIsoCode field is defined for any object that can have
currency fields. The CurrencyIsoCode field and currency fields are linked in a special way. On any specific record, the
CurrencyIsoCode field defines the currency of that record, and thus, the values of all currency fields on that record will be expressed
in that currency.
For most cases, clients do not need to consider the linking of the CurrencyIsoCode field and the currency fields on an object.
However, clients may need to consider the following:
• The CurrencyIsoCode field exists only for those organizations that have enabled multicurrency support.
• When displaying the currency values in a user interface, it is preferred to prepend each currency value with its CurrencyIsoCode
value and a space separator.
• The CurrencyIsoCode field is a restricted picklist field. The set of allowable values, defined in the CurrencyType object, can
vary from organization to organization. Attempting to set it to a value that is not defined for an organization causes the operation
to be rejected.
• If you update the CurrencyIsoCode field on an object, it implicitly converts all currency values on that object to the new
currency code, using the conversion rates that are defined for that organization in the Salesforce user interface. If you specify currency
values in that same update() call, the new currency values you specify are interpreted in the new CurrencyIsoCode field
value, without conversion.
• The picklist values in a CurrencyIsoCode field do not exactly match the labels displayed in Salesforce.
To perform currency conversions, client applications can look up the CurrencyIsoCode in the CurrencyType object.

DataCategoryGroupReference Field Type
A data category group has categories that classify articles in Salesforce Knowledge and questions in the Answers feature. Every article
and question object has two fields of type DataCategoryGroupReference which contain the category group and category unique name.
You can use the describeDataCategoryGroups() and describeDataCategoryGroupStructures() calls to
retrieve the category groups and categories associated to these objects.

Email Field Type
Email fields contain email addresses. Client applications are responsible for specifying valid and properly formatted email addresses in
create() and update() calls.

ID Field Type
With rare exceptions, all objects in the API have a field of type ID that is named Id and contains a unique identifier for each record in
the object. It is analogous to a primary key in relational databases. When you create() a new record, the Web service generates an
ID value for the record, ensuring that it is unique within your organization’s data. You cannot use the update() call on ID fields.
Because the ID value stays constant over the lifetime of the record, you can refer to the record by its ID value in subsequent API calls.
Also, the ID value contains a three-character code that identifies the object type, which client applications can retrieve via the
describeSObjects() call.
In addition, certain objects, including custom objects, have one or more fields of type reference that contain the ID value for a
related record. These fields have names that end in the suffix “-Id”, for example, OwnerId in the account object. OwnerId contains
the ID of the user who owns that object. Unlike the field named Id, reference fields are analogous to foreign keys and can be
changed via the update() call. For more information, see Reference Field Type.

Object Basics

Field Types

Some API calls, such as retrieve() and delete(), accept an array of IDs as parameters—each array element uniquely identifies
the row to retrieve or delete. Similarly, the update() call accepts an array of sObject records—each sObject contains an Id field
that uniquely identifies the sObject.
ID fields in the Salesforce user interface contain 15-character, base-62, case-sensitive strings. Each of the 15 characters can be a numeric
digit (0-9), a lowercase letter (a-z), or an uppercase letter (A-Z). Two unique IDs may only be different by a change in case.
Because there are applications like Access which do not recognize that 50130000000014c is a different ID from 50130000000014C, an
18-digit, case-safe version of the ID is returned by all API calls. The 18 character IDs have been formed by adding a suffix to each ID in
the Force.com API. 18-character IDs can be safely compared for uniqueness by case-insensitive applications, and can be used in all API
calls when creating, editing, or deleting data.
If you need to convert the 18-character ID to a 15-character version, truncate the last three characters. Salesforce recommends that you
use the 18-character ID.
Note: Most Web services tools, including .NET and WSC, map the ID simple type defined in the API WSDL (Enterprise or Partner)
to a string. However, other tools generate a specific ID class to represent the ID simple type. Please consult your web services
toolkit documentation for more information.

JunctionIdList Field Type
Starting in API version 34.0, the JunctionIdList field type lets you manipulate the many-to-many relationship of an entity directly.
You no longer need to manipulate underlying junction entity records. JunctionIdList fields can be queried and updated like any
other field on the entity. Queries or updates to JunctionIdList fields act as queries or updates to the underlying junction entity
records. Fields of type JunctionIdList appear in the WSDL as an unbounded array of type ID.
Query JunctionIdList fields just like any other field. Here’s an example of a SOQL query that includes the TaskWhoIds JunctionIdList
field.
SELECT Id, Subject, TaskWhoIds
FROM Task
WHERE LastModifiedDate > LAST_WEEK

Multi-Select Picklist Field Type
Multi-select picklist fields contain a list of one or more items from which a user can choose multiple items. One of the items can be
configured as the default item. Selections are maintained as a string containing a series of attributes delimited by semicolons. For example,
a query might return the values of a multivalue picklist as “first value; second value; third value”. For information on querying multi-select
picklists, see Querying Multi-Select Picklists in the Salesforce SOQL and SOSL Reference Guide.

Percent Field Type
Percent fields contain percent values. Percent fields are defined as type double.

Phone Field Type
Phone fields contain phone numbers, which can include alphabetic characters. Client applications are responsible for phone number
formatting.

Object Basics

Field Types

Picklist Field Type
Picklist fields contain a list of one or more items from which a user chooses a single item. They display as drop-down lists in the Salesforce
user interface. One of the items can be configured as the default item.
In the Field object associated with the DescribeSObjectResult, the restrictedPicklist field defines whether the field is a
restricted picklist or not. The API does not enforce the list of values for advisory (unrestricted) picklist fields on create() or update().
When inserting an unrestricted picklist field that does not have a PicklistEntry, the system creates an “inactive” picklist value. This value
can be promoted to an “active” picklist value by adding the picklist value in the Salesforce user interface.
When creating new, inactive picklists, the API checks to see if there is a match. This check is case-insensitive.
In theField object associated with the DescribeSObjectResult, the picklistValues field contains an array of items (PicklistEntry
objects). Each PicklistEntry defines the item’s label, value, and whether it is the default item in the picklist (a picklist has no more than
one default value).
Enumerated fields support localization of the labels to the language of the user. For example, for the Industry field on an Account,
the value “Agriculture” may be translated to various languages. The enumerated field values are fixed and do not change with a user’s
language. However, each value may have a specified “label” field that provides the localized label for that value. You must always use
the value when inserting or updating a field. The query() call always returns the value, not the label. The corresponding label for a
value in the describeSObjectResult should be used when displaying the value to the user in any user interface.
The API supports the retrieval of the certain picklists in the following objects: CaseStatus, ContractStatus, LeadStatus, OpportunityStage,
PartnerRole, SolutionStatus, TaskPriority, and TaskStatus. Each object represents a value in the respective picklist. These picklist entries
always specify some other piece of information, such as whether the status is converted, and so on. Your client application can invoke
the query() call on any of these objects (such as CaseStatus) to retrieve the set of values in the picklist, and then use that information
while processing other objects (such as Case objects) to find more information about those objects (such as a given case). These objects
are read-only via the API. To modify items in picklists, you must use the Salesforce user interface.

Reference Field Type
A reference field contains an Id value that points to a unique record (usually the parent record) on another object. This is analogous
to the concept of a foreign key in relational databases. The name of a reference field ends, by convention, with the letters Id (such as
CaseId or OpportunityId). For example, in the OpportunityCompetitor object, the OpportunityId field is a reference field
that points to the Opportunity object. It contains an ID value that uniquely identifies an Opportunity record.
In some cases, an object can refer to another object of its same type. For example, an Account can have a parent link that points to
another Account.
The Event and Task objects both have WhoId and WhatId cross-reference ID fields. Each of these cross-reference fields can point to
one of several other objects. The WhoId field can point to a Contact or Lead, and the WhatId field can point to an Account, Opportunity,
Campaign, or Case. In addition, if the WhoId field refers to a Lead, then the WhatId field must be empty.
You can describe and query each cross-referenced object. When you query a cross-reference ID field, it returns an object ID of the
appropriate type. You can then query that ID to get additional information about the object, using the ID in the id field for that query.
The cross-reference ID field value is either:
• a valid record in your organization, or
• an empty value, which indicates an empty reference
The cross-reference ID field value, if non-null, is guaranteed to be an object in your organization. However, it is not guaranteed that
you can query that object. Users with the “View All Data” permission can always query that object. Other users may be restricted from
viewing or editing the referenced object.
When specifying a value for a cross-reference ID field in a create() or update() call, the value must be a valid value of type ID,
and the user must have appropriate access to that object. The exact requirements vary from field to field.

Object Basics

Compound Fields

Textarea Field Type
Textarea fields contain text that can be longer than 4000 bytes. Unlike string fields, textarea fields cannot be specified in the WHERE
clause of a queryString of a query() call. To filter records on this field, you must do so while processing records in the QueryResult.
For fields with this restriction, its filterable field in the Field type (described in the fields property of the DescribeSObjectResult)
is false.

URL Field Type
URL fields contain URLs. Client applications are responsible for specifying valid and properly formatted URLs in create() and
update() calls.

Compound Fields
Compound fields group together multiple elements of primitive data types, such as numbers or strings, to represent complex data types,
such as a location or an address. Compound fields are an abstraction that can simplify application code that handles the values, leading
to more concise, understandable code.
Address compound fields are available in the SOAP and REST APIs in API version 30.0 and later. Geolocation fields are available in the
SOAP and REST APIs in API version 26.0 and later, with some limitations on SOAP for API versions below 30.0.
Compound fields are accessible as a single, structured field, or as individual component fields. The values contained within the compound
field and the values in individual fields both map to the same underlying data stored in Salesforce; they always have identical values.
Code that references individual component fields is unaffected by the new compound fields.
Compound fields are read-only. Changes are performed by writing to the individual component fields. This maintains a single, consistent
method for performing updates, and avoids the possibility of conflicts. For example, if both the BillingAddress compound field
and BillingCity individual component field were updated in the same API call, it would be unclear which value should be saved.
Compound fields are available only through the SOAP and REST APIs. Compound fields are described in both the Enterprise and Partner
WSDLs. Update your WSDL to at least API 30.0 to access the new compound data types.

Address Compound Fields
Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP and REST APIs as an Address,
a structured compound data type, as well as individual address elements.
Using API 30.0 and later, standard addresses are available in the SOAP and REST APIs as a compound field of type Address, a structured
data type that combines the following fields.
• Accuracy
• City
• Country
• CountryCode
• Latitude
• Longitude
• PostalCode
• State
• StateCode

Object Basics

Address Compound Fields

• Street
Note: StateCode and CountryCode are always available on compound address fields, whether or not state and country
picklists are enabled in your organization.
The Address type extends the Location type, the data type used for compound geolocation fields.
Address fields are provided on many standard objects, such as Account, Contact, Quote, and User. Some objects provide fields for multiple
addresses. For example, Account provides for four different addresses. In this case, address field names are prefixed with the type of
address, for example, BillingCity, BillingState, and so on.
Note: Standard address compound fields are read-only, and are only accessible using the SOAP and REST APIs. See Compound
Field Considerations and Limitations on page 42 for additional details of the restrictions this imposes.
When an address is geocoded, its latitude and longitude fields are populated with coordinates. A related geolocation field is also
populated. Typically, geocoding service providers geocode addresses, and rate the accuracy of the geocodes.
The accuracy subfield GeocodeAccuracy stores the accuracy data for a geocoded location. External geolocation apps can get the
accuracy level of a geocoded address via the API. When you retrieve an address via the API, any accuracy data is included. You can also
retrieve the accuracy information by itself, if needed.
Like its parent, the compound Address field, the GeocodeAccuracy field is only available for standard address fields on standard
objects.

Retrieving Compound Address Fields
Using compound fields can simplify code that works with addresses, especially for SOQL queries. SOQL SELECT clauses can reference
addresses directly, instead of all of the individual component fields.
SELECT Name, BillingAddress
FROM Account

To write code that’s compatible with API versions before 30.0, as well as API 30.0 and above, use the individual fields:
SELECT Name, BillingStreet, BillingCity, BillingState, BillingPostalCode,
BillingCountry, BillingLatitude, BillingLongitude
FROM Account

Compound address field values are returned as a structured data type, Address. Code that works with compound address fields needs
to reference the individual components of the returned value. See the code sample below.
Example: Retrieve a Standard Address Compound Field with the SOAP API
The following Java method uses the Salesforce SOAP API to retrieve and display the Mailing Address for a list of contacts.
// Modified version of code in the SOAP API QuickStart
private void querySample() {
String soqlQuery = "SELECT FirstName, LastName, MailingAddress FROM Contact";
try {
QueryResult qr = connection.query(soqlQuery);
boolean done = false;
if (qr.getSize() > 0) {
System.out.println("\nLogged-in user can see "
+ qr.getRecords().length + " contact records.");
while (!done) {
System.out.println("");

Object Basics

Address Compound Fields

SObject[] records = qr.getRecords();
for (int i = 0; i < records.length; ++i) {
Contact con = (Contact) records[i];
String fName = con.getFirstName();
String lName = con.getLastName();
// Access the compound address field MailingAddress
Address addr = (Address) con.getMailingAddress();
String streetAddr = "";
if (null != addr) streetAddr = addr.getStreet();
if (fName == null) {
System.out.println("Contact " + (i + 1) + ": " + lName +
" -- " + streetAddr);
} else {
System.out.println("Contact " + (i + 1) + ": " + fName +
" " + lName +
" -- " + streetAddr);
}
}
if (qr.isDone()) {
done = true;
} else {
qr = connection.queryMore(qr.getQueryLocator());
}
}
} else {
System.out.println("No records found.");
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}

Using Compound Address Fields as Locations
Compound address fields include latitude and longitude fields. Address fields can be used as locations in SOQL WHERE and ORDER
BY clauses. For example, here’s a SOQL query that uses the GEOLOCATION function to retrieve the 10 accounts closest to San
Francisco.
SELECT Id, Name, BillingAddress
FROM Account
WHERE DISTANCE(BillingAddress, GEOLOCATION(37.775,-122.418), 'mi') < 20
ORDER BY DISTANCE(BillingAddress, GEOLOCATION(37.775,-122.418), 'mi')
LIMIT 10

Note: In Developer, Professional, Enterprise, Unlimited, and Performance editions, Salesforce can automatically add or update
geolocation fields for Account, Contact, Lead, and WorkOrder records. To use this feature, your administrator must enable the geo
clean rule for each object. For all other objects and editions, set values for latitude and longitude by using SOQL, Workbench, SOAP
or REST API, or a geocoding service. You can then use address fields as locatable values. To find geocoding services, search the
AppExchange.

Object Basics

Geolocation Compound Field

Geolocation Compound Field
Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual
latitude and longitude elements.
In API versions 26.0 and later, geolocation fields are available in the SOAP and REST APIs as a compound field of type Location. This
structured data type contains the following fields.
• latitude
• longitude
Note: SOAP calls that use API versions earlier than 30.0 return geolocation compound values as strings. See “Returned Geolocation
Data Types” later in this topic.
Geolocation fields are provided on many standard objects, such as Account, Contact, Quote, and User, as part of their address field or
fields. Geolocation fields can also be added as custom fields to standard or custom objects.
Note:
• A geolocation compound field is read-only, although its latitude and longitude subfields are editable. You can only
access compound fields using the SOAP or REST API. For more information about working with compound fields and their
subfields, see Compound Field Considerations and Limitations on page 42.
• Although geolocation fields appear as a single field in the user interface, custom geolocation fields count as three custom fields
towards your organization’s limits: one for latitude, one for longitude, and one for internal use.

Retrieving Compound Geolocation Fields
Using compound fields can simplify code that works with geolocations, especially for SOQL queries. SOQL SELECT clauses can reference
geolocations directly, instead of the individual component fields.
SELECT location__c
FROM Warehouse__c

To write code that’s compatible with API versions earlier than 26.0 and with API versions 26.0 and later, use the individual latitude and
longitude fields.
SELECT location__latitude__s, location__longitude__s
FROM Warehouse__c

Returned Geolocation Data Types
A compound geolocation field value is returned as the structured data type Location. Code that works with compound geolocation
fields must reference the individual components of the returned value. See the sample code in Address Compound Fields on page 39.
In API versions earlier than 30.0, SOAP calls return compound geolocation field values as strings, instead of as a structured data type, for
backward compatibility. If you plan to display your latitude and longitude values or pass them to a service that expects strings, use the
values that are returned. If you plan to use the values in mathematical calculations or pass them to a map service that expects numbers,
cast the results to numbers.
The string value format is:
API location: [latitudeValue longitudeValue]

Object Basics

Compound Field Considerations and Limitations

An example of a regular expression to parse out the latitude and longitude values is:
API location: \[([-+]?\d{1,2}([.]\d+)?) ([-+]?\d{1,3}([.]\d+)?)]

The first capture is the latitude, and the third is the longitude.

Compound Field Considerations and Limitations
Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when
using them in your apps.
Both address and geolocation compound fields have the following limitations.
• Compound fields are read-only. To update field values, modify the individual field components.
• Compound fields are accessible only through the SOAP and REST APIs. The compound versions of fields aren’t accessible anywhere
in the Salesforce user interface.
• Although compound fields can be queried with the Location and Address Apex classes, they’re editable only as components
of the actual field. Read and set geolocation field components by appending “__latitude__s” or “__longitude__s” to the field name,
instead of the usual “__c.” For example:
Double theLatitude = myObject__c.aLocation__latitude__s;
myObject__c.aLocation__longitude__s = theLongitude;

You can’t access or set the compound value.
• You can’t use compound fields in Visualforce—for example, in an . To access or update field values, use
the individual field components.
• If you select compound fields for export in the Data Loader, they cause error messages. To export values, use individual field
components.
• Custom geolocation and location fields on standard addresses aren’t supported with email templates.
• You can’t use compound fields in lookup filters, except to filter distances that are within or not within given ranges. You can use
distance lookup filters only in the Metadata API.
• The only formula functions that you can use with compound fields are ISBLANK, ISCHANGED, and ISNULL. You can’t use
BLANKVALUE, CASE, NULLVALUE, PRIORVALUE, or the equality and comparison operators with compound fields. The
equality and comparison operators include = and == (equal), <> and != (not equal), < (less than), > (greater than), <= (less
than or equal), >= (greater than or equal), && (AND), and || (OR).
Address compound fields have the following limitations.
• Compound address fields are available only for address fields that exist as part of the standard objects included in Salesforce. You
can’t create custom compound address fields.
• In Developer, Professional, Enterprise, Unlimited, and Performance editions, Salesforce can automatically add or update geolocation
fields for Account, Contact, Lead, and WorkOrder records. To use this feature, your administrator must enable the geo clean rule for
each object. For all other objects and editions, set values for latitude and longitude by using SOQL, Workbench, SOAP or REST API,
or a geocoding service. You can then use address fields as locatable values. To find geocoding services, search the AppExchange.
• The accuracy subfield of address fields is populated only when an address is geocoded. Typically, geocoding service providers provide
accuracy data for an address’s latitude and longitude coordinates.
• Address fields can’t be used in WHERE statements in SOQL. Address fields aren’t filterable, but the isFilterable() method
of the DescribeFieldResult Apex class erroneously returns true for address fields.
Geolocation compound fields have the following limitations.
• Geolocation fields aren’t supported in custom settings.

Object Basics

API Data Types and Salesforce Field Types

• Geolocation fields aren’t available in dashboards or Schema Builder.
• Geolocation fields are available in Visual Workflow and in formula-based workflow and approvals, but they can’t be used in filter-based
workflow updates and approvals.
• DISTANCE formulas are supported in:
– Entry criteria for workflow rules and approval processes
– Field update actions in workflow rules and approval processes
– Custom validation rules
– Lookup filters (in the Metadata API only)
• Geolocation fields and latitude and longitude on standard addresses aren’t supported in Salesforce to Salesforce.
• In Developer, Professional, Enterprise, Unlimited, and Performance editions, Salesforce can automatically add or update geolocation
fields for Account, Contact, Lead, and WorkOrder records. To use this feature, your administrator must enable the geo clean rule for
each object. For all other objects and editions, set values for latitude and longitude by using SOQL, Workbench, SOAP or REST API,
or a geocoding service. You can then use address fields as locatable values. To find geocoding services, search the AppExchange.
• Geolocation fields are supported in SOQL with the following limitations.
– DISTANCE and GEOLOCATION are supported in WHERE and ORDER BY clauses in SOQL, but not in GROUP BY.
DISTANCE is supported in SELECT clauses.
– DISTANCE supports only the logical operators > and <, returning values within (<) or beyond (>) a specified radius.
– When using the GEOLOCATION function in SOQL queries, the geolocation field must precede the latitude and longitude
coordinates. For example, DISTANCE(warehouse_location__c, GEOLOCATION(37.775,-122.418),
'km') works but DISTANCE(GEOLOCATION(37.775,-122.418), warehouse_location__c, 'km')
doesn’t work.
– Apex bind variables aren’t supported for the units parameter in DISTANCE or GEOLOCATION functions. This query doesn’t
work.
String units = 'mi';
List accountList =
[SELECT ID, Name, BillingLatitude, BillingLongitude
FROM Account
WHERE DISTANCE(My_Location_Field__c, GEOLOCATION(10,10), :units) < 10];

For more information and examples, see the Force.com SOQL and SOSL Reference.

API Data Types and Salesforce Field Types
Generally, API data types and field types in the user interface have the same names. For example, a date field is represented by a date
data type in the API. However, some field types are represented differently depending on whether you are inspecting an object via the
API or the user interface. The following table contains the mapping for field types and data types that are different:
API Data Type

Corresponding Field Types in the User Interface

Lookup relationship, master-detail relationship

string

Auto number, email, phone, picklist, multi-select picklist, text, text area, long text area, rich text area, data
category group reference and URL. Different maximum lengths are specified in the WSDL for text, text area,
and long text area.

boolean

Checkbox

Object Basics

Core Data Types Used in API Calls

API Data Type

Corresponding Field Types in the User Interface

double

Currency, formula, number, percent, and roll-up summary

Varies by type

When formula fields are created in the user interface, a type must be specified. This type corresponds to
the API data type of the same name: currency, date, date/time, number, percent, or text.

All other fields that you can create in the user interface fall into one of the following categories:
• The field is not available in both the user interface and the API. For example, the BusinessHours object has fields of API data type
time, but you cannot create a custom field of this type.
• Field types are the same as their corresponding API data type. For example, if you create a date field in the user interface, that field
is the date data type in the API.
For more information about API data types, see Primitive Data Types and Field Types.

Core Data Types Used in API Calls
Many calls in the API use the following data types:
• sObject
• ID (String). See ID Field Type.
The API also uses several error handling objects. If an error occurs during a SOAP request, the API returns a SOAP fault message. The
message contains different content, depending on the type of error:
• If an error affects the entire request, an API Fault Element, is returned, containing an ExceptionCode and the associated error message
text.
• If the error affects some records and not others, an Error is returned, containing a StatusCode. These errors typically occur during
bulk operations, such as creating, updating, or deleting multiple records with a single call.

sObject
An sObject represents an object, such as an Account or Campaign. For a list of standard objects, see Standard Objects.
An sObject has the following properties:
Name

Type

Description

fieldsToNull string[] Array of one or more field names whose value you want to explicitly set to null.

When used with update() or upsert(), you can specify only those fields that you can update and that
have the nillable property. When used with create(), you can specify only those fields that you
can create and that have the nillable or the default on create property.
For example, if specifying an ID field or required field results in a runtime error, you can specify that field
name in fieldsToNull. Similarly, if a picklist field has a default value and you want to set the value to
null instead, specify the field in fieldsToNull.
ID

Unique ID for this individual object. For the create() call, this value is null. For all other API calls, this value
must be specified.

Object Basics

API Fault Element

API Fault Element
An ApiFault element contains information about a fault that occurs when processing a service request. The ApiFault element
has the following properties.
Name

Type

Description

exceptionCode

ExceptionCode

A code that characterizes the exception. The full list of exception codes is available
in the WSDL file for your org. See Generating the WSDL File for Your Organization.

exceptionMessage string

Exception message text.

extendedErrorDetails ExtendedErrorDetails

More details about the exception, including an extended error code and extra
error properties, when available. Reserved for future use.

The following table lists the API fault elements that represent all the API faults that can occur.
Fault

Description

ApiQueryFault

The row and column numbers where the problem occurred.

LoginFault

An error occurred during the login() call.

InvalidSObjectFault

An invalid sObject in a describeSObject(), describeSObjects(),
describeLayout(), describeDataCategoryGroups(),
describeDataCategoryGroupStructures(), create(), update(),
retrieve(), or query() call.

InvalidFieldFault

An invalid field in a retrieve() or query() call.

InvalidOrNullForRestrictedPicklist An invalid appMenuType in a describeAppMenu() call.
MalformedQueryFault

A problem in the queryString passed in a query() call.

InvalidQueryLocatorFault A problem in the queryLocator passed in a queryMore() call.
MalformedSearchFault

A problem in the search passed in a search() call.

InvalidIdFault

A specified ID was invalid in a setPassword() or resetPassword() call.

UnexpectedErrorFault

An unexpected error occurred. The error is not associated with any other API fault.

ExceptionCode
The following list of ExceptionCode values is defined in your WSDL file. Some codes don’t appear in your WSDL, depending on
the features you have enabled.
API_CURRENTLY_DISABLED

Because of a system problem, API functionality is temporarily unavailable.
API_DISABLED_FOR_ORG

API access has not been enabled for the org. Contact Salesforce to enable API access.
CANT_ADD_STANDARD_PORTAL_USER_TO_TERRITORY

A user with a standard portal license can't be added to a territory.

Object Basics

ExceptionCode

CIRCULAR_OBJECT_GRAPH

The request failed because it contained a circular object reference.
CLIENT_NOT_ACCESSIBLE_FOR_USER

The current user does not have permission to access the specified client.
CLIENT_REQUIRE_UPDATE_FOR_USER

The current user is required to use a newer version of the specified client and doesn’t have access until the client is updated.
DELETE_REQUIRED_ON_CASCADE

The delete operation triggers a cascade delete on a record, but the logged-in user does not have delete permission on that related
object.
DUPLICATE_COMM_NICKNAME

You can't create a user with the same nickname as another user.
DUPLICATE_VALUE

You can’t supply a duplicate value for a field that must be unique. For example, you can’t submit two copies of the same session ID
in a invalidateSessions() call.
EMAIL_BATCH_SIZE_LIMIT_EXCEEDED

A method tried to process more email records than the maximum batch size.
EMAIL_TO_CASE_INVALID_ROUTING

An email to case record has been submitted for processing but the feature is not enabled.
EMAIL_TO_CASE_LIMIT_EXCEEDED

The daily converted email limit for the Email-to-Case feature has been exceeded.
EMAIL_TO_CASE_NOT_ENABLED

The Email-to-Case feature has not been enabled.
EXCEEDED_ID_LIMIT

Too many IDs were specified in a call. For example, more than 2000 IDs were requested in a retrieve() call, or more than 200
session IDs were specified in a logout() call.
EXCEEDED_LEAD_CONVERT_LIMIT
Too many IDs were sent to a convertLead() call.
EXCEEDED_MAX_SIZE_REQUEST

The size of the message sent to the API exceeded 50 MB.
EXCEEDED_MAX_TYPES_LIMIT

The number of object types to describe is too large.
EXCEEDED_QUOTA

The size limit for org data storage was exceeded during a create() call.
FUNCTIONALITY_NOT_ENABLED

Functionality has been temporarily disabled. Other calls continue to work.
INACTIVE_OWNER_OR_USER

The user or record owner is not active.
INACTIVE_PORTAL

The referenced portal is inactive.
INSUFFICIENT_ACCESS

The user does not have sufficient access to perform the operation.

Object Basics

ExceptionCode

INVALID_ASSIGNMENT_RULE

An invalid AssignmentRuleHeader value was specified.
INVALID_BATCH_SIZE

The query options have an invalid batch size value.
INVALID_CLIENT

The client is invalid.
INVALID_CROSS_REFERENCE_KEY

An invalid foreign key can’t be set on a field. For example, an object share, such as AccountShare, can’t be deleted because the share
row is a result of a sharing rule.
INVALID_FIELD

The specified field name is invalid.
INVALID_FILTER_LANGUAGE

The specified language can't be used as a filter.
INVALID_FILTER_VALUE
A SOQL query with LIKE specified an invalid character, for example, an incorrectly placed asterisk (*). Correct the query and resubmit.
INVALID_ID_FIELD

The specified ID is correctly formatted but isn’t valid. For example, the ID is of the wrong type, or the object it identifies no longer
exists.
INVALID_GOOGLE_DOCS_URL

An invalid Salesforce record URL was used when trying to associate a Google Doc to that record. Correct the URL before trying the
operation again.
INVALID_LOCATOR

The locator is invalid.
INVALID_LOGIN
The login() credentials are not valid, or the maximum number of logins have been exceeded. Contact your administrator for

more information.
INVALID_NEW_PASSWORD

The new password does not conform with the password policies of the org.
INVALID_OPERATION

The client application tried to modify a record that is locked by an approval process.
INVALID_OPERATION_WITH_EXPIRED_PASSWORD

Due to password expiration, a valid password must be set using setPassword() before the call can be invoked.
INVALID_QUERY_FILTER_OPERATOR
An invalid operator was used in the query() filter clause, at least for that field.
INVALID_QUERY_LOCATOR
An invalid queryLocator parameter was specified in a queryMore() call. It’s also possible that you've exceed the maximum

number of calls, which is 10 per user for the API, and 5 for Apex and Visualforce.
INVALID_QUERY_SCOPE

The specified search scope is invalid.
INVALID_REPLICATION_DATE

The date for replication is out of the allowed range, such as before the org was created.

Object Basics

ExceptionCode

INVALID_SETUP_OWNER

The setup owner must be an Organization, Profile, or User.
INVALID_SEARCH
The search() call has invalid syntax or grammar. For more information, see the Salesforce SOQL and SOSL Reference Guide.
INVALID_SEARCH_SCOPE

The specified search scope is invalid.
INVALID_SESSION_ID
The specified sessionId is malformed (incorrect length or format) or has expired. Log in again to start a new session.
INVALID_SOAP_HEADER

There is an error in the SOAP header. If you are migrating from an earlier version of the API, be advised that the SaveOptions header
can't be used with API version 6.0 or later. Use AssignmentRuleHeader instead.
INVALID_SSO_GATEWAY_URL

The URL provided to configure the Single Sign-On gateway was not a valid URL.
INVALID_TYPE

The specified sObject type is invalid.
INVALID_TYPE_FOR_OPERATION

The specified sObject type is invalid for the specified operation.
LIMIT_EXCEEDED

An array is too long. For example, there are too many BCC addresses, targets, or email messages.
LOGIN_DURING_RESTRICTED_DOMAIN

The user is not allowed to log in from this IP address.
LOGIN_DURING_RESTRICTED_TIME

The user is not allowed to log in during this time period.
MALFORMED_ID

An invalid ID string was specified. For information about IDs, see ID Field Type.
MALFORMED_QUERY

An invalid query string was specified. For example, the query string was longer than 20,000 characters.
MALFORMED_SEARCH

An invalid search string was specified. For example, the search string was longer than 20,000 characters.
MISSING_ARGUMENT

A required argument is missing.
MIXED_DML_OPERATION

There are limits on what kinds of DML operations can be performed in the same transaction. For more information, see the Force.com
Apex Code Developer's Guide.
NOT_MODIFIED

The describe call response has not changed since the specified date.
NO_SOFTPHONE_LAYOUT

If an org has the CTI feature enabled, but no softphone layout has been defined, this exception is returned if a describe call is issued.
This exception is most often caused because no call center has been defined. A default softphone layout is created during call center
definition.
If an org doesn’t have the CTI feature enabled, FUNCTIONALITY_NOT_ENABLED is returned instead.

Object Basics

ExceptionCode

NUMBER_OUTSIDE_VALID_RANGE

The number specified is outside the valid range for the field.
OPERATION_TOO_LARGE

The query has returned too many results. If certain queries are run by a user without the “View All Data” permission and many records
are returned, the queries require sharing rule checking. For example, consider queries that are run on objects, such as Task, that use
a polymorphic foreign key. These queries return this exception because the operation requires too many resources. To correct, add
filters to the query to narrow the scope, or use filters such as date ranges to break the query up into a series of smaller queries.
ORG_LOCKED

The org has been locked. Contact Salesforce to unlock the org.
ORG_NOT_OWNED_BY_INSTANCE

The user tried to log in to the wrong server instance. Choose another server instance or log in at
https://login.salesforce.com. You can use http instead of https.
PASSWORD_LOCKOUT

The user has exceeded the allowed number of login attempts. The user must contact an administrator to regain login access.
PORTAL_NO_ACCESS

Access to the specified portal is not available.
QUERY_TIMEOUT

The query has timed out. For more information, see the Salesforce SOQL and SOSL Reference Guide.
QUERY_TOO_COMPLICATED

SOQL query is either selecting too many fields or there are too many filter conditions. Try reducing the number of formula fields
referenced in the query.
REQUEST_LIMIT_EXCEEDED

Exceeded either the concurrent request limit or the request rate limit for your org. For details on API request limits, see API Usage
Metering.
REQUEST_RUNNING_TOO_LONG

A request has taken too long to be processed.
SERVER_UNAVAILABLE

A server that is necessary for this call is unavailable. Other types of requests could still work.
SSO_SERVICE_DOWN

The service was unavailable, and an authentication call to the org’s specified Single Sign-On server failed.
TOO_MANY_APEX_REQUESTS

Too many Apex requests have been issued. If this exception persists, contact Salesforce Customer Support.
TRIAL_EXPIRED

The trial period for the org has expired. A representative from the company must contact Salesforce to re-enable the org.
UNSUPPORTED_API_VERSION

A method call was made that doesn’t exist in the accessed API version, for example, trying to use upsert() (new in 8.0) against
version 5.0.
UNSUPPORTED_CLIENT

This version of the client is no longer supported.

Object Basics

Error

Error
An Error contains information about an error that occurred during a create(), merge(), process(), update(), upsert(),
delete(), or undelete() call. For more information, see Error Handling. An Error has the following properties:
Name

Type

Description

statusCode

StatusCode

A code that characterizes the error. The full list of status codes is available in the
WSDL file for your org (see Generating the WSDL File for Your Organization).

message

string

Error message text.

fields

string[]

Array of one or more field names. Identifies which fields in the object, if any,
affected the error condition.

extendedErrorDetails ExtendedErrorDetails

More details about the error, including an extended error code and extra error
properties, when available. Reserved for future use.

Note: If your org has active duplicate rules and a duplicate is detected, the SaveResult includes an error with a data type of
DuplicateError.

StatusCode
The following table lists API status codes that are returned with an error. Some codes don’t appear in your WSDL, depending on the
features you have enabled.
ALL_OR_NONE_OPERATION_ROLLED_BACK

The bulk operation was rolled back because one of the records wasn't processed successfully. See AllOrNoneHeader.
ALREADY_IN_PROCESS

You can’t submit a record that is already in an approval process. Wait for the previous approval process to complete before resubmitting
a request with this record.
ASSIGNEE_TYPE_REQUIRED

Designate an assignee for the approval request (ProcessInstanceStep or ProcessInstanceWorkitem).
BAD_CUSTOM_ENTITY_PARENT_DOMAIN

The changes you are trying to make can’t be completed because changes to the associated master-detail relationship can’t be made.
BCC_NOT_ALLOWED_IF_BCC_COMPLIANCE_ENABLED

Your client application blind carbon-copied an email address even though the org’s Compliance BCC Email option is enabled. This
option specifies a particular email address that automatically receives a copy of all outgoing email. When this option is enabled, you
can’t BCC any other email address. To disable the option, log in to the user interface and from Setup, enter Compliance BCC
Email in the Quick Find box, then select Compliance BCC Email.
BCC_SELF_NOT_ALLOWED_IF_BCC_COMPLIANCE_ENABLED

Your client application blind carbon-copied the logged-in user’s email address even though the org’s BCC COMPLIANCE option is
set to true. This option specifies a particular email address that automatically receives a copy of all outgoing email. When this option
is enabled, you can’t BCC any other email address. To disable the option, log in to the user interface and from Setup, enter
Compliance BCC Email in the Quick Find box, then select Compliance BCC Email.
CANNOT_CASCADE_PRODUCT_ACTIVE

An update to a product caused by a cascade can't be done because the associated product is active.

Object Basics

StatusCode

CANNOT_CHANGE_FIELD_TYPE_OF_APEX_REFERENCED_FIELD

You can't change the type of a field that is referenced in an Apex script.
CANNOT_CREATE_ANOTHER_MANAGED_PACKAGE

You can create only one managed package in an org.
CANNOT_DEACTIVATE_DIVISION

You can't deactivate Divisions if an assignment rule references divisions or if the DefaultDivision field on a user record isn’t
set to null.
CANNOT_DELETE_LAST_DATED_CONVERSION_RATE

If dated conversions are enabled, you must have at least one DatedConversionRate record.
CANNOT_DELETE_MANAGED_OBJECT

You can't modify components that are included in a managed package.
CANNOT_DISABLE_LAST_ADMIN

You must have at least one active administrator user.
CANNOT_ENABLE_IP_RESTRICT_REQUESTS

If you exceed the limit of five IP ranges specified in a profile, you can't enable restriction of login by IP addresses. Reduce the number
of specified ranges in the profile and try the request again.
CANNOT_INSERT_UPDATE_ACTIVATE_ENTITY

You do not have permission to create, update, or activate the specified record.
CANNOT_MODIFY_MANAGED_OBJECT

You can't modify components that are included in a managed package.
CANNOT_RENAME_APEX_REFERENCED_FIELD

You can't rename a field that is referenced in an Apex script.
CANNOT_RENAME_APEX_REFERENCED_OBJECT

You can't rename an object that is referenced in an Apex script.
CANNOT_REPARENT_RECORD

You can't define a new parent record for the specified record.
CANNOT_RESOLVE_NAME
A sendEmail() call could not resolve an object name.
CANNOT_UPDATE_CONVERTED_LEAD

A converted lead could not be updated.
CANT_DISABLE_CORP_CURRENCY

You can’t disable the corporate currency for an org. To disable a currency that is set as the corporate currency, first use the user
interface to change the corporate currency to a different currency. Then disable the original currency.
CANT_UNSET_CORP_CURRENCY

You can’t change the corporate currency for an org from the API. Use the user interface to change the corporate currency.
CHILD_SHARE_FAILS_PARENT

If you don’t have appropriate permissions on a parent record, you can’t change the owner of or define sharing rules for a child record.
For example, you can’t change the owner of a contact record if you can’t edit its parent account record.
CIRCULAR_DEPENDENCY

You can't create a circular dependency between metadata objects in your org. For example, public group A can't include public
group B, if public group B already includes public group A.

Object Basics

StatusCode

COMMUNITY_NOT_ACCESSIBLE

You do not have permission to access the community that this entity belongs to. You must be given permission to access the
community before you can access this entity.
CUSTOM_CLOB_FIELD_LIMIT_EXCEEDED

You can't exceed the maximum size for a CLOB field.
CUSTOM_ENTITY_OR_FIELD_LIMIT

You have reached the maximum number of custom objects or custom fields for your org.
CUSTOM_FIELD_INDEX_LIMIT_EXCEEDED

You have reached the maximum number of indexes on a field for your org.
CUSTOM_INDEX_EXISTS

You can create only one custom index per field.
CUSTOM_LINK_LIMIT_EXCEEDED

You have reached the maximum number of custom links for your org.
CUSTOM_METADATA_LIMIT_EXCEEDED

Your org has reached its custom metadata maximum limit.
CUSTOM_SETTINGS_LIMIT_EXCEEDED

Your org has reached its custom settings maximum limit.
CUSTOM_TAB_LIMIT_EXCEEDED

You have reached the maximum number of custom tabs for your org.
DELETE_FAILED

You can't delete a record because it is in use by another object.
DEPENDENCY_EXISTS

You can't perform the requested operation because of an existing dependency on the specified object or field.
DUPLICATE_CASE_SOLUTION

You can't create a relationship between the specified case and solution because it already exists.
DUPLICATE_CUSTOM_ENTITY_DEFINITION

Custom object or custom field IDs must be unique.
DUPLICATE_CUSTOM_TAB_MOTIF

You can't create a custom object or custom field with a duplicate master name.
DUPLICATE_DEVELOPER_NAME

You can't create a custom object or custom field with a duplicate developer name.
DUPLICATES_DETECTED

Duplicate records have been detected. Used for an Error object with a data type of DuplicateError.
DUPLICATE_EXTERNAL_ID

A user-specified external ID matches more than one record during an upsert.
DUPLICATE_MASTER_LABEL

You can't create a custom object or custom field with a duplicate master name.
DUPLICATE_SENDER_DISPLAY_NAME
A sendEmail() call could not choose between OrgWideEmailAddress.DisplayName or senderDisplayName. Define

only one of the two fields.
DUPLICATE_USERNAME

A create, update, or upsert failed because of a duplicate user name.

Object Basics

StatusCode

DUPLICATE_VALUE

You can’t supply a duplicate value for a field that must be unique. For example, you can’t submit two copies of the same session ID
in a invalidateSessions() call.
EMAIL_ADDRESS_BOUNCED

Emails to one or more recipients have bounced. Check the email addresses to make sure that they are valid.
EMAIL_NOT_PROCESSED_DUE_TO_PRIOR_ERROR

Because of an error earlier in the call, the current email was not processed.
EMAIL_OPTED_OUT

A single email message was sent with the REJECT setting in the optOutPolicy field to recipients that have opted out from
receiving email. To avoid this error, set the optOutPolicy field to another value.
EMAIL_TEMPLATE_FORMULA_ERROR

The email template is invalid and can’t be rendered. Check the template for incorrectly specified merge fields.
EMAIL_TEMPLATE_MERGEFIELD_ACCESS_ERROR

You don’t have access to one or more merge fields in this template. To request access, contact your Salesforce administrator.
EMAIL_TEMPLATE_MERGEFIELD_ERROR

One or more merge fields don’t exist. Check the spelling of field names.
EMAIL_TEMPLATE_MERGEFIELD_VALUE_ERROR

One or more merge fields have no value. To provide values, update the records before sending the email.
EMAIL_TEMPLATE_PROCESSING_ERROR

The merge fields in this email template can’t be processed. Ensure that your template body is valid.
EMPTY_SCONTROL_FILE_NAME

The Scontrol file name was empty, but the binary was not empty.
ENTITY_FAILED_IFLASTMODIFIED_ON_UPDATE
If the value in a record’s LastModifiedDate field is later than the current date, you can’t update the record .
ENTITY_IS_ARCHIVED

If a record has been archived, you can’t access it.
ENTITY_IS_DELETED

You can’t reference an object that has been deleted. This status code occurs only in API version 10.0 and later. Previous releases of
the API use INVALID_ID_FIELD for this error.
ENTITY_IS_LOCKED

You can’t edit a record that is locked by an approval process.
ENVIRONMENT_HUB_MEMBERSHIP_CONFLICT

You can’t add an org to more than one Environment Hub.
ERROR_IN_MAILER

An email address is invalid, or another error occurred during an email-related transaction.
FAILED_ACTIVATION

The activation of a Contract failed.
FIELD_CUSTOM_VALIDATION_EXCEPTION

You can't define a custom validation formula that violates a field integrity rule.
FIELD_FILTER_VALIDATION_EXCEPTION

You can't violate field integrity rules.

Object Basics

StatusCode

FILTERED_LOOKUP_LIMIT_EXCEEDED

The creation of the lookup filter failed because it exceeds the maximum number of lookup filters allowed per object.
HTML_FILE_UPLOAD_NOT_ALLOWED

Your attempt to upload an HTML file failed. HTML attachments and documents, including HTML attachments to a Solution, can't be
uploaded if the Disallow HTML documents and attachments checkbox is selected on the HTML Documents and
Attachments Settings page.
IMAGE_TOO_LARGE

The image exceeds the maximum width, height, and file size.
INACTIVE_OWNER_OR_USER

The owner of the specified item is an inactive user. To reference this item, either reactivate the owner or reassign ownership to
another active user.
INSERT_UPDATE_DELETE_NOT_ALLOWED_DURING_MAINTENANCE

Starting with version 32.0, you can’t create, update, or delete data while the instance where your org resides is being upgraded to
the latest release. Try again after the release has completed. For release schedules, see trust.salesforce.com. Before version
32.0, the code is INVALID_READ_ONLY_USER_DML.
INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY

An operation affects an object that is cross-referenced by the specified object, but the logged-in user doesn’t have sufficient
permissions on the cross-referenced object. For example, a logged-in user attempts to modify an account record, and the update
creates a ProcessInstanceWorkitem. If the user doesn’t have permission to approve, reject, or reassign the ProcessInstanceWorkitem,
this exception occurs.
INSUFFICIENT_ACCESS_OR_READONLY

You can’t perform the specified action because you don’t have sufficient permissions.
INVALID_ACCESS_LEVEL

You can’t define a new sharing rule that provides less access than the specified org-wide default.
INVALID_ARGUMENT_TYPE

You supplied an argument that is of the wrong type for the operation being attempted.
INVALID_ASSIGNEE_TYPE

You specified an assignee type that is not a valid integer between one and six.
INVALID_ASSIGNMENT_RULE

You specified an assignment rule that is invalid or that isn’t defined in the org.
INVALID_BATCH_OPERATION

The specified batch operation is invalid.
INVALID_CONTENT_TYPE

The outgoing email has anEmailFileAttachment with an invalidcontentType property. See RFC2045 - Internet Message Format.
INVALID_CREDIT_CARD_INFO

The specified credit card information is not valid.
INVALID_CROSS_REFERENCE_KEY

The specified value in a relationship field is not valid, or data is not of the expected type.
INVALID_CROSS_REFERENCE_TYPE_FOR_FIELD

The specified cross-reference type is not valid for the specified field.
INVALID_CURRENCY_CONV_RATE

Specify a positive, non-zero value for the currency conversion rate.

Object Basics

StatusCode

INVALID_CURRENCY_CORP_RATE

You can’t modify the corporate currency conversion rate.
INVALID_CURRENCY_ISO

The specified currency ISO code is not valid.
INVALID_EMAIL_ADDRESS

A specified email address is invalid.
INVALID_EMPTY_KEY_OWNER
You can't set the value for owner to null.
INVALID_EVENT_SUBSCRIPTION

Invalid parameters were specified when subscribing to an event.
INVALID_FIELD

You specified an invalid field name when trying to update or upsert a record.
INVALID_FIELD_FOR_INSERT_UPDATE

You can't combine a person account record type change with any other field update.
INVALID_FIELD_WHEN_USING_TEMPLATE

You can't use an email template with an invalid field name.
INVALID_FILTER_ACTION

The specified filter action can't be used with the specified object. For example, an alert is not a valid filter action for a Task.
INVALID_ID_FIELD

The specified ID field (ID, ownerId), or cross-reference field is invalid.
INVALID_INET_ADDRESS

A specified Inet address is not valid.
INVALID_LINEITEM_CLONE_STATE

You can’t clone a Pricebook2 or PricebookEntry record that isn’t active.
INVALID_MASTER_OR_TRANSLATED_SOLUTION

The solution is invalid. For example, this exception occurs if you try to associate a translated solution with a master solution that’s
associated with another translated solution.
INVALID_MESSAGE_ID_REFERENCE

The outgoing email's References or In-Reply-To fields are invalid. These fields must contain valid Message-IDs. See RFC2822 - Internet
Message Format.
INVALID_OPERATION

There is no applicable approval process for the specified object.
INVALID_OPERATOR

The specified operator is not applicable for the field type when used as a workflow filter.
INVALID_OR_NULL_FOR_RESTRICTED_PICKLIST

You specified an invalid or null value for a restricted picklist.
INVALID_PARTNER_NETWORK_STATUS

The specified partner network status is invalid for the specified template field.
INVALID_PERSON_ACCOUNT_OPERATION

You can't delete a person account.

Object Basics

StatusCode

INVALID_READ_ONLY_USER_DML

Version 31.0 and earlier: You can’t create, update, or delete data while the instance where your org resides is being upgraded to the
latest release. Try again after the release has completed. For release schedules, see trust.salesforce.com. After version
31.0, the code is INSERT_UPDATE_DELETE_NOT_ALLOWED_DURING_MAINTENANCE.
INVALID_SAVE_AS_ACTIVITY_FLAG
Specify true or false for the saveAsActivity flag.
INVALID_SESSION_ID
The specified sessionId is malformed (incorrect length or format) or has expired. Log in again to start a new session.
INVALID_STATUS

The specified org status change is not valid.
INVALID_TYPE

The specified type is not valid for the specified object.
INVALID_TYPE_FOR_OPERATION

The specified type is not valid for the specified operation.
INVALID_TYPE_ON_FIELD_IN_RECORD

The specified value is not valid for the specified field's type.
IP_RANGE_LIMIT_EXCEEDED

The specified IP address is outside the IP range specified for the org.
JIGSAW_IMPORT_LIMIT_EXCEEDED

The number of records you attempted to purchase from Data.com exceeds your available record addition limit.
LICENSE_LIMIT_EXCEEDED

You have exceeded the number of licenses assigned to your org.
LIGHT_PORTAL_USER_EXCEPTION

You attempted an action with a high-volume portal user that's not allowed. For example, trying to add the user to a case team.
LIMIT_EXCEEDED

You have exceeded a limit on a field size or value, license, or other component.
LOGIN_CHALLENGE_ISSUED

An email containing a security token was sent to the user’s email address because the user logged in from an untrusted IP address.
The user can’t log in until tthe security token is added to the end of the password.
LOGIN_CHALLENGE_PENDING

The user logged in from an untrusted IP address, but a security token has not yet been issued.
LOGIN_MUST_USE_SECURITY_TOKEN

The user must add a security token to the end of the password to log in.
MALFORMED_ID

An ID must be either 15 characters, or 18 characters with a valid case-insensitive extension. There is also an exception code of the
same name.
MANAGER_NOT_DEFINED

A manager has not been defined for the specified approval process.
MASSMAIL_RETRY_LIMIT_EXCEEDED

A mass mail retry failed because your org has exceeded its mass mail retry limit.
MASS_MAIL_LIMIT_EXCEEDED

The org has exceeded its daily limit for mass email. Mass email messages can't be sent again until the next day.

Object Basics

StatusCode

MAXIMUM_CCEMAILS_EXCEEDED

You have exceeded the maximum number of specified CC addresses in a workflow email alert.
MAXIMUM_DASHBOARD_COMPONENTS_EXCEEDED

You have exceeded the document size limit for a dashboard.
MAXIMUM_HIERARCHY_LEVELS_REACHED

You have reached the maximum number of levels in a hierarchy.
MAXIMUM_SIZE_OF_ATTACHMENT

You have exceeded the maximum size of an attachment.
MAXIMUM_SIZE_OF_DOCUMENT

You have exceeded the maximum size of a document.
MAX_ACTIONS_PER_RULE_EXCEEDED

You have exceeded the maximum number of actions per rule.
MAX_ACTIVE_RULES_EXCEEDED

You have exceeded the maximum number of active rules.
MAX_APPROVAL_STEPS_EXCEEDED

You have exceeded the maximum number of approval steps for an approval process.
MAX_FORMULAS_PER_RULE_EXCEEDED

You have exceeded the maximum number of formulas per rule.
MAX_RULES_EXCEEDED

You have exceeded the maximum number of rules for an object.
MAX_RULE_ENTRIES_EXCEEDED

You have exceeded the maximum number of entries for a rule.
MAX_TASK_DESCRIPTION_EXCEEDED

The task description is too long.
MAX_TM_RULES_EXCEEDED

You have exceeded the maximum number of rules per Territory.
MAX_TM_RULE_ITEMS_EXCEEDED

You have exceeded the maximum number of rule criteria per rule for a Territory.
MERGE_FAILED

A merge operation failed.
MISSING_ARGUMENT

You did not specify a required argument.
NONUNIQUE_SHIPPING_ADDRESS

You can't insert a reduction order item if the original order shipping address is different from the shipping address of other items in
the reduction order.
NO_APPLICABLE_PROCESS
A process() request failed because the record submitted does not satisfy the entry criteria of any active approval processes for

which the user has permission.
NO_ATTACHMENT_PERMISSION

Your org does not permit email attachments.
NO_INACTIVE_DIVISION_MEMBERS

You can't add members to an inactive Division.

Object Basics

StatusCode

NO_MASS_MAIL_PERMISSION

You don’t have permission to send the email. You must have “Mass Email” to send mass mail or “Send Email” to send individual
email.
NUMBER_OUTSIDE_VALID_RANGE

The number specified is outside the valid range of values.
NUM_HISTORY_FIELDS_BY_SOBJECT_EXCEEDED

The number of history fields specified for the sObject exceeds the allowed limit.
OP_WITH_INVALID_USER_TYPE_EXCEPTION

The operation you attempted can't be performed for one or more users. For example, you can't add high-volume portal users to a
group.
OPTED_OUT_OF_MASS_MAIL

An email can't be sent because the specified User has opted out of mass mail.
PACKAGE_LICENSE_REQUIRED

The logged-in user can’t access an object that is in a licensed package without a license for the package.
PORTAL_USER_ALREADY_EXISTS_FOR_CONTACT

A create User operation failed because you can't create a second portal user under a Contact.
PRIVATE_CONTACT_ON_ASSET

You can’t have a private contact on an asset.
RECORD_IN_USE_BY_WORKFLOW

You can’t access a record that’s in use by a workflow or approval process.
REQUEST_RUNNING_TOO_LONG

A request that has been running too long is canceled.
REQUIRED_FIELD_MISSING

A call requires a field that was not specified.
SELF_REFERENCE_FROM_TRIGGER

You can't recursively update or delete the same object from an Apex trigger. This error often occurs when:
• You try to update or delete an object from within its before trigger.
• You try to delete an object from within its after trigger.
This error occurs with both direct and indirect operations. The following is an example of an indirect operation:
1. A request is submitted to update Object A.
2. A before update trigger on object A creates an object B.
3. Object A is updated.
4. An after insert trigger on object B queries object A and updates it. This update is an indirect update of object A because
of the before trigger of object A, so an error is generated.
SHARE_NEEDED_FOR_CHILD_OWNER

If a parent record has a child record that needs a sharing rule, you can’t delete the sharing rule for the parent record.
SINGLE_EMAIL_LIMIT_EXCEEDED

(API version 18.0 and later) The org has exceeded its daily limit for individual emails. Individual email messages can’t be sent again
until the next day.
STANDARD_PRICE_NOT_DEFINED

Custom prices can't be defined without corresponding standard prices.

Object Basics

StatusCode

STORAGE_LIMIT_EXCEEDED

You have exceeded your org’s storage limit.
STRING_TOO_LONG

The specified string exceeds the maximum allowed length.
TABSET_LIMIT_EXCEEDED

You have exceeded the number of tabs allowed for a tabset.
TEMPLATE_NOT_ACTIVE

The template specified is unavailable. Specify another template or make the template available for use.
TERRITORY_REALIGN_IN_PROGRESS

An operation can't be performed because a territory realignment is in progress.
TEXT_DATA_OUTSIDE_SUPPORTED_CHARSET

The specified text uses a character set that is not supported.
TOO_MANY_APEX_REQUESTS

Too many Apex requests have been sent. This error is transient. Resend your request after a short wait.
TOO_MANY_ENUM_VALUE

A request failed because too many values were passed in for a multi-select picklist. You can select a maximum of 100 values for a
multi-select picklist.
TRANSFER_REQUIRES_READ

You can't assign the record to the specified User because the user does not have read permission.
UNABLE_TO_LOCK_ROW

A deadlock or timeout condition has been detected.
• A deadlock involves at least two transactions that are attempting to update overlapping sets of objects. If the transaction involves
a summary field, the parent objects are locked, making these transactions especially prone to deadlocks. To debug, check your
code for deadlocks and correct. Deadlocks are generally not the result of an issue with Salesforce operations.
• A timeout occurs when a transaction takes too long to complete, for example, when replacing a value in a picklist or changing
a custom field definition. The timeout state is temporary. No corrective action is needed.
If an object in a batch can’t be locked, the entire batch fails with this error. Errors with this status code contain the IDs of the records
that couldn’t be locked, when available, in the error message.
UNAVAILABLE_RECORDTYPE_EXCEPTION

The appropriate default record type could not be found.
UNDELETE_FAILED

An object could not be undeleted because it does not exist or has not been deleted.
UNKNOWN_EXCEPTION

The system encountered an internal error. Report this problem to Salesforce.
Note: Do not report this exception code to Salesforce if it results from a sendEmail() call. The sendEmail() call
returns this exception code when it is used to send an email to one or more recipients who have the Email Opt Out option
selected.
UNSPECIFIED_EMAIL_ADDRESS

The specified user does not have an email address.
UNSUPPORTED_APEX_TRIGGER_OPERATION

You can't save recurring events with an Apex trigger.

Object Basics

ExtendedErrorDetails

UNVERIFIED_SENDER_ADDRESS
A sendEmail() call attempted to use an unverified email address defined in the OrgWideEmailAddress object.
WEBLINK_SIZE_LIMIT_EXCEEDED

The size of a WebLink URL or JavaScript code exceeds the limit.
WEBLINK_URL_INVALID

The WebLink URL has failed the URL string validation check.
WRONG_CONTROLLER_TYPE

The controller type for your Visualforce email template does not match the object type being used.
If you receive a status code not listed in the previous table, contact Customer Support.

ExtendedErrorDetails
Reserved for future use. An ExtendedErrorDetails element contains extra detailed information about an error. The
ExtendedErrorDetails element has the following properties.
Name

Type

Description

extendedErrorCode ExtendedErrorCode
extended error
property

Varies

A code that characterizes the extended error details.
An extended error property that contains more information about the error. The
property name and value vary based on the extended error code.

Duplicate Management Data Types
DuplicateError
Contains information about an error that occurred when an attempt was made to save a duplicate record. Use if your organization has
set up duplicate rules, which are part of the Duplicate Management feature.

Fields
Field

Details

duplicateResult

Type
DuplicateResult
Description
The details of a duplicate rule and duplicate records found by the duplicate rule.

fields

Type
string[]
Description
Array of one or more field names. Identifies which fields in the object, if any, affected the
error condition.

Object Basics

Duplicate Management Data Types

Field

Details

message

Type
string
Description
Error message text.

statusCode

Type
StatusCode
Description
A code that characterizes the error. The full list of status codes is available in the WSDL file
for your organization (see Generating the WSDL File for Your Organization).

Usage
DuplicateError and its constituent objects are available to organizations that use duplicate rules.
DuplicateError is a data type of Error.
To process duplicates, loop through all the Error objects in the errors field on SaveResult. An Error object with a data type of
DuplicateError contains information about an error that occurred when an attempt was made to save a duplicate record. To access
information about the duplicates, use the duplicateResult field.

Java Sample
Here is a sample that shows how to see if there are any errors on the saveResult with a data type of DuplicateError. If so, duplicates were
detected. See DuplicateResult for a full code sample that shows how to block users from entering duplicate leads and display an alert
and a list of duplicates.
if (!saveResult.isSuccess()) {
for (Error e : saveResult.getErrors()) {
if (e instanceof DuplicateError) {
System.out.println("Duplicate(s) Detected for lead with ID: " +
leads[i].getId());
System.out.println("ERROR MESSAGE: " + e.getMessage());
System.out.println("STATUS CODE: " + e.getStatusCode());
DuplicateResult dupeResult = ((DuplicateError)e).getDuplicateResult();
System.out.println("Found the following duplicates...");
for (MatchResult m : dupeResult.getMatchResults()) {
if (m.isSuccess()) {
System.out.println("The match rule that was triggered was " +
m.getRule());
for (MatchRecord mr : m.getMatchRecords()) {
System.out.println("Your record matched " + mr.getRecord().getId()
+ " of type "
+ mr.getRecord().getType());
System.out.println("The match confidence is " +
mr.getMatchConfidence());
}
}
}

Object Basics

Duplicate Management Data Types

}
}
}

DuplicateResult
Represents the details of a duplicate rule that detected duplicate records and information about those duplicate records.

Fields
Field

Details

allowSave

Type
boolean
Description
true if duplicates are allowed to be saved. false if duplicates are not allowed to be
saved.

duplicateRule

Type
string
Description
The name of the duplicate rule that detected duplicate records.

duplicateRuleEntityType Type

string
Description
The name of the duplicate rule that detected duplicate records.
errorMessage

Type
string
Description
The error message configured by the administrator to warn users they are potentially creating
duplicate records. This message is associated with a duplicate rule.

matchResults

Type
MatchResult
Description
The duplicate records and related match information.

Usage
DuplicateResult and its constituent objects are available to organizations that use duplicate rules.

Object Basics

Duplicate Management Data Types

Java Sample
Here is a sample that shows how to block users from entering duplicate leads and display an alert and a list of duplicates.
package com.doc.example;
import java.io.FileNotFoundException;
import
import
import
import
import

com.sforce.soap.partner.*;
com.sforce.soap.partner.Error;
com.sforce.soap.partner.sobject.SObject;
com.sforce.ws.ConnectionException;
com.sforce.ws.ConnectorConfig;

public class SaveResultsWithDupeHeader {
private PartnerConnection partnerConnection = null;
static SaveResultsWithDupeHeader tester;
public static void main(String[] args) {
tester = new SaveResultsWithDupeHeader();
try {
tester.demoDuplicateRuleHeader();
} catch (Exception e) {
e.printStackTrace();
}
}
/*
* Make sure that you have an active lead duplicate rule linked to an active matching
rule. This method tries to save
* an array of leads and inspects whether any duplicates were detected
*/
public void demoDuplicateRuleHeader() throws FileNotFoundException, ConnectionException
{
// Create the configuration for the partner connection
ConnectorConfig config = new ConnectorConfig();
config.setUsername("user@domain.com");
config.setPassword("secret");
config.setAuthEndpoint("authEndPoint");
config.setTraceFile("traceLogs.txt");
config.setTraceMessage(true);
config.setPrettyPrintXml(true);
// Initialize the connection
partnerConnection = new PartnerConnection(config);
// Get the leads that have to be saved
SObject[] leads = getLeadsForInsertOrUpdate();
/* Set a duplicate rule header to return a result if duplicates are detected
* This sets the allowSave, includeRecordDetails, and runAsCurrentUser flags to
true
*/
partnerConnection.setDuplicateRuleHeader(true, true, true);

Object Basics

Duplicate Management Data Types

// Save the leads
SaveResult[] saveResults = partnerConnection.create(leads);
// Check the results to see if duplicates were detected
for (int i = 0; i < leads.length; i++) {
SaveResult saveResult = saveResults[i];
if (!saveResult.isSuccess()) {
for (Error e : saveResult.getErrors()) {
// See if there are any errors on the saveResult with a data type of
DuplicateError
if (e instanceof DuplicateError) {
System.out.println("Duplicate(s) Detected for lead with ID: " +
leads[i].getId());
System.out.println("ERROR MESSAGE: " + e.getMessage());
System.out.println("STATUS CODE: " + e.getStatusCode());
DuplicateResult dupeResult =
((DuplicateError)e).getDuplicateResult();
System.out.println("Found the following duplicates...");
for (MatchResult m : dupeResult.getMatchResults()) {
if (m.isSuccess()) {
System.out.println("The match rule that was triggered was
" + m.getRule());
for (MatchRecord mr : m.getMatchRecords()) {
System.out.println("Your record matched " +
mr.getRecord().getId() + " of type "
+ mr.getRecord().getType());
System.out.println("The match confidence is " +
mr.getMatchConfidence());
for (FieldDiff f : mr.getFieldDiffs()) {
System.out.println("For field " + f.getName() + "
field difference is "
+ f.getDifference().name());
}
}
}
}
}
}
}
}
// Clear the duplicate rule header
partnerConnection.clearDuplicateRuleHeader();
}
/**
* The assumption here is that this method is retrieving leads from either UI, a data
source, etc
*/
private SObject[] getLeadsForInsertOrUpdate() {
return new SObject[0];
}

Object Basics

Duplicate Management Data Types

}

MatchResult
Represents the duplicate results for a matching rule.

Fields
Field

Details

errors

Type
Error[]
Description
Errors that occurred during matching for the matching rule.

entityType

Type
string
Description
The entity type of the matching rule.

matchEngine

Type
string
Description
The match engine for the matching rule.

matchRecords

Type
MatchRecord[]
Description
Information about the duplicates detected by the matching rule.

rule

Type
string
Description
The developer name of the matching rule that detected duplicates.

size

Type
int
Description
The number of duplicates detected by the matching rule.

success

Type
boolean

Object Basics

Field

Duplicate Management Data Types

Details
Description
true if the matching rule successfully ran. false if there’s an error with the matching
rule.

Usage
MatchResult and its constituent objects are available to organizations that use duplicate rules.
There is 1 MatchResult for each saved record that has duplicates. The MatchResult contains all duplicates for that saved record.

Java Sample
Here is a sample that shows how to display the ID and type of all duplicates detected when leads are saved. See DuplicateResult for a
full code sample that shows how to block users from entering duplicate leads and display an alert and a list of duplicates.
for (MatchResult m : dupeResult.getMatchResults()) {
if (m.isSuccess()) {
System.out.println("The match rule that was triggered was " + m.getRule());
for (MatchRecord mr : m.getMatchRecords()) {
System.out.println("Your record matched " + mr.getRecord().getId() + " of type
"
+ mr.getRecord().getType());
System.out.println("The match confidence is " + mr.getMatchConfidence());
}
}
}

MatchRecord
Represents a duplicate record detected by a matching rule.

Fields
Field

Details

additionalInformation

Type
AdditionalInformationMap
Description
Other information about matched records.

fieldDiffs

Type
FieldDiff[]
Description
Matching rule fields and how each field value compares for the duplicate and its matching
record.

Object Basics

Duplicate Management Data Types

Field

Details

matchConfidence

Type
double
Description
The ranking of how similar a matched record’s data is to the data in your request. Must be
equal to or greater than the value of the minMatchConfidence specified in your
request. Returns -1 if unused.

record

Type
sObject
Description
The fields and field values for the duplicate record.

Usage
MatchRecord and its constituent objects are available to organizations that use duplicate rules.
Each MatchRecord represents a duplicate detected when a record is saved. There can be multiple MatchRecord objects for a saved record
if multiple duplicates are detected.

Java Sample
Here is a sample that shows how to display the ID and type of all duplicates detected when a lead is saved. See DuplicateResult for a full
code sample that shows how to block users from entering duplicate leads and display an alert and a list of duplicates.
for (MatchRecord mr : m.getMatchRecords()) {
System.out.println("Your record matched " + mr.getRecord().getId() + " of type "
+ mr.getRecord().getType());
System.out.println("The match confidence is " + mr.getMatchConfidence());
}

FieldDiff
Represents the name of a matching rule field and how the values of the field compare for the duplicate and its matching record.

Fields
Field

Details

difference

Type
differenceType
Description
How the values of the matching rule field compare for the duplicate and its matching record.
Possible values include:
• Same: Indicates the field values match exactly.

Object Basics

Field

System Fields

Details
• Different: Indicates that the field values do not match.
• Null: Indicates that the field values are a match because both values are blank.

name

Type
string
Description
The name of a field on a matching rule that detected duplicates.

Java Sample
Here is a sample that shows how to display the matching rule field differences when a duplicate is detected. See DuplicateResult for a
full code sample that shows how to block users from entering duplicate leads and display an alert and a list of duplicates.
for (FieldDiff f : mr.getFieldDiffs()) {
System.out.println("For field " + f.getName() + " field difference is "
+ f.getDifference().name());
}

AdditionalInformationMap
Represents other information, if any, about matched records.

Fields
Field

Details

name

Type
string
Description
The name of the element.

value

Type
string
Description
The value of the element.

System Fields
The following fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example,
the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies
a record.

Object Basics

System Fields

Field

Field Type

Description

Globally unique string that identifies a record. For information on IDs, see ID Field
Type. Because this field exists in every object, it is not listed in the field table for
each object. Id fields have Defaulted on create and Filter access.

IsDeleted

boolean

Indicates whether the record has been moved to the Recycle Bin (true) or not
(false). Because this field does not appear in all objects, it is listed in the field
table for each object.
Audit Fields

CreatedById

reference

ID of the User who created this record. CreatedById fields have Defaulted on
create and Filter access.

CreatedDate

dateTime

Date and time when this record was created. CreatedDate fields have
Defaulted on create and Filter access.

LastModifiedById

reference

ID of the User who last updated this record. LastModifiedById fields have
Defaulted on create and Filter access.

LastModifiedDate

dateTime

Date and time when a user last modified this record. LastModifiedDate
fields have Defaulted on create and Filter access.

SystemModstamp

dateTime

Date and time when a user or automated process (such as a trigger) last modified
this record. SystemModstamp fields have Defaulted on create and Filter access.

If you import data into Salesforce and want to retain the audit field values of the source system, you can set the values for audit fields
on the following objects: Account, ArticleVersion, Attachment, CampaignMember, Case, CaseComment, Contact, ContentVersion,
Contract, Event, Idea, IdeaComment, Lead, Opportunity, Question, Task, Vote, and custom objects. The only audit field you cannot set a
value for is systemModstamp.
1. From Setup, enter User Interface in the Quick Find box, then select User Interface under Customize.
2. Under Setup, select Enable “Set Audit Fields upon Record Creation” and “Update Records with Inactive Owners” User
Permissions.
3. In the permission set or profile that you want to set audit fields with, enable the permission Set Audit Fields upon Record Creation.
4. Using the API, create a record and set its audit fields.
Not all standard objects have all audit fields. Check the Enterprise WSDL to verify which audit fields are available for a given object.

Parent Reference Fields
If an object has a relationship to a parent object, two fields are added.
• Parent_Name contains the object name of the parent. For example, Case has a Contact field that contains a reference to the
contact parent of the case.
• Parent_NameId contains the ID of the parent. For example, Case has a ContactId field that refers to the contact parent of
the case. This field is used in SOQL relationship queries such as the following:
SELECT Case.ContactId, Case.Contact.Name FROM Case

Object Basics

Required Fields

Even if the object can parent itself, these fields occur. For example, the Campaign object has a Campaign and CampaignId field
for referencing the parent Campaign.

Required Fields
Required fields must have a non-null value. This rule affects the create and update calls:
• In a create call, the system automatically populates the data for certain required fields (such as system fields and the object ID fields).
Similarly, if a required field has a default value (its defaultedOnCreate attribute is set to true, as described in Field
in a describe result, then the system implicitly assigns a value for this field when the object is created, even if a value for this field is
not explicitly passed in on the create call. For all other required fields, such as ID fields that are analogous to foreign keys in SQL, a
client application must explicitly assign a value when the object is created (it cannot be null).
• In updates, a required field cannot be set to null, and many required fields can’t be changed.
Any field not specified as required in the object description is optional, that is, it can be null when updated or created.
Some required fields for some objects require special handling.

Frequently-Occurring Fields
In addition to system fields, the following fields are found on many objects:
• OwnerId
• RecordTypeId
• CurrencyIsoCode

OwnerId
Objects have an ownerId field that is an reference to the user who owns that object. Ownership is an important concept that affects
the security model and has other implications throughout the system. Any user can query the owner field for any record they can access.
However, setting the ownerId field has the following limitations:
• For most users and most objects, this field can’t be set directly upon insert. It is implicitly set to the current user when inserting an
object.
• When creating or updating a Case or Lead, a client application (that is logged in with sufficient permissions to transfer a record) can
set this field to any valid User in the organization or to any valid queue of the appropriate type in the organization.
• Updating this field via the API changes only the owner of that record. The change of ownership does not cascade to associated
records as it does when you transfer record ownership in the Salesforce user interface.
• Updating this field on an account deletes the existing sharing information and reapplies the organization-wide sharing defaults and
sharing rules.
• To update the ownerId field, the user must have the "Transfer Record" permission and Read access to the new owner.
In API version 12.0 and later, if your organization has set up opportunity teams, OwnerId fields behave the same for Account and
Opportunity objects as for other objects. That is, if you update the OwnerId field in either object, any AccountShare or OpportunityShare
records with RowCause set to Sales Team are kept. In API version 11.0 and earlier, the sharing records are deleted.

Object Basics

API Field Properties

RecordTypeId
Record types are used to offer different business processes and subsets of picklist values to different User records based on their Profile
settings. (In addition, person accounts use record types to manage a number of additional elements.
Record types are configured in the user interface or by creating, editing, or deleting the RecordType object in the API. Retrieve the list
of valid record type IDs (String) for an object by querying the RecordType object.
The RecordTypeId field in an object contains the ID of the RecordType record that is associated with a standard or custom object.
You can create or update this field.
Note: You can’t create or update the RecordTypeId field on the CampaignMember records. Set the CampaignMember
record type using the CampaignMemberRecordTypeId field on Campaign.
When specified in a create or update call, the record type ID (String) must refer to a valid record type for that object.
Note: The RecordTypeId field is in your organization’s WSDL only if at least one record type is configured for your organization
in the Salesforce user interface.

CurrencyIsoCode
For organizations that have multicurrency enabled, the CurrencyIsoCode field contains the string representation of the currency
ISO code associated with currency values in the object. Note that the User object also has a DefaultCurrencyIsoCode field,
which is the default currency for that user. For example, a user in France could have a DefaultCurrencyIsoCode set to Euros,
and that would be their default currency in the application. However, the User object could have currency custom fields stored in a
different currency, that will correspond to the organization currency at the time the user record is created.

API Field Properties
Fields on objects represent the details of each object and are analogous to columns in a database table. Each field on each object has
one or more of the following properties:
Property

Description

Autonumber

The API creates an autonumber.

Create

Value for the field can be specified during create using the API.

Defaulted on create

When created, a default value is supplied if no other value is specified.

Delete

Value for the field can be deleted using the API.

Filter

Can be used as filter criteria in a SOQL query FROM or WHERE clause.

Group

Can be included in the GROUP BY clause of a SOQL query (true) or not (false). Available in API
version 18.0 and later.

idLookup

Can be used to specify a record in an upsert call. The Id field of each object has this property and
some Name fields. There are exceptions, so check for the property in any object you wish to upsert.

Nillable

The field can contain a null value.

Query

The field can be queried with SOQL using the API.

Object Basics

Relationships Among Objects

Property

Description

Restricted picklist

A picklist whose values are restricted to those values defined by a Salesforce admin. Users can’t load
unapproved values through the API.

Retrieve

Value of the field can be retrieved using the API.

Sort

Indicates whether a query can sort on this field (true) or not (false).

Update

Can be updated using the API.

Relationships Among Objects
Relationships associate objects with other objects. For example, a relationship can link a custom object to standard object in a related
list, such as linking a custom object called Bugs to cases to track product defects associated with customer cases. To view the parent
and child relationships among standard objects, see the ERD diagrams in Data Model.
Note:
• You can use parent-child relationships in SOQL queries. For more information, see Relationship Queries in the Salesforce SOQL
and SOSL Reference Guide.
• Only lookup, external lookup, and indirect lookup relationships are available for external objects. No other relationship types
are supported. See “External Object Relationships” in the Salesforce Help.
You can define different types of relationships by creating custom relationship fields on an object. The differences between relationship
types include how they handle data deletion, record ownership, security, and required fields in page layouts:
• Master-Detail (1:n) — A parent-child relationship in which the master object controls certain behaviors of the detail object:
– When a record of the master object is deleted, its related detail records are also deleted.
– The Owner field on the detail object is not available and is automatically set to the owner of its associated master record.
Custom objects on the detail side of a master-detail relationship cannot have sharing rules, manual sharing, or queues, as these
require the Owner field.
– The detail record inherits the sharing and security settings of its master record.
– The master-detail relationship field is required on the page layout of the detail record.
– By default, records can’t be reparented in master-detail relationships. Administrators can, however, allow child records in
master-detail relationships on custom objects to be reparented to different parent records by selecting the Allow
reparenting option in the master-detail relationship definition.
You can define master-detail relationships between custom objects or between a custom object and a standard object. However,
the standard object cannot be on the detail side of a relationship with a custom object. In addition, you cannot create a master-detail
relationship in which the User or Lead objects are the master.
When you define a master-detail relationship, the custom object on which you are working is the detail side. Its data can appear as
a custom related list on page layouts for the other object.
• Many-to-many — You can use master-detail relationships to model many-to-many relationships between any two objects. A
many-to-many relationship allows each record of one object to be linked to multiple records from another object and vice versa.
For example, you may have a custom object called “Bug” that relates to the standard case object such that a bug could be related
to multiple cases and a case could also be related to multiple bugs. To create a many-to-many relationship, simply create a custom
junction object with two master-detail relationship fields, each linking to the objects you want to relate. See the Salesforce online
help for details.

Object Basics

Relabeling Fields and Tabs and the API

Custom objects with two master-detail relationships are supported in API version 11 and later.
Starting in API version 34.0, the JunctionIdList field type lets you manipulate the many-to-many relationship of an entity
directly. You no longer need to manipulate underlying junction entity records. JunctionIdList fields can be queried and
updated like any other field on the entity. Queries or updates to JunctionIdList fields act as queries or updates to the underlying
junction entity records. Fields of type JunctionIdList appear in the WSDL as an unbounded array of type ID.
JunctionIdList is implemented in the Task and Event objects.
• Lookup (1:n) — This type of relationship links two objects together, but has no effect on deletion or security. Unlike master-detail
fields, lookup fields are not automatically required. When you define a lookup relationship, data from one object can appear as a
custom related list on page layouts for the other object. See the Salesforce online help for details.
To create relationships, use the user interface or Salesforce Metadata API.

Relabeling Fields and Tabs and the API
The user interface allows you to change the labels on some fields and tabs. Although you cannot relabel fields or tabs using the API, you
can retrieve the current values. To do so, issue a describeSObjects() call and inspect the label field of the returned
DescribeSObjectResult.

Tooling API Objects in the Enterprise WSDL
Some objects used by the Tooling API are included in the Enterprise and Partner WSDL. Use the objects from these WSDLs instead of
the Tooling WSDL if you need field-level security.
The following Tooling API objects are exposed in the Enterprise and Partner WSDL.
• DataType
• EntityDefinition
• EntityParticle
• FieldDefinition
• PicklistValueInfo
• Publisher
• SearchLayout
• Service
• ServiceDataType (Reserved for future use.)
• ServiceFieldDataType (Unavailable in version 35.0 and later. Do not use.)
• RelationshipDomain
• RelationshipInfo
• UserEntityAccess
• UserFieldAccess
• WsdlDataType (Reserved for future use.)
• XmlSchema (Reserved for future use.)
For more information, use the Tooling API Developer’s Guide.

Object Basics

Force.com AppExchange Object Prefixes and the API

Force.com AppExchange Object Prefixes and the API
If you have an unmanaged package and a managed package version becomes available, the API names of custom fields, custom objects,
and Scontrol objects in the package change. A namespace prefix is added to each component to make it unique: name__c becomes
prefix__name__c. To move from an unmanaged package to a managed package version of the same application, export your
data, uninstall the old package, and install the new package. Then review the name changes and import your data with the relevant
mapping. For details, see the ISVforce Guide.

Custom Objects
In the user interface, you can extend your organization’s data by defining custom objects. Custom objects are custom database tables
that allow you to store information unique to your organization. For custom objects, the custom flag—a Boolean field in the describe
results—is true.
Client applications with sufficient permissions can invoke API calls on existing custom objects. You can create custom objects with the
user interface, or by using the metadata WSDL with a client application or using the Force.com IDE. For more information about using
the metadata WSDL to create custom objects, see the Force.com Metadata API Developer's Guide. For more information about the Force.com
IDE, see Salesforce Developers.
Use the following topics to understand how the API interacts with custom objects and fields:
• Naming Conventions for Custom Objects
• Relationships Among Custom Objects
• Audit Fields for Custom Objects
• Sharing and Custom Objects
• Required Fields in Custom Objects
• Managed Packages and API Names

Naming Conventions for Custom Objects
Your Salesforce administrator defines an associated name field for each custom object during setup. Custom objects must have unique
names within your organization.
In the API, the names of custom objects include a suffix of two underscores followed by a lowercase “c” . For example, a custom object
labeled “Issue” in the Salesforce user interface is Issue__c in that organization’s WSDL.
Relationships change the naming convention. See Relationships Among Custom Objects for more information.
For a custom object record to appear in the Salesforce user interface, its name field must be populated. If you use the API to create a
custom object record that doesn’t have a name, the record’s ID is used as its name.

Relationships Among Custom Objects
Custom objects relate to other objects and behave just like standard objects, as described in Relationships Among Objects. For example,
cascading deletes are supported in custom objects in a Master-Detail relationship.
Custom objects require special treatment so that they can participate in Relationship Queries. For the relationship field name of a custom
object, __r is appended to the name to create the ID. Also, __c is appended to the name to create the parent object pointer. For
example, if the relationship field name is MyRel, the name of the ID becomes MyRelId__r, the parent object pointer becomes

Object Basics

Custom Objects

MyRel__c, and the relationship name is MyRel__r. For more information, see Understanding Relationship Names, Custom Objects,
and Custom Fields in the Salesforce SOQL and SOSL Reference Guide.

The following table summarizes whether a standard object can be:
• The master in a master-detail relationship with a custom object. Master-detail relationships involve cascading deletes and sharing
rules that the parent controls.
• The lookup in a lookup relationship on a custom object. In other words, whether a custom object can have a lookup to the standard
object.
• Extended with custom fields.
Standard Object

Master-Detail

Lookup

Custom Fields

Account

Yes

Campaign

Yes

Case

Yes

Contact

Yes

Contract

Yes

Event

Yes

Lead

Yes

Opportunity

Yes

Product2

Yes

Solution

Yes

Task

Yes

User

Yes

Custom objects can also have many-to-many relationships with other custom objects or standard objects. A many-to-many relationship
allows each record of one object to be linked to multiple records from another object and vice versa. For more information, see Relationships
Among Objects.

Audit Fields for Custom Objects
Custom objects can have the same audit fields as standard objects. When you create a custom object, the four audit fields, CreatedById,
CreatedDate, LastModifiedById, and LastModifiedDate, are created and populated for the object. These fields are
read only. If you import data into Salesforce custom objects and want to retain the audit field values from the source system, you can
set the values when you create the custom objects. The only audit field you cannot set a value for is systemModstamp. Your
organization must be API enabled, and you must have the “Modify All Data” permission.
1. From Setup, enter User Interface in the Quick Find box, then select User Interface under Customize.
2. Under Setup, select Enable “Set Audit Fields upon Record Creation” and “Update Records with Inactive Owners” User
Permissions.
3. In the permission set or profile that you want to set audit fields with, enable the permission Set Audit Fields upon Record Creation.
4. Using the API, create a record and set its audit fields.

Object Basics

External Objects

Note these restrictions:
• CreatedDate can't be greater than the LastModifiedDate.
• You can't set any date field to be greater than the current time.
For more information about audit fields, see System Fields.

Sharing and Custom Objects
A sharing rule object is created for each custom object that does not have a master-detail relationship to another object. They are similar
to standard object sharing rules, for example AccountOwnerSharingRule. If the user creating the custom object has the “Manage Sharing”
permission, a sharing rule object is automatically created for it.
Apex sharing reasons can be retrieved describing the custom object's sharing object, and examining the information in the rowCause
field. The name of a sharing object for each custom object is of the form: MyObjectName__Share, similar to AccountShare and other
standard object sharing objects.

Tags and Custom Objects
When a custom object is created, a Tag object related to it is also created. These object names are of the form: MyObjectName__Tag,
similar to AccountTag and other standard object tag objects.

Required Fields in Custom Objects
In the user interface, you can mark a custom field as required, and this rule is also enforced in the API. Each custom field has a
isRequired field, with a data type boolean. The default value is false. If set to true, each request supplies a value (or leaves
the current value) to this field. Otherwise, the request fails. When the value is set to true, the next time the field is edited or created,
the validation applies. If no value is supplied or default value specified, the request fails.
To edit the isRequired field, you must log in as a user with the “Customize Application” permission.
If you change a custom object field to be required in an existing client application or integration, be sure that a value is supplied for that
field. For example, if the custom picklist field Education Level on the contact object is required, supply a default value for that
custom field. If a required field does not have a specified or default value, an error with the status code REQUIRED_FIELD_MISSING
is returned.

Managed Packages and API Names
If you have an unmanaged package and a managed package version becomes available, the API names of custom fields, custom objects,
and Scontrol objects in the package change. A namespace prefix is added to each component to make it unique: name__c becomes
prefix__name__c. To move from an unmanaged package to a managed package version of the same application, export your
data, uninstall the old package, and install the new package. Then review the name changes and import your data with the relevant
mapping. For details, see the ISVforce Guide.

External Objects
External objects are supported in API version 32.0 and later. External objects are similar to custom objects, but external object record
data is stored outside your Salesforce organization. For example, perhaps you have data that’s stored on premises in an enterprise
resource planning (ERP) system. Instead of copying the data into your org, you can use external objects to access the data in real time
via web service callouts.

Object Basics

External Objects

External objects are available with Salesforce Connect and Files Connect. Each external object is associated with an external data source
definition in your Salesforce organization.
An external data source specifies how to access an external system. Salesforce Connect uses external data sources to access data that's
stored outside your Salesforce organization. Files Connect uses external data sources to access third-party content systems. External data
sources have associated external objects, which your users and the Force.com platform use to interact with the external data and content.
By accessing record data on demand, external objects always reflect the current state of the external data. You don't have to manage a
copy of that data in Salesforce, so you're not wasting storage and resources keeping data in sync.
External objects are best used when you have a large amount of data that you can’t or don’t want to store in your Salesforce organization,
and you only need to use a small amount of data at any one time.
See “Define External Objects” in the Salesforce Help for how to create and modify external objects.

Naming Conventions for External Objects
Object names must be unique across all standard, custom, and external objects in the org.
In the API, the names of external objects are identified by a suffix of two underscores immediately followed by a lowercase “x” character.
For example, an external object named “ExtraLogInfo” in the Salesforce user interface is seen as ExtraLogInfo__x in that
organization's WSDL.
We recommend that you make object labels unique across all standard, custom, and external objects in the org.

External Object Relationships
External objects support standard lookup relationships, which use the 18-character Salesforce record IDs to associate related records
with each other. However, data that’s stored outside your Salesforce org often doesn’t contain those record IDs. Therefore, two special
types of lookup relationships are available for external objects: external lookups and indirect lookups. See ”External Object Relationships”
in the Salesforce Help for details.

Feature Support for External Objects
Most of the Salesforce features that support custom objects also support external objects. However, there are exceptions, and some
features have special limitations and considerations for external objects. See the following topics in the Salesforce Help.
• Salesforce Compatibility Considerations for Salesforce Connect—All Adapters
• Considerations for Salesforce Connect—All Adapters

Salesforce Connect Adapters
Salesforce Connect uses a protocol-specific adapter to connect to an external system and access its data. This table describes the available
adapters.

Object Basics

External Objects

Salesforce
Connect
Adapter

Description

Where to Find Callout Limits

Cross-org

Uses the Force.com REST API to access data that’s stored No callout limits. However, each callout counts toward
in other Salesforce orgs.
the API usage limits of the provider org.
Salesforce Help: API Usage Considerations for Salesforce
Connect—Cross-Org Adapter
Salesforce Limits Quick Reference Guide: API Requests Limits

OData 2.0
OData 4.0

Uses Open Data Protocol to access data that’s stored
outside Salesforce. The external data must be exposed
via OData producers.

Salesforce Help: General Limits for Salesforce
Connect—OData 2.0 and 4.0 Adapters

Custom adapter You use the Apex Connector Framework to develop your Apex Developer Guide: Callout Limits and Limitations
created via Apex own custom adapter when the other available adapters Apex Developer Guide: Execution Governors and Limits
aren’t suitable for your needs.
A custom adapter can obtain data from anywhere. For
example, some data can be retrieved from anywhere in
the Internet via callouts, while other data can be
manipulated or even generated programmatically.

For more information about Salesforce Connect, see “Salesforce Connect” in the Salesforce Help.
For details on using the Apex Connector Framework, see “Salesforce Connect” and “DataSource Namespace” in the Force.com Apex Code
Developer’s Guide.

CHAPTER 3
In this chapter ...

API Call Basics
API calls represent specific operations that your client applications can invoke at runtime to perform
tasks, for example:

•

Characteristics of API
Calls

•

Factors that Affect
Data Access

• Add, update, and delete data.

Package Version
Settings

• Run utilities to perform administration tasks.

•

• Query data in your organization.
• Obtain metadata about your data.
Using your development environment, you can construct Web service client applications that use
standard Web service protocols to programmatically:
• Log in to the login server (login()) and receive authentication information to be used for
subsequent calls
• Query your organization’s information (query(), queryAll(), queryMore(), and
retrieve() calls)
• Perform text searches across your organization’s information (search() call)
• Create, update, and delete data (create(), merge(), update(), upsert(), delete(),
and undelete() calls)
• Perform administrative tasks, such as retrieving user information (getUserInfo() call), changing
passwords (setPassword() and resetPassword() calls), and getting the system time
(getServerTimestamp() call)
• Replicate data locally (getDeleted() and getUpdated() calls)
• Obtain and navigate metadata about your organization’s data (describeGlobal(),
describeSObject(), describeSObjects(), describeLayout(), and
describeTabs() calls)
• Work with approval processes (process())
• Return category groups and categories from your organization
(describeDataCategoryGroups() and
describeDataCategoryGroupStructures()).
See Core Calls, Describe Calls, and Utility Calls for complete details about each call.

API Call Basics

Characteristics of API Calls

Characteristics of API Calls
All API calls are:
• Service Requests and Responses—Your client application prepares and submits a service request to the Force.com Web Service
via the API, the Force.com Web Service processes the request and returns a response, and the client application handles the response.
• Synchronous—Once the API call is invoked, your client application waits until it receives a response from the service. Asynchronous
calls are not supported.
• Committed Automatically Versus Rollback on Error—By default, every operation that writes to a Salesforce object is committed
automatically. This is analogous to the AUTOCOMMMIT setting in SQL. For create(), update(), and delete() calls that
attempt to write to multiple records for an object, the write operation for each record is treated as a separate transaction. For example,
if a client application attempts to create two new accounts, they’re created using mutually exclusive insert operations that succeed
or fail individually, not as a group.
For API version 20.0 and later, there is an AllOrNoneHeader header that allows a call to roll back all changes unless all records are
processed successfully. This header is supported by the create(), delete(), undelete(), update(), and upsert()
calls.
Note: The default behavior means that client applications may need to handle some failures: for example, if you create an
opportunity that has shipments (a custom object), and the opportunity line item gets created but the shipment creation fails, if
your business rules required all opportunities be created with shipment, your client application would need to roll back the
opportunity creation. The easiest way to do this is to use AllOrNoneHeader.

Factors that Affect Data Access
When using the API, the following factors affect access to your organization’s data:
Access
Your organization must be enabled for API access.
Objects may not be available until you contact Salesforce and request access. For example Territory is visible only if territory
management has been enabled in the application. Such requirements are in the “Usage” section for each object.
Sometimes a feature must be used once before objects related to it can be accessed with the API. For example, the recordTypeIds
is available only after at least one record type has been created for your organization in the user interface.
To investigate data access issues, you can start by inspecting the WSDL:
• Enterprise WSDL: The generated enterprise WSDL file contains all of the objects that are available to your organization. By using
the API, a client application can access objects that are defined in your enterprise WSDL file.
• Partner WSDL: When using the generated partner WSDL file, a client application can access objects that are returned in the
describeGlobal() call.
Object-Level and Field-Level Security
The API respects object-level and field-level security configured in the user interface. You can access objects and fields only if the
logged-in user's permissions and access settings allow such access. For example, fields that are not visible to a given user are not
returned in a query() or describeSObjects() call. Similarly, read-only fields can't be updated.
User Permissions
A user attempting to access the API must have the permission “API Enabled” selected. It’s selected by default.
Your client application logs in as a user called a logged-in user. The logged-in user's permissions grant or deny access to specific
objects and fields in your organization:

API Call Basics

Factors that Affect Data Access

• Read—Users can only view objects of this type.
• Create—Users can read and create objects of this type.
• Edit—Users can read and update objects of this type.
• Delete—Users can read, edit, and delete objects of this type.
User permissions do not affect field-level security. If field-level security specifies that a field is hidden, users with “Read” on that object
can view only those fields that are not hidden on the record. In addition, users with “Read” on an object can view only those records
that sharing settings allow. The one exception is the “Edit Read Only Fields” permission, which gives users the ability to edit fields
marked as read only via field-level security.
Sharing
For most API calls, data that is outside of the logged-in user’s sharing model is not returned. Users are granted the most permissive
access that is available to them, either through organization-wide defaults or manual record sharing, just as in the application.
User Permissions that Override Sharing
• View All—Users can view all records associated with this object, regardless of sharing settings.
• Modify All—Users can read, edit, delete, transfer, and approve all records associated with this object, regardless of sharing
settings.
• Modify All Data—users can read, edit, delete, transfer, and approve all records regardless of sharing settings. This permission
is not an object-level permission, unlike “View All” and “Modify All.”
To protect the security of your data, give the logged-in user only the permissions needed to successfully execute all the calls made
by the application. For large integration applications, “Modify All Data” may speed up call response times. If you are loading a large
number of records, use the Bulk API instead.
Related Objects
Some objects depend on other objects for permission. For example, AccountTeamMember follows sharing on the associated
permission-assigned object such as the Account record. Similarly, a Partner depends on the permissions in the associated .
Ownership changes to a record do not automatically cascade to related records. For example, if ownership changes for a given
Account, ownership does not then automatically change for any Contract associated with that Account—each ownership change
must be made separately and explicitly by the client application.
Object Properties
To create an object with the create() call, the object's createable attribute must be set to true. To determine what
operations are allowed on a given object, your client application can invoke the describeSObjects() call on the object and
inspect the properties in the DescribeSObjectResult.
Note: replicatable allowsgetUpdated() and getDeleted() calls.
Page Layouts and Record Types
Requirements defined in the Salesforce user interface for page layouts and record types are not enforced by the API:
• Page layouts can specify whether a given field is required, but the API does not enforce such layout-specific field restrictions or
validations in create() and update() calls. It’s up to the client application to enforce any such constraints, if applicable.
• Record types can control which picklist values can be chosen in a given record and which page layouts users with different
profiles can see. However, such rules that are configured and enforced in the user interface are not enforced in the API. For
example, the API does not validate whether the value in a picklist field is allowed per any record type restrictions associated with
the profile of the logged-in user. Similarly, the API does not prevent a client application from adding data to a particular field
simply because that field does not appear in a layout associated with the profile of the logged-in user.
Referential Integrity
To ensure referential integrity, the API forces or prevents certain behaviors:
• ID values in reference fields are validated in create() and update() calls.

API Call Basics

Package Version Settings

• If a client application deletes a record, then its children are automatically deleted as part of the call if the cascadeDelete
property on ChildRelationship for that child has a value of true. For example, if a client application deletes an Opportunity,
then any associated OpportunityLineItem records are also deleted. However, if an OpportunityLineItem is not deletable or is
currently being used, then deletion of the parent Opportunity fails. For example, if a client application deletes an Invoice_Statement,
then any associated Line_Item records are also deleted. However, if a Line_Item is not deletable or is currently being used, then
deletion of the parent Invoice_Statement fails. Use DescribeSObjectResult to view the ChildRelationship value if you want to be
sure what will be deleted.
There are certain exceptions that prevent the execution of a cascadeDelete. For example, you can't delete an account if
it has associated cases, if it has related opportunities that are owned by other users, or if associated contacts are enabled for the
Customer Portal. In addition, if you attempt to delete an account that has closed/won opportunities owned by you or has active
contracts, then the delete request for that record will fail.

Package Version Settings
When your API client is referencing components in managed packages, you can specify the version of each installed package that you
want to reference for your integration. This allows your API client to continue to function with specific, known behavior even when you
install subsequent versions of a package. You can use the PackageVersionHeader SOAP header to set different package versions for
different calls, if necessary.
A package version is a number that identifies the set of components uploaded in a package. The version number has the format
majorNumber.minorNumber.patchNumber (for example, 2.1.3). The major and minor numbers increase to a chosen value
during every major release. The patchNumber is generated and updated only for a patch release. Publishers can use package versions
to evolve the components in their managed packages gracefully by releasing subsequent package versions without breaking existing
customer integrations using the package.
Default package versions for API calls provide fallback settings if package versions are not provided by an API call. Many API clients do
not include package version information, so the default settings maintain existing behavior for these clients.
You can specify the default package versions for enterprise API and partner API calls. The enterprise WSDL is for customers who want to
build an integration with their Salesforce organization only. It is strongly typed, which means that calls operate on objects and fields
with specific data types, such as int and string. The partner WSDL is for customers, partners, and ISVs who want to build an
integration that can work across multiple Salesforce organizations, regardless of their custom objects or fields. It is loosely typed, which
means that calls operate on name-value pairs of field names and values instead of specific data types.
You must associate the enterprise WSDL with specific package versions to maintain existing behavior for clients. There are options for
setting the package version bindings for an API call from client applications using either the enterprise or partner WSDL. The package
version information for API calls issued from a client application based on the enterprise WSDL is determined by the first match in the
following settings.
1. The PackageVersionHeader SOAP header.
2. The SOAP endpoint contains a URL with a format of serverName/services/Soap/c/api_version/ID where
api_version is the version of the API, such as 39.0, and ID encodes your package version selections when the enterprise WSDL
was generated.
3. The default enterprise package version settings.
The partner WSDL is more flexible as it is used for integration with multiple organizations. If you choose the Not Specified option for a
package version when configuring the default partner package versions, the behavior is defined by the latest installed package version.
This means that behavior of package components, such as an Apex trigger, could change when a package is upgraded and that change
would immediately impact the integration. Subscribers may want to select a specific version for an installed package for all partner API
calls from client applications to ensure that subsequent installations of package versions do not affect their existing integrations.
The package version information for partner API calls is determined by the first match in the following settings.

API Call Basics

Package Version Settings

1. The PackageVersionHeader SOAP header.
2. An API call from a Visualforce page uses the package versions set for the Visualforce page.
3. The default partner package version settings.
To configure default package versions for API calls:
1. From Setup, enter API in the Quick Find box, then select API.
2. Click Configure Enterprise Package Version Settings or Configure Partner Package Version Settings. These links are only
available if you have at least one managed package installed in your organization.
3. Select a Package Version for each of your installed managed packages. If you are unsure which package version to select,
you should leave the default selection.
4. Click Save.
Note: Installing a new version of a package in your organization does not affect the current default settings.

CHAPTER 4
In this chapter ...
•

Error Handling for
Session Expiration

•

More About Error
Handling

Error Handling
The API calls return error data that your client application can use to identify and resolve runtime errors.
If an error occurs during the invocation of most API calls, then the API provides the following types of
error handling:
• For errors resulting from badly formed messages, failed authentication, or similar problems, the API
returns a SOAP fault message with an associated ExceptionCode.
• For most calls, if the error occurs because of a problem specific to the query, the API returns an Error.
For example, if a create() request contains more than 200 objects.

Error Handling

Error Handling for Session Expiration

Error Handling for Session Expiration
When you sign on via the login() call, a new client session begins and a corresponding unique session ID is generated. Sessions
expire automatically after a predetermined length of inactivity, which can be configured in Salesforce from Setup by clicking Security
Controls. The default is 120 minutes (two hours). If you make an API call, the inactivity timer is reset to zero.
When your session expires, the exception code INVALID_SESSION_ID is returned. If this happens, you must invoke the login() call
again.

More About Error Handling
For more information about errors, see the following topics:
• API Fault Element
• ExceptionCode
• Error

CHAPTER 5
In this chapter ...
•

User Authentication

•

User Profile and
Permission Sets
Configuration

•

Security Token

•

Sharing

•

Implicit Restrictions
for Objects and Fields

•

API Access in
Force.com
AppExchange
Packages

•

Outbound Port
Restrictions

Security and the API
Client applications that access your organization's Salesforce data are subject to the same security
protections that are used in the Salesforce user interface. Additional protection is available for organizations
that install Force.com AppExchange managed packages if those packages contain components that
access Salesforce via the API.

Security and the API

User Authentication

User Authentication
Client applications must log in using valid credentials for an organization. The server authenticates these credentials and, if valid, provides
the client application with:
• a sessionId that must be set into the session header so that all subsequent calls to the Web service are authenticated
• a URL address (serverUrl) for the client application's Web service requests
Salesforce supports only the Transport Layer Security (TLS) protocol and frontdoor.jsp. Ciphers must have a key length of at least 128
bits.

User Profile and Permission Sets Configuration
An organization's Salesforce administrator controls the availability of various features and views by configuring profiles and permission
sets, and assigning users to them. To access the API (to issue calls and receive the call results), a user must be granted the “API Enabled”
permission. Client applications can query or update only those objects and fields to which they have access via the permissions of the
logged-in user.
To create, edit, or delete a profile, from Setup, enter Profiles in the Quick Find box, then select Profiles in the Salesforce user
interface. To create, edit, or delete a permission set, from Setup, enter Permission Sets in the Quick Find box, then select
Permission Sets.
Note: The Web services WSDL files return all available objects and fields for an organization.

Security Token
When users log in to Salesforce via the user interface, the API, or a desktop client such as Salesforce for Outlook, Connect Offline, Connect
for Office, or the Data Loader, Salesforce confirms that the login is authorized as follows.
1. Salesforce checks whether the user’s profile has login hour restrictions. If login hour restrictions are specified for the user’s profile,
any login outside the specified hours is denied.
2. If the user has the “Two-Factor Authentication for User Interface Logins” permission, Salesforce prompts the user for a second form
of authentication upon logging in. If the user’s account isn’t already connected to a mobile authenticator app such as Salesforce
Authenticator, Salesforce first prompts the user to connect the app.
3. If the user has the “Two-Factor Authentication for API Logins” permission and has connected an authenticator app to the account,
Salesforce returns an error if the user uses the standard security token. The user has to enter a verification code (time-based one-time
password) generated by the authenticator app instead.
4. Salesforce then checks whether the user’s profile has IP address restrictions. If IP address restrictions are defined for the user’s profile,
logins from an undesignated IP address are denied, and logins from a specified IP address are allowed. If the Enforce login IP ranges
on every request session setting is enabled, the IP address restrictions are enforced for each page request, including requests from
client applications.
5. If profile-based IP address restrictions are not set, Salesforce checks whether the user is logging in from a device used to access
Salesforce before.
• If the user’s login is from a device and browser that Salesforce recognizes, the login is allowed.
• If the user’s login is from an IP address in your org’s trusted IP address list, the login is allowed.
• If the user’s login is not from a trusted IP address or a device and browser Salesforce recognizes, the login is blocked.

Security and the API

Sharing

Whenever a login is blocked or returns an API login fault, Salesforce has to verify the user’s identity:
• For access via the user interface, the user is prompted to verify using Salesforce Authenticator (version 2 or later), or to enter a
verification code.
Note: Users aren’t asked for a verification code the first time they log in to Salesforce.
• For access via the API or a client, users must add their security token to the end of their password to log in. Or, if “Two-Factor
Authentication on API Logins” is set on the user profile, users enter a verification code generated by an authenticator app.
A security token is an automatically generated key from Salesforce. For example, if a user’s password is mypassword, and the
security token is XXXXXXXXXX, the user must enter mypasswordXXXXXXXXXX to log in. Or some client applications have a
separate field for the security token.
Users can obtain their security token by changing their password or resetting their security token via the Salesforce user interface.
When a user changes a password or resets a security token, Salesforce sends a new security token to the email address on the user’s
Salesforce record. The security token is valid until the user resets the security token, changes a password, or has a password reset.
Tip: Before you access Salesforce from a new IP address, we recommend that you get your security token from a trusted
network using Reset My Security Token.
For more information about tokens, see “Reset Your Security Token” in the Salesforce online help.
When a user's password is changed, the user's security token is automatically reset. The user will experience a blocked login until he or
she adds the automatically-generated security token to the end of his or her password or enters the new password after the administrator
adds their IP address to the organization's list of trusted IP addresses.
If Single Sign-On (SSO) is enabled for your organization, users who access the API or a desktop client cannot log in to Salesforce unless
their IP address is included on your organization's list of trusted IP addresses or on their profile, if their profile has IP address restrictions
set. Futhermore, the delegated authentication authority usually handles login lockout policies for users with the “Uses Single Sign-On”
permission. However, if the security token is enabled for your organization, then your organization's login lockout settings determine
the number of times a user can attempt to log in with an invalid security token before being locked out of Salesforce. For more information,
see “Setting Login Restrictions” and “Setting Password Policies” in the online help.

Sharing
In the Salesforce user interface, sharing refers to the act of granting read or write access to a user or group so that they can view or edit
a record owned by other users, if the default organization access levels do not otherwise permit such access. All API calls respect the
sharing model.
The following table describes the types of access levels.
API Value

Salesforce User
Interface Label

API Picklist Label

Description

None

Private

Only the record owner and Users above that role in
the hierarchy can view and edit the record.

Read

Read Only

All Users and Groups can view the record but not edit
it. Only the owner and users above that role in the
hierarchy can edit the record.

Edit

Read/Write

All Users and Groups can view and edit the record.

Security and the API

API Value

Implicit Restrictions for Objects and Fields

Salesforce User
Interface Label

API Picklist Label

Description

ReadEditTransfer Read/Write/Transfer Read/Write/Transfer All Users and Groups can view, edit, delete, and

transfer the record. (Only available for cases and leads
as an organization-wide default setting.)
All

Full Access

ControlledByParent Controlled by
Parent

Owner

All Users and Groups can view, edit, transfer, delete,
and share the record. (Only available for campaigns
as an organization-wide default setting.)

Controlled By
Parent

(Contacts only.) All Users and Groups can perform an
action (such as view, edit, or delete) on the contact
based on whether he or she can perform that same
action on the record associated with it.

Not all access levels are available for every object. See the Fields table for each object to learn which access levels are available, as well
as other sharing details specific to that object.
For more information about sharing in general, see the Salesforce online help.
Note: In the API, you can create and update objects such as AccountShare and OpportunityShare that define sharing entries for
records.

Implicit Restrictions for Objects and Fields
Certain objects can be created or deleted only in the Salesforce user interface. Other objects are read-only—client applications cannot
create(), delete(), or update() such objects. Similarly, certain fields within some objects can be specified on create()
but not on update(). Other fields are read-only—client applications cannot specify field values in create() or update() calls.
For more information, see the respective object descriptions in Object Basics.

API Access in Force.com AppExchange Packages
The API allows access to objects and calls based on the permissions of the user who logs into the API. To prevent security issues from
arising when installed packages have components that access data via the API, Salesforce provides additional security:
• When a developer creates an AppExchange package with components that access the API, the developer can restrict the API access
for those components.
• When an administrator installs an AppExchange package, the administrator can accept or reject the access. Rejecting the access
cancels the installation.
• After an administrator installs a package, the administrator can restrict the API access of components in the package that access the
API.
Editing API access for a package is done in the Salesforce user interface. For more information, see “Manage API and Dynamic Apex
Access in Packages” in the Salesforce online help.
API access for a package affects the API requests originating from components within the package; it determines the objects that the
API requests can access. If the API access for a package is not defined, then the objects that the API requests have access to are determined
by the user's permissions.

Security and the API

API Access in Force.com AppExchange Packages

The API access for a package never allows users to do more than the permissions granted to the user. API access in a package only
reduces what the user's permissions allow.
Choosing Restricted for the API Access setting in a package affects the following:
• API access in a package overrides the following user permissions:
– Author Apex
– Customize Application
– Edit HTML Templates
– Edit Read Only Fields
– Manage Billing
– Manage Call Centers
– Manage Categories
– Manage Custom Report Types
– Manage Dashboards
– Manage Letterheads
– Manage Package Licenses
– Manage Public Documents
– Manage Public List Views
– Manage Public Reports
– Manage Public Templates
– Manage Users
– Transfer Record
– Use Team Reassignment Wizards
– View Setup and Configuration
– Weekly Export Data
• If Read, Create, Edit, and Delete access are not selected in the API access setting for objects, users do not have access to
those objects from the package components, even if the user has the “Modify All Data” and “View All Data” permissions.
• A package with Restricted API access can’t create new users.
• Salesforce denies access to Web service and executeanonymous requests from an AppExchange package that has
Restricted access.
The following considerations also apply to API access in packages:
• Workflow rules and Apex triggers fire regardless of API access in a package.
• If a component is in more than one package in an organization, API access is unrestricted for that component in all packages in the
organization regardless of the access setting.
• If Salesforce introduces a new standard object after you select restricted access for a package, access to the new standard object is
not granted by default. You must modify the restricted access setting to include the new standard object.
• When you upgrade a package, changes to the API access are ignored even if the developer specified them. This ensures that the
administrator installing the upgrade has full control. Installers should carefully examine the changes in package access in each
upgrade during installation and note all acceptable changes. Then, because those changes are ignored, the administrator should
manually apply any acceptable changes after installing an upgrade.

Security and the API

Outbound Port Restrictions

• S-controls are served by Salesforce and rendered inline in Salesforce. Because of this tight integration, there are several means by
which an s-control in an installed package could escalate its privileges to the user’s full privileges. In order to protect the security of
organizations that install packages, s-controls have the following limitations:
– For packages you are developing (that is, not installed from AppExchange), you can only add s-controls to packages with the
default Unrestricted API access. Once a package has an s-control, you cannot enable Restricted API access.
– For packages you have installed, you can enable access restrictions even if the package contains s-controls. However, access
restrictions provide only limited protection for s-controls. Salesforce recommends that you understand the JavaScript in an
s-control before relying on access restriction for s-control security.
– If an installed package has Restricted API access, upgrades will be successful only if the upgraded version does not contain
any s-controls. If s-controls are present in the upgraded version, you must change the currently installed package to
Unrestricted API access.
To manage API access to packages, see “Manage API and Dynamic Apex Access in Packages” in the Salesforce online help.
Note: XML-RPC requests that originate from restricted packages will be denied access.

Outbound Port Restrictions
For security reasons, Salesforce restricts the outbound ports you may specify to one of the following:
• 80: This port only accepts HTTP connections.
• 443: This port only accepts HTTPS connections.
• 1024–66535 (inclusive): These ports accept HTTP or HTTPS connections.
The port restriction applies to any feature where a port is specified, for example outbound messages, AJAX proxy, or single-sign on.

CHAPTER 6
In this chapter ...
•

Obtaining the Partner
WSDL File

•

Calls and the Partner
WSDL

•

Objects, Fields, and
Field Data and the
Partner WSDL

•

Queries and the
Partner WSDL

•

Namespaces in the
Partner WSDL

•

Package Versions
and the Partner
WSDL

•

User Interface
Themes

•

Examples Using the
Partner WSDL

Using the Partner WSDL
The API provides two WSDLs to choose from:
• Enterprise Web Services WSDL—Used by enterprise developers to build client applications for a
single Salesforce organization. The enterprise WSDL is strongly typed, which means that it contains
objects and fields with specific data types, such as int and string. Customers who use the
enterprise WSDL document must download and re-consume it when changes are made to the
custom objects or fields in their org or when they want to use a different version of the API. To access
the current WSDL for your organization, log in to your Salesforce organization and from Setup, enter
Generate Enterprise WSDL in the Quick Find box, then select Generate Enterprise
WSDL.
• Partner Web Services WSDL—Used for client applications that are metadata-driven and dynamic
in nature. It is particularly—but not exclusively—useful to Salesforce partners who are building
client applications for multiple organizations. As a loosely typed representation of the Salesforce
data model that works with name-value pairs of field names and values instead of specific data types,
it can be used to access data within any organization. This WSDL is most appropriate for developers
of clients that can issue a query call to get information about an object before the client acts on the
object. The partner WSDL document needs to be downloaded and consumed only once per version
of the API. To access the current WSDL for your organization, log in to your Salesforce organization
and from Setup, enter Generate Partner WSDL in the Quick Find box, then select
Generate Partner WSDL.
In general, the enterprise WSDL is more straightforward to use, while the partner WSDL is more flexible
and dynamically adaptable to different organizations, allowing you to write a single application that can
be used for multiple users and multiple organizations.

Using the Partner WSDL

Obtaining the Partner WSDL File

Obtaining the Partner WSDL File
To use the partner WSDL, download a copy of the file using either of the following methods:
• Obtain it from your organization’s Salesforce administrator, or
• Generate from Setup in Salesforce (enter API in the Quick Find box, then select API) according to the instructions in Step 2:
Generate or Obtain the Web Service WSDL.
While the enterprise WSDL file needs to be regenerated whenever custom fields or custom objects are added to an organization’s
Salesforce information, the partner WSDL file remains the same regardless of underlying changes in the organization’s Salesforce data.

Calls and the Partner WSDL
The partner WSDL file defines exactly the same API calls found in the enterprise WSDL file. A client application using the partner WSDL
will likely use the following API calls to determine an organization’s metadata:
Task / Call

Description

describeGlobal()

Retrieves a list of available objects for your organization’s data.

describeLayout()

Retrieves metadata about page layouts for the specified object type.

describeSObject()

describeSObject() has been superseded by describeSObjects().

describeSObjects()

Use to obtain metadata for a given object. You can first call to retrieve a list of all objects for your
organization, then iterate through the list and use to obtain metadata about individual objects.

describeTabs()

In the user interface, users have access to standard apps (and may also have access to custom apps)
as listed in the Force.com app menu at the top of the page. Selecting a standard app or custom app
in the user interface allows the user to switch between the listed apps at any time.

To explore an organization’s metadata, a client application can:
1. Call describeGlobal() to obtain a list of available objects.
2. In the returned DescribeGlobalResult object, retrieve an array of DescribeGlobalSObjectResult objects by calling sobjects.
3. Get the sObject type name for each returned sObject by calling name on the DescribeGlobalSObjectResult objects.
4. The DescribeGlobalSObjectResult object provides some metadata about the sObject, such as whether the sObject is createable or
updateable. If you want to get more information about particular sObjects, like their fields and child relationships, call
describeSObjects() by passing it an array of the sObject type names that you’re interested in obtaining more information
about.

sObject Reference Reuse
An sObject reference can't be reused within a single operation.
Use a different reference. For example, the following code snippet creates an account and contact with a custom field and an event
using two different references:
SObject account = new com.sforce.soap.partner.sobject.wsc.SObject();
account.setType("Account");

Using the Partner WSDL

Objects, Fields, and Field Data and the Partner WSDL

account.setField("Name","myAccount");
account.setField("XID1__c", "1");
SObject refAcc1 = new com.sforce.soap.partner.sobject.wsc.SObject();
refAcc1.setType("Account");
refAcc1.setField("XID1__c", "1");
SObject refAcc2 = new com.sforce.soap.partner.sobject.wsc.SObject();
refAcc2.setType("Account");
refAcc2.setField("XID1__c", "1");
SObject contact = new com.sforce.soap.partner.sobject.wsc.SObject();
contact.setType("Contact");
contact.setField("LastName", "LName");
contact.setField( "XID2__c", "2");
contact.setField( "Account", refAcc1);
SObject refCon = new com.sforce.soap.partner.sobject.wsc.SObject();
contact.setType("Contact");
contact.setField( "XID2__c", "2");

SObject event = new com.sforce.soap.partner.sobject.wsc.SObject();
contact.setType("Event");
contact.setField("Subject", "myEvent");
contact.setField( "ActivityDateTime", Calendar.getInstance());
contact.setField("DurationInMinutes", 60);
contact.setField("Who", refCon);
contact.setField("What", refAcc2);
client.create(new SObject[] { account, contact, event}); // exception thrown here

Any call that takes a parameter of the form sObject[] sObjects is subject to this limitation.

Objects, Fields, and Field Data and the Partner WSDL
The enterprise WSDL file defines all the specific objects (such as Account and Contact) in a Salesforce org. In contrast, the partner WSDL
file defines a single, generic object (sObject) that represents all the objects. For a particular object, its type is defined in the name field
in the returned DescribeSObjectResult.
With the partner WSDL, your client application code handles fields as arrays of name-value pairs that represent the field data. When
referring to the name of an individual field, use the value in its name field of the Field type in the DescribeSObjectResult.
Languages vary in the way they handle name-value pairs and map typed values to the primitive XML data types defined in SOAP
messages. With the enterprise WSDL, the mapping is handled implicitly. With the partner WSDL, however, you manually manage values
and data types when building client applications. Specify the object type before you assign field values. When specifying the value of a
particular field, use a value that is valid for the field (range, format, and data type). Make sure that you understand the mapping between
data types in your programming language and XML primitive data types. See SOAPType for more information.

Queries and the Partner WSDL
When using the query() call with the partner WSDL, consider the following guidelines:
• The queryString parameter is case-insensitive. The API will accept field names in the fieldList using any combination of uppercase
and lowercase letters. However, in the QueryResult, the case of field names (both predefined and custom fields) will match exactly

Using the Partner WSDL

Namespaces in the Partner WSDL

the value in the name field of the Field type in the DescribeSObjectResult. It is recommended that you use the proper case when
specifying fields in the fieldList.
• For the partner WSDL, the ordering of fields in the QueryResult is determined by the field order in the fieldList, not the field order in
the WSDL file.
• The fieldList cannot contain duplicate field names. For example:
– Invalid (returns an error): "SELECT Firstname, Lastname, Firstname FROM User"
– Valid: "SELECT Firstname, Lastname FROM User"
• The QueryResult always contains all of the fields specified in the fieldList, even if some of the fields contain no data (null). Although
SOAP allows you to omit fields that contain no values in the result set, the API always returns an array containing all fields.
• If you use the partner WSDL, a query that includes ID will return the ID field twice in the SOAP XML response data. Similarly, a query
that does not include ID will return a single null ID field in the SOAP XML response data. For example, a query for SELECT ID,
FirstName, LastName FROM Contact might return a SOAP XML response with records like:

Contact
0038000000FrjoBQRW
0038000000FrjoBQRW
John
Smith

This is expected behavior and something to be aware of if you are accessing the full SOAP XML response data and not using WSC
to access the web service response.

Namespaces in the Partner WSDL
In XML, every tag has a defined namespace. In the enterprise.wsdl, namespaces are handled implicitly. When using API calls
with the partner WSDL, however, you need to explicitly specify the correct namespaces for API calls, objects, and fields, and faults. This
rule applies to predefined and custom objects and fields.
For

Namespace

API Calls

urn:partner.soap.sforce.com

sObjects

urn:sobject.partner.soap.sforce.com

Fields

urn:sobject.partner.soap.sforce.com

Faults

urn:fault.partner.soap.sforce.com

Package Versions and the Partner WSDL
The partner WSDL is loosely typed. This makes it more flexible for partners who want to integrate with multiple organizations. Default
package versions for API calls provide fallback settings if package versions are not provided by an API call.
The behavior of a package in partner API calls is defined by the latest installed package version if the default value (Not Specified)
is selected for the installed package. This means that behavior of package components, such as an Apex trigger, could change when a
package is upgraded and that change would immediately impact the integration. Subscribers may want to select a specific version for

Using the Partner WSDL

User Interface Themes

an installed package for all partner API calls from client applications to ensure that subsequent installations of package versions do not
affect their existing integrations.
An API client developer should communicate with the administrator of the default partner package version settings if these are two
different roles in your organization and the developer recommends changing the settings. Alternatively, an API client developer can set
the package versions in the PackageVersionHeader SOAP header for the client.
A partner that is developing a package that references another package should always supply version information for the base package
in their partner API calls. This ensures that the extension package is not affected by a component being deprecated in the base package.
The package version information for partner API calls is determined by the first match in the following settings.
1. The PackageVersionHeader SOAP header.
2. An API call from a Visualforce page uses the package versions set for the Visualforce page.
3. The default partner package version settings.
To configure default package versions for API calls with the partner WSDL, see Package Version Settings.

User Interface Themes
Back in the Winter ’06 release, Salesforce started supporting multiple user interface themes, allowing
you to use different sets of icons and colors for the user interface. But these user interface themes
do not apply when your org is using Lightning Experience.
Two user interface themes match the earlier iterations of Salesforce.

EDITIONS
Available in: Salesforce
Classic and earlier

• Theme3—The “Salesforce Classic 2010 user interface theme.” This interface was previously
referred to as “Salesforce” or “new user interface theme.” You might also be familiar with it as
the Salesforce Aloha interface.
• Theme2—The “Salesforce Classic 2005 user interface theme.” This interface was previously referred to as “Salesforce Classic” or the
“classic user interface theme.”
The getUserInfo() call returns a getUserInfoResult object, which includes the userUiSkin property. This property
informs you of the user’s current user interface theme.
Use the describeQuickActions(), describeTabs(), and describeTheme() calls and their return types to get
information on theme icons and colors.
Style sheets are available to mimic the look and feel of the older user interfaces. For more information, see Styling Visualforce Pages in
the Visualforce Developer's Guide. But if you’re planning to switch to Lightning Experience, consider the Lightning Component framework,
our new UI framework. See the “Lightning Components” module in the Developer Trail - Lightning Experience Trailhead trail to learn
more.

Examples Using the Partner WSDL
This section includes examples in Java and C# for making API calls using the partner WSDL. Before running these samples, perform the
following steps in the quick start tutorial to get the partner WSDL file and generate the proxy client code for your development environment.
• Step 2: Generate or Obtain the Web Service WSDL
• Step 3: Import the WSDL File Into Your Development Platform
After you generate the proxy client code and set up your development environment, you can start writing your client application. First,
your application needs to log into the Salesforce service using the partner authentication endpoint. After a successful login, you can
execute the sample methods.

Using the Partner WSDL

Examples Using the Partner WSDL

For your convenience, template classes are provided, one in Java and one in C#, that make a login call. You can use them to execute the
sample methods provided later in this section.
Sample template class for Java: This sample prompts the user to enter the username, password, and authentication endpoint. Next,
it logs the user in. For the authentication endpoint URL, pass in the endpoint found in the partner WSDL file.
import
import
import
import
import
import
import
import
import
import
import

com.sforce.soap.partner.PartnerConnection;
com.sforce.soap.partner.sobject.*;
com.sforce.soap.partner.*;
com.sforce.ws.ConnectorConfig;
com.sforce.ws.ConnectionException;
com.sforce.soap.partner.Error;
java.io.FileNotFoundException;
java.io.IOException;
java.io.InputStreamReader;
java.io.BufferedReader;
java.util.*;

public class PartnerSamples {
PartnerConnection partnerConnection = null;
private static BufferedReader reader =
new BufferedReader(new InputStreamReader(System.in));
public static void main(String[] args) {
PartnerSamples samples = new PartnerSamples();
if (samples.login()) {
// Add calls to the methods in this class.
// For example:
// samples.querySample();
}
}
private String getUserInput(String prompt) {
String result = "";
try {
System.out.print(prompt);
result = reader.readLine();
} catch (IOException ioe) {
ioe.printStackTrace();
}
return result;
}
private boolean login() {
boolean success = false;
String username = getUserInput("Enter username: ");
String password = getUserInput("Enter password: ");
String authEndPoint = getUserInput("Enter auth end point: ");
try {
ConnectorConfig config = new ConnectorConfig();
config.setUsername(username);
config.setPassword(password);
config.setAuthEndpoint(authEndPoint);

Using the Partner WSDL

Examples Using the Partner WSDL

config.setTraceFile("traceLogs.txt");
config.setTraceMessage(true);
config.setPrettyPrintXml(true);
partnerConnection = new PartnerConnection(config);
success = true;
} catch (ConnectionException ce) {
ce.printStackTrace();
} catch (FileNotFoundException fnfe) {
fnfe.printStackTrace();
}
return success;
}
//
// Add your methods here.
//
}

Sample template class for C#: This sample prompts the user to enter the username and password. Next, it logs the user in. The project
name for this sample is assumed to be TemplatePartner and the Web reference name sforce. If these values are different for
your project, make sure to change the using directive to appropriate values for your project: using
your_project_name.web_reference_name;.
using
using
using
using
using
using
using

System;
System.Collections.Generic;
System.Linq;
System.Text;
System.Web.Services.Protocols;
System.Collections;
TemplatePartner.sforce;

namespace TemplatePartner
{
class PartnerSamples
{
private SforceService binding;
static void Main(string[] args)
{
PartnerSamples samples = new PartnerSamples();
if (samples.login())
{
// Add calls to the methods in this class.
// For example:
// samples.querySample();
}
}
private bool login()
{
Console.Write("Enter username: ");

Using the Partner WSDL

Examples Using the Partner WSDL

string username = Console.ReadLine();
Console.Write("Enter password: ");
string password = Console.ReadLine();
// Create a service object
binding = new SforceService();
// Timeout after a minute
binding.Timeout = 60000;
// Try logging in
LoginResult lr;
try
{
Console.WriteLine("\nLogging in...\n");
lr = binding.login(username, password);
}
// ApiFault is a proxy stub generated from the WSDL contract when
// the web service was imported
catch (SoapException e)
{
// Write the fault code to the console
Console.WriteLine(e.Code);
// Write the fault message to the console
Console.WriteLine("An unexpected error has occurred: " + e.Message);
// Write the stack trace to the console
Console.WriteLine(e.StackTrace);
// Return False to indicate that the login was not successful
return false;
}
// Check if the password has expired
if (lr.passwordExpired)
{
Console.WriteLine("An error has occurred. Your password has expired.");
return false;
}
// Set the returned service endpoint URL
binding.Url = lr.serverUrl;
// Set the SOAP header with the session ID returned by
// the login result. This will be included in all
// API calls.
binding.SessionHeaderValue = new SessionHeader();
binding.SessionHeaderValue.sessionId = lr.sessionId;
// Return true to indicate that we are logged in, pointed
// at the right URL and have our security token in place.

Using the Partner WSDL

Sample query and queryMore Calls

return true;
}
//
// Add your methods here.
//
}

This partner WSDL samples are:
• Sample query and queryMore Calls
• Sample search Call
• Sample create Call
• Sample update Call

Sample query and queryMore Calls
The following Java and C# examples show usage of the query() and queryMore() calls for the partner WSDL. Each example sets
the batch size of the query to 250 items returned. It then performs a query call to get the first name and last name of all contacts and
iterates through the contact records returned. For each contact, it writes the contact’s first name and last name to the output, or only
the last name if the first name is null. Finally, if there are more items to be returned by the query, as indicated by a QueryResult.done
property value of false, it calls queryMore() to get the next batch of items, and repeats the process until no more records are
returned.
To execute the sample method, you can use the corresponding Java or C# template class provided in Examples Using the Partner WSDL.

Java Example
public void querySample() {
try {
// Set query batch size
partnerConnection.setQueryOptions(250);
// SOQL query to use
String soqlQuery = "SELECT FirstName, LastName FROM Contact";
// Make the query call and get the query results
QueryResult qr = partnerConnection.query(soqlQuery);
boolean done = false;
int loopCount = 0;
// Loop through the batches of returned results
while (!done) {
System.out.println("Records in results set " + loopCount++
+ " - ");
SObject[] records = qr.getRecords();
// Process the query results
for (int i = 0; i < records.length; i++) {
SObject contact = records[i];
Object firstName = contact.getField("FirstName");
Object lastName = contact.getField("LastName");
if (firstName == null) {
System.out.println("Contact " + (i + 1) +

100

Using the Partner WSDL

Sample query and queryMore Calls

": " + lastName
);
} else {
System.out.println("Contact " + (i + 1) + ": " +
firstName + " " + lastName);
}
}
if (qr.isDone()) {
done = true;
} else {
qr = partnerConnection.queryMore(qr.getQueryLocator());
}
}
} catch(ConnectionException ce) {
ce.printStackTrace();
}
System.out.println("\nQuery execution completed.");
}

C# Example
public void querySample()
{
try
{
QueryResult qr = null;
binding.QueryOptionsValue = new sforce.QueryOptions();
binding.QueryOptionsValue.batchSize = 250;
binding.QueryOptionsValue.batchSizeSpecified = true;
qr = binding.query("SELECT FirstName, LastName FROM Contact");
bool done = false;
int loopCount = 0;
while (!done)
{
Console.WriteLine("\nRecords in results set " +
Convert.ToString(loopCount++)
+ " - ");
// Process the query results
for (int i = 0; i < qr.records.Length; i++)
{
sforce.sObject con = qr.records[i];
string fName = con.Any[0].InnerText;
string lName = con.Any[1].InnerText;
if (fName == null)
Console.WriteLine("Contact " + (i + 1) + ": " + lName);
else
Console.WriteLine("Contact " + (i + 1) + ": " + fName
+ " " + lName);
}
if (qr.done)

101

Using the Partner WSDL

Sample search Call

done = true;
else
qr = binding.queryMore(qr.queryLocator);
}
}
catch (SoapException e)
{
Console.WriteLine("An unexpected error has occurred: " + e.Message +
" Stack trace: " + e.StackTrace);
}
Console.WriteLine("\nQuery execution completed.");
}

Sample search Call
The following Java and C# examples show how to use the search() call for the partner WSDL. Each example accepts a phone number
string value that is used in the SOQL query. The search call looks for phone fields that match the passed in phone value in all contacts,
leads, and accounts. Next, the example iterates through the returned search results that contain the matching records, adds them to
arrays, and writes their field values to the console. The record fields returned correspond to the fields specified in the SOQL query for
each record type.
To execute the sample method, you can use the corresponding Java or C# template class provided in Examples Using the Partner WSDL.

Java Example
public void searchSample(String phoneNumber) {
try {
// Example of phoneNumber format: 4155551212
String soslQuery =
"FIND {" + phoneNumber + "} IN Phone FIELDS " +
"RETURNING " +
"Contact(Id, Phone, FirstName, LastName), " +
"Lead(Id, Phone, FirstName, LastName)," +
"Account(Id, Phone, Name)";
// Perform SOSL query
SearchResult sResult = partnerConnection.search(soslQuery);
// Get the records returned by the search result
SearchRecord[] records = sResult.getSearchRecords();
// Create lists of objects to hold search result records
List contacts = new ArrayList();
List leads = new ArrayList();
List accounts = new ArrayList();
// Iterate through the search result records
// and store the records in their corresponding lists
// based on record type.
if (records != null && records.length > 0) {
for (int i = 0; i < records.length; i++){
SObject record = records[i].getRecord();
if (record.getType().toLowerCase().equals("contact")) {
contacts.add(record);
} else if (record.getType().toLowerCase().equals("lead")){

102

Using the Partner WSDL

Sample search Call

leads.add(record);
} else if (record.getType().toLowerCase().equals("account")) {
accounts.add(record);
}
}
// Display the contacts that the search returned
if (contacts.size() > 0) {
System.out.println("Found " + contacts.size() +
" contact(s):");
for (SObject contact : contacts) {
System.out.println(contact.getId() + " - " +
contact.getField("FirstName") + " " +
contact.getField("LastName") + " - " +
contact.getField("Phone")
);
}
}
// Display the leads that the search returned
if (leads.size() > 0) {
System.out.println("Found " + leads.size() +
" lead(s):");
for (SObject lead : leads) {
System.out.println(lead.getId() + " - " +
lead.getField("FirstName") + " " +
lead.getField("LastName") + " - " +
lead.getField("Phone")
);
}
}
// Display the accounts that the search returned
if (accounts.size() > 0) {
System.out.println("Found " +
accounts.size() + " account(s):");
for (SObject account : accounts) {
System.out.println(account.getId() + " - " +
account.getField("Name") + " - " +
account.getField("Phone")
);
}
}
} else {
// The search returned no records
System.out.println("No records were found for the search.");
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}

C# Example
public void searchSample(String phoneNumber)
{

103

Using the Partner WSDL

Sample search Call

try
{
// Example of phoneNumber format: 4155551212
String soslQuery =
"FIND {" + phoneNumber + "} IN Phone FIELDS " +
"RETURNING " +
"Contact(Id, Phone, FirstName, LastName), " +
"Lead(Id, Phone, FirstName, LastName)," +
"Account(Id, Phone, Name)";
// Perform SOSL query
SearchResult sResult = binding.search(soslQuery);
// Get the records returned by the search result
SearchRecord[] records = sResult.searchRecords;
// Create lists of objects to hold search result records
ArrayList contacts = new System.Collections.ArrayList();
ArrayList leads = new System.Collections.ArrayList();
ArrayList accounts = new System.Collections.ArrayList();
//
//
//
if
{

Iterate through the search result records
and store the records in their corresponding lists
based on record type.
((records != null) && (records.Length > 0))
for (int i = 0; i < records.Length; i++)
{
sObject record = records[i].record;
if (record.type.ToLower().Equals("contact"))
{
contacts.Add(record);
}
else if (record.type.ToLower().Equals("lead"))
{
leads.Add(record);
}
else if (record.type.ToLower().Equals("account"))
{
accounts.Add(record);
}
}
// Display the contacts that the search returned
if (contacts.Count > 0)
{
Console.WriteLine("Found " + contacts.Count + " contact(s):");
for (int i = 0; i < contacts.Count; i++)
{
sObject c = (sObject)contacts[i];
Console.WriteLine(c.Any[0].InnerText + " - " +
c.Any[2].InnerText + " " +
c.Any[3].InnerText + " - " + c.Any[1].InnerText);
}
}
// Display the leads that the search returned
if (leads.Count > 0)

104

Using the Partner WSDL

Sample create Call

{
Console.WriteLine("Found " + leads.Count
for (int i = 0; i < leads.Count; i++)
{
sObject l = (sObject)leads[i];
Console.WriteLine(l.Any[0].InnerText
l.Any[2].InnerText + " "
l.Any[3].InnerText + " }

+ " lead(s):");

+ " - " +
+
" + l.Any[1].InnerText);

}
// Display the accounts that the search returned
if (accounts.Count > 0)
{
Console.WriteLine("Found " + accounts.Count + " account(s):");
for (int i = 0; i < accounts.Count; i++)
{
sObject a = (sObject)accounts[i];
Console.WriteLine(a.Any[0].InnerText + " - " +
a.Any[2].InnerText + " - " +
a.Any[1].InnerText);
}
}
}
else
{
// The search returned no records
Console.WriteLine("No records were found for the search.");
}
}
catch (SoapException e)
{
Console.WriteLine("An unexpected error has occurred: " + e.Message +
" Stack trace: " + e.StackTrace);
}
}

Sample create Call
The following Java and C# examples show how to use the create() call for the partner WSDL. Each example creates a contact record
with several fields. It iterates through the results of the create call and checks whether the operation was successful or not. If the create
operation was successful, it writes the ID of the contact created to the console. Otherwise, it iterates through the errors and writes details
of each error to the console. In this case, the output of the example is the ID of the new contact.
To execute the sample method, you can use the corresponding Java or C# template class provided in Examples Using the Partner WSDL.

Java Example
public String createSample() {
String result = null;
try {
// Create a new sObject of type Contact
// and fill out its fields.
SObject contact = new SObject();

105

Using the Partner WSDL

Sample create Call

contact.setType("Contact");
contact.setField("FirstName", "Otto");
contact.setField("LastName", "Jespersen");
contact.setField("Salutation", "Professor");
contact.setField("Phone", "(999) 555-1234");
contact.setField("Title", "Philologist");
// Add this sObject to an array
SObject[] contacts = new SObject[1];
contacts[0] = contact;
// Make a create call and pass it the array of sObjects
SaveResult[] results = partnerConnection.create(contacts);
// Iterate through the results list
// and write the ID of the new sObject
// or the errors if the object creation failed.
// In this case, we only have one result
// since we created one contact.
for (int j = 0; j < results.length; j++) {
if (results[j].isSuccess()) {
result = results[j].getId();
System.out.println(
"\nA contact was created with an ID of: " + result
);
} else {
// There were errors during the create call,
// go through the errors array and write
// them to the console
for (int i = 0; i < results[j].getErrors().length; i++) {
Error err = results[j].getErrors()[i];
System.out.println("Errors were found on item " + j);
System.out.println("Error code: " +
err.getStatusCode().toString());
System.out.println("Error message: " + err.getMessage());
}
}
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
return result;
}

C# Example
public void createSample()
{
try
{
// Create a new sObject of type Contact
// and fill out its fields.
sObject contact = new sforce.sObject();
System.Xml.XmlElement[] contactFields = new System.Xml.XmlElement[6];

106

Using the Partner WSDL

Sample create Call

// Create the contact's fields
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
contactFields[0] = doc.CreateElement("FirstName");
contactFields[0].InnerText = "Otto";
contactFields[1] = doc.CreateElement("LastName");
contactFields[1].InnerText = "Jespersen";
contactFields[2] = doc.CreateElement("Salutation");
contactFields[2].InnerText = "Professor";
contactFields[3] = doc.CreateElement("Phone");
contactFields[3].InnerText = "(999) 555-1234";
contactFields[4] = doc.CreateElement("Title");
contactFields[4].InnerText = "Philologist";
contact.type = "Contact";
contact.Any = contactFields;
// Add this sObject to an array
sObject[] contactList = new sObject[1];
contactList[0] = contact;
// Make a create call and pass it the array of sObjects
SaveResult[] results = binding.create(contactList);
// Iterate through the results list
// and write the ID of the new sObject
// or the errors if the object creation failed.
// In this case, we only have one result
// since we created one contact.
for (int j = 0; j < results.Length; j++)
{
if (results[j].success)
{
Console.Write("\nA contact was created with an ID of: "
+ results[j].id);
}
else
{
// There were errors during the create call,
// go through the errors array and write
// them to the console
for (int i = 0; i < results[j].errors.Length; i++)
{
Error err = results[j].errors[i];
Console.WriteLine("Errors were found on item " + j.ToString());
Console.WriteLine("Error code is: " + err.statusCode.ToString());
Console.WriteLine("Error message: " + err.message);
}
}
}
}
catch (SoapException e)
{
Console.WriteLine("An unexpected error has occurred: " + e.Message +
" Stack trace: " + e.StackTrace);

107

Using the Partner WSDL

Sample update Call

}
}

Sample update Call
The following Java and C# examples show how to use the update() call for the Partner WSDL. Each example takes the ID of the
contact to update as an argument. It creates two sObject records of type Contact—one to hold the valid passed in ID and the other has
an invalid ID. Next, it sets a new phone number for the valid contact and null for the last name of the invalid contact. It then makes
the update call and iterates through the results. For a successful update operation, it writes the ID of the contact that got updated. For
a failed update operation, it writes the details of all returned errors to the console. In this case, the output is the ID of the contact that
was successfully updated and an error for the invalid contact update.
To execute the sample method, you can use the corresponding Java or C# template class provided in Examples Using the Partner WSDL.

Java Example
public void updateSample(String id) {
try {
// Create an sObject of type contact
SObject updateContact = new SObject();
updateContact.setType("Contact");
// Set the ID of the contact to update
updateContact.setId(id);
// Set the Phone field with a new value
updateContact.setField("Phone", "(415) 555-1212");
// Create another contact that will cause an error
// because it has an invalid ID.
SObject errorContact = new SObject();
errorContact.setType("Contact");
// Set an invalid ID on purpose
errorContact.setId("SLFKJLFKJ");
// Set the value of LastName to null
errorContact.setFieldsToNull(new String[] {"LastName"});
// Make the update call by passing an array containing
// the two objects.
SaveResult[] saveResults = partnerConnection.update(
new SObject[] {updateContact, errorContact}
);
// Iterate through the results and write the ID of
// the updated contacts to the console, in this case one contact.
// If the result is not successful, write the errors
// to the console. In this case, one item failed to update.
for (int j = 0; j < saveResults.length; j++) {
System.out.println("\nItem: " + j);
if (saveResults[j].isSuccess()) {
System.out.println("Contact with an ID of " +
saveResults[j].getId() + " was updated.");
}
else {

108

Using the Partner WSDL

Sample update Call

// There were errors during the update call,
// go through the errors array and write
// them to the console.
for (int i = 0; i < saveResults[j].getErrors().length; i++) {
Error err = saveResults[j].getErrors()[i];
System.out.println("Errors were found on item " + j);
System.out.println("Error code: " +
err.getStatusCode().toString());
System.out.println("Error message: " + err.getMessage());
}
}
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}

For more information about setFieldsToNull (or its equivalent in client tools other than WSC), see fieldsToNull and
Resetting Values to null.

C# Example
public void updateSample(String id) {
try
{
// Create an sObject of type contact
sObject updateContact = new sObject();
updateContact.type = "Contact";
// Set the ID of the contact to update
updateContact.Id = id;
// Set the Phone field to a new value.
// The Phone field needs to be created as an XML element.
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
System.Xml.XmlElement phoneField = doc.CreateElement("Phone");
phoneField.InnerText = "(415) 555-1212";
// Add the Phone field to the contact
updateContact.Any = new System.Xml.XmlElement[] {phoneField};
// Create another contact that will cause an error
// because it has an invalid ID.
sObject errorContact = new sObject();
errorContact.type = "Contact";
// Set an invalid ID on purpose
errorContact.Id = "SLFKJLFKJ";
// Set the value of LastName to null
errorContact.fieldsToNull = new String[] { "LastName" };
// Make the update call by passing an array containing
// the two objects.
SaveResult[] saveResults = binding.update(
new sObject[] {updateContact, errorContact});
// Iterate through the results and write the ID of

109

Using the Partner WSDL

Sample update Call

// the updated contacts to the console, in this case one contact.
// If the result is not successful, write the errors
// to the console. In this case, one item failed to update.
for (int j = 0; j < saveResults.Length; j++) {
Console.WriteLine("\nItem: " + j);
if (saveResults[j].success)
{
Console.WriteLine("Contact with an ID of " +
saveResults[j].id + " was updated.");
}
else
{
// There were errors during the update call,
// go through the errors array and write
// them to the console.
for (int i = 0; i < saveResults[j].errors.Length; i++) {
Error err = saveResults[j].errors[i];
Console.WriteLine("Errors were found on item " + j.ToString());
Console.WriteLine("Error code: " +
err.statusCode.ToString());
Console.WriteLine("Error message: " + err.message);
}
}
}
}
catch (SoapException e)
{
Console.WriteLine("An unexpected error has occurred: " + e.Message +
" Stack trace: " + e.StackTrace);
}
}

110

REFERENCE

CHAPTER 7

Data Model

The entity relationship diagrams (ERDs) for standard Salesforce objects in this section illustrate important relationships between objects.
Salesforce ERDs use crow’s foot notation. The following ERDs are available.
• Sales Objects—includes accounts, contacts, opportunities, leads, campaigns, and other related objects
• Task and Event Objects—includes tasks and events and their related objects
• Support Objects—includes cases and solutions and their related objects
• Salesforce Knowledge Objects—includes view and vote statistics, article versions, and other related objects
• Document, Note, and Attachment Objects—includes documents, notes, and attachments and their related objects
• User, Sharing, and Permission Objects—includes users, profiles, and roles
• Profile and Permission Objects—includes users, profiles, permission sets, and related permission objects
• Record Type Objects—includes record types and business processes and their related objects
• Product and Schedule Objects—includes opportunities, products, and schedules
• Sharing and Team Selling Objects—includes account teams, opportunity teams, and sharing objects
• Customizable Forecasting Objects—includes forecasts and related objects
• Forecasts Objects—includes objects for Collaborative Forecasts.
• Territory Management 2.0 Objects—includes territories and related objects associated with Territory Management 2.0
• Territory Management—includes territories and related objects
• Process Objects—includes approval processes and related objects
• Content Objects—includes content and libraries and their related objects
• Chatter Feed Objects—includes objects related to feeds
• Work.com Badge and Reward Objects—includes badge and reward objects
• Work.com Feedback and Performance Cycle Objects—includes feedback and performance cycle objects
Each ERD includes links to the topics that describe the fields in objects related to the diagram. The data model for your custom objects
depends on what you create.

111

Data Model

Sales Objects

SEE ALSO:
Standard Objects
Data Model

112

Data Model

Task and Event Objects

SEE ALSO:
Standard Objects
Data Model

113

Data Model

Support Objects

SEE ALSO:
Standard Objects
Data Model

114

Data Model

Document, Note, and Attachment Objects

SEE ALSO:
Standard Objects
Data Model

115

Data Model

User, Sharing, and Permission Objects

SEE ALSO:
Standard Objects
Data Model
Profile and Permission Objects

116

Data Model

Profile and Permission Objects

SEE ALSO:
Standard Objects
Data Model

117

Data Model

Record Type Objects

SEE ALSO:
Standard Objects
Data Model

118

Data Model

Product and Schedule Objects

Create a separate PricebookEntry for each currency and price combination.
SEE ALSO:
Standard Objects
Data Model

119

Data Model

Sharing and Team Selling Objects

SEE ALSO:
Standard Objects
Data Model

Customizable Forecasting Objects

SEE ALSO:
Standard Objects
Data Model

120

Data Model

Forecasts Objects

Forecasts Objects
Note: This information only applies to Collaborative Forecasts.

SEE ALSO:
Standard Objects
Data Model

Territory Management 2.0 Objects
Note: This information applies to Territory Management 2.0 only, not to previous versions of Territory Management.

121

Data Model

Territory Management 2.0 Objects

SEE ALSO:
Standard Objects
Data Model

122

Data Model

Territory Management

SEE ALSO:
Standard Objects
Data Model

123

Data Model

Process Objects

SEE ALSO:
Standard Objects
Data Model
Core Data Types Used in API Calls

124

Data Model

Content Objects

SEE ALSO:
Standard Objects
Data Model

ContentNote Objects
The ContentNote object represents notes created with the enhanced version of the Salesforce note-taking tool.

125

Data Model

Chatter Objects

SEE ALSO:
Standard Objects
Data Model

127

Data Model

Chatter Feed Objects

Standard Objects with Feeds
The following standard objects can have Chatter feeds: Account, Asset, Case, CollaborationGroup, Contact, ContentDocument, Contract,
Dashboard, DashboardComponent, Entitlement, Event, KnowledgeArticle, Lead, Opportunity, Product2, Quote, Report, ServiceContract,
Site, Solution, Task, Topic, User, WorkOrder, and WorkOrderLineItem.
SEE ALSO:
Standard Objects
Data Model

128

Data Model

Salesforce Knowledge Objects

SEE ALSO:
Standard Objects
Data Model

129

Data Model

Work.com Badge and Reward Objects

130

Data Model

Work.com Feedback and Performance Cycle Objects

SEE ALSO:
Standard Objects
Data Model

Work.com Feedback and Performance Cycle Objects

SEE ALSO:
Standard Objects
Data Model

131

CHAPTER 8

Standard Objects

This section provides a list of standard objects and their standard fields. Some fields may not be listed for some objects.
To see the system fields for each object, see System Fields.
To verify the complete list of fields for an object, you can use a describe call from the API, or inspect with an appropriate tool, for example,
inspecting the WSDL or using a schema viewer.
AcceptedEventRelation
Represents invitees with the status Accepted for a given event.
Account
Represents an individual account, which is an organization or person involved with your business (such as customers, competitors,
and partners).
AccountContactRelation
Represents a relationship between a contact and one or more accounts.
AccountCleanInfo
Stores the metadata Data.com Clean uses to determine an account record’s clean status. AccountCleanInfo helps you automate the
cleaning or related processing of account records.
AccountContactRole
Represents the role that a Contact plays on an Account.
AccountFeed
Represents a single feed item on an account record detail page. This object is available in API version 18.0 and later.
AccountHistory
Represents the history of changes to the values in the fields of an account. This object is available in versions 11.0 and later.
AccountOwnerSharingRule
Represents the rules for sharing an account with a User other than the owner.
AccountPartner
This read-only object represents a partner relationship between two Account objects. It is automatically created when a Partner
object is created for a partner relationship between two accounts.
AccountShare
Represents a sharing entry on an Account.
AccountTag
Associates a word or short phrase with an Account.
AccountTeamMember
Represents a User who is a member of an Account team.

132

Standard Objects

AccountTerritoryAssignmentRule
An account assignment rule that assigns accounts to territories based on account fields. Only available if territory management has
been enabled for your organization.
AccountTerritoryAssignmentRuleItem
A row of selection criteria for an AccountTerritoryAssignmentRule object. Only available if territory management has been enabled
for your organization.
AccountTerritorySharingRule
Represents the rules for sharing an Account within a Territory.
ActionLinkGroupTemplate
Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed
element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external
server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an
action link group and action links within the group are mutually exclusive. This object is available in API version 33.0 and later.
ActionLinkTemplate
Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed
element. Clicking an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external
server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. This object is available in API version
33.0 and later.
ActivityHistory
This read-only object is displayed in a related list of closed activities—past events and closed tasks—related to an object. It includes
activities for all contacts related to the object. ActivityHistory fields for phone calls are only available if your organization uses Salesforce
CRM Call Center.
AdditionalNumber
Represents an optional additional number for a call center. This additional number is visible in the call center's phone directory.
AgentWork
Represents a work assignment that’s been routed to an agent. This object is available in API version 32.0 and later.
AllowedEmailDomain
Represents an allowed email domain for users in your organization. You can define a whitelist to restrict the email domains allowed
in a user’s Email field. This object is available in API version 29.0 and later.
Announcement
Represents a Chatter group announcement. This object is available in API version 30.0 and later.
ApexClass
Represents an Apex class.
ApexComponent
Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as
and .
ApexLog
Represents a debug log, containing information about a transaction, including information about Apex, Visualforce, workflow and
validation rules. This object is available in API version 19.0 and later.
ApexPage
Represents a single Visualforce page.
ApexTestQueueItem
Represents a single Apex class in the Apex job queue. This object is available in API version 23.0 and later.

133

Standard Objects

ApexTestResult
Represents the result of an Apex test method execution. This object is available in API version 23.0 and later.
ApexTestResultLimits
Captures the Apex test limits used for a particular test method execution. An instance of this object is associated with each
ApexTestResult record. This object is available in API version 37.0 and later.
ApexTestRunResult
Contains summary information about all the test methods that were run in a particular Apex job. This object is available in API version
37.0 and later.
ApexTestSuite
Represents a suite of Apex classes to include in a test run. A TestSuiteMembership object associates each class with the suite. This
object is available in API version 36.0 and later.
ApexTrigger
Represents an Apex trigger.
AppMenuItem
Represents the organization’s default settings for items in the Force.com app menu or App Launcher.
Approval
Represents an approval request for a Contract.
Article Type__DataCategorySelection
A data category selection represents a data category that classifies an article. This object is available in API version 19.0 and later.
Article Type__Feed
Represents a single feed item in the feed displayed on the detail page for an article. This object is available in API version 20.0 and
later.
Asset
Represents an item of commercial value, such as a product sold by your company or a competitor, that a customer has purchased
and installed.
AssetFeed
Represents a single feed item in the feed displayed on the detail page for an asset record. This object is available in API version 18.0
and later.
AssetOwnerSharingRule
Represents the rules for sharing an Asset with users other than the owner. This object is available in API version 33.0 and later.
AssetShare
Represents a sharing entry on an Asset. This object is available in API version 33.0 and later.
AssetTag
Associates a word or short phrase with an Asset.
AssetTokenEvent
Represents an event associated with an asset token, such as token issuance and registration of a connected device as an Asset. This
object is available in API version 39.0 and later.
AssignedResource
Represents a service resource who is assigned to a service appointment. Assigned resources appear in the Assigned Resources related
list on service appointments. This object is available in API version 38.0 and later.
AssignmentRule
Represents an assignment rule associated with a Case or Lead.

134

Standard Objects

AsyncApexJob
Represents an individual Apex sharing recalculation job, a batch Apex job, a method with the future annotation, or a job that
implements Queueable.
AttachedContentDocument
This read-only object contains all ContentDocument objects associated with an object.
AttachedContentNote
This read-only object contains all ContentNote objects associated with an object. This object is available in API version 35.0 and later.
Attachment
Represents a file that a User has uploaded and attached to a parent object.
AuraDefinition
Represents a Lightning definition, such as component markup, a client-side controller, or an event. This object is available in API
version 32.0 and later.
AuraDefinitionBundle
Represents a Lightning definition bundle, such as a component or application bundle. A bundle contains a Lightning definition and
all its related resources. This object is available in API version 32.0 and later.
AuthConfig
Represents authentication options for a communityor custom domain that was created by using My Domain. This object is available
in API version 32.0 and later.
AuthConfigProviders
Represents an authentication provider that’s configured in an organization. This object is a child of the AuthConfig object. This object
is available in API version 32.0 and later.
AuthProvider
Represents an authentication provider in your org.
AuthSession
The AuthSession object represents an individual user session in your organization. This object is available in versions 29.0 and later.
BackgroundOperation
Represents a background operation in an asynchronous job queue. This object is available in API version 35.0 and later.
BackgroundOperationResult
Stores error messages generated when running Async SOQL queries or importing data into BigObjects using Bulk API. This is a
BigObject, available in API version 37.0 and later.
Bookmark
Represents a link between opportunities that share common information.
BrandTemplate
Letterhead for HTML EmailTemplate.
BusinessHours
Specifies the business hours of your support organization. Escalation rules are run only during these hours.
BusinessProcess
Represents a business process.
CallCenter
Represents a call center, which is a logical representation of a single computer-telephony integration (CTI) system instance in an
organization.

135

Standard Objects

Campaign
Represents and tracks a marketing campaign, such as a direct mail promotion, webinar, or trade show.
CampaignFeed
Represents a single feed item in the feed on a campaign record detail page. This object is available in API version 18.0 and later.
CampaignInfluence
Represents the association between a campaign and an opportunity in Customizable Campaign Influence. This object is available
in API version 37.0 and later.
CampaignInfluenceModel
This read-only object represents a campaign influence model in Customizable Campaign Influence. Use campaign influence models
to group CampaignInfluence records created by a specific set of triggers and workflows that you define. The Salesforce
influence model is the default model. This object is available in API version 37.0 and later.
CampaignMember
Represents the association between a campaign and either a lead or a contact.
CampaignMemberStatus
One or more member status values defined for a campaign.
CampaignOwnerSharingRule
Represents the rules for sharing a campaign with User records other than the owner or anyone above the owner in the role hierarchy.
CampaignShare
Represents a sharing entry on a Campaign.
CampaignTag
Associates a word or short phrase with a Campaign.
Case
Represents a case, which is a customer issue or problem.
CaseArticle
Represents the association between a Case and a KnowledgeArticle. This object is available in API version 20.0 and later.
CaseComment
Represents a comment that provides additional information about the associated Case.
CaseContactRole
Represents the role that a given Contact plays on a Case.
CaseFeed
Represents a single feed item in the feed displayed on the detail page for a case record. A case feed shows recent changes to a case
record for any fields that are tracked in feeds, and comments and posts about the record. It is a useful way to stay up-to-date with
changes to cases. This object is available in API version 18.0 and later.
CaseHistory
Represents historical information about changes that have been made to the associated Case.
CaseMilestone
Represents a milestone (required step in a customer support process) on a Case. This object is available in API version 18.0 and later.
CaseOwnerSharingRule
Represents the rules for sharing a case with users other than the owner.
CaseShare
Represents a sharing entry on a Case.

136

Standard Objects

CaseSolution
Represents the association between a Case and a Solution.
CaseStatus
Represents the status of a Case, such as New, On Hold, or In Process.
CaseTag
Associates a word or short phrase with a Case
CaseTeamMember
Represents a case team member, who works with a team of other users to help resolve a case.
CaseTeamRole
Represents a case team role. Every case team member has a role on a case, such as “Customer Contact” or “Case Manager.”
CaseTeamTemplate
Represents a predefined case team, which is a group of users that helps resolve a case.
CaseTeamTemplateMember
Represents a member on a predefined case team, which is a group of users that helps resolve cases.
CaseTeamTemplateRecord
The CaseTeamTemplateRecord object is a linking object between the Case and CaseTeamTemplate objects. To assign a predefined
case team to a case (customer inquiry), create a CaseTeamTemplateRecord record and point the ParentId to the case and the
TeamTemplateId to the predefined case team.
CategoryData
Represents a logical grouping of Solution records.
CategoryNode
Represents a tree of Solution categories.
CategoryNodeLocalization
When the Translation Workbench is enabled for your organization, the CategoryNodeLocalization object provides the translation of
the label of a solution category.
ChatterActivity
ChatterActivity represents the number of posts and comments made by a user and the number of comments and likes on posts
and comments received by the same user. This object is available in API version 23.0 and later.
ChatterAnswersActivity
Represents the reputation of a User in Chatter Answers communities. This object is available in API version 25.0 and later.
ChatterAnswersReputationLevel
Represents a reputation level within a Chatter Answers zone. This object is available in API version 26.0 and later.
ChatterConversation
Represents a private conversation in Chatter, consisting of messages that conversation members have sent or received. This object
is available in API version 23.0 and later.
ChatterConversationMember
Represents a member of a private conversation in Chatter. A member has either sent messages to or received messages from other
conversation participants. This object is available in API version 23.0 and later.
ChatterMessage
Represents a message sent as part of a private conversation in Chatter. This object is available in API version 23.0 and later.

137

Standard Objects

ClientBrowser
Represents a cookie added to the browser upon login, and also includes information about the browser application where the cookie
was inserted. This object is available in version 28.0 and later.
CollaborationGroup
Represents a Chatter group. This object is available in API version 19.0 and later.
CollaborationGroupFeed
Represents a single feed item on a Chatter group feed. A group feed shows posts and comments about the group. This object is
available in API version 19.0 and later.
CollaborationGroupMember
Represents a member of a Chatter group. This object is available in API version 19.0 and later.
CollaborationGroupMemberRequest
Represents a request to join a private Chatter group. This object is available in API version 21.0 and later.
CollaborationGroupRecord
Represents the records associated with Chatter groups.
CollaborationInvitation
Represents an invitation to join Chatter, either directly or through a group. This object is available in API version 21.0 and later.
CombinedAttachment
This read-only object contains all notes, attachments, Google Docs, documents uploaded to libraries in Salesforce CRM Content, and
files added to Chatter that are associated with a record.
Community (Zone)
Represents a zone that contains Idea or Question objects.
ConnectedApplication
Represents a connected app and its details; all fields are read-only.
Contact
Represents a contact, which is an individual associated with an account.
ContactCleanInfo
Stores the metadata Data.com Clean uses to determine a contact record’s clean status. Helps you automate the cleaning or related
processing of contact records. ContactCleanInfo includes a number of bit vector fields.
ContactFeed
Represents a single feed item in the feed on a contact record detail page. This object is available in API version 18.0 and later.
ContactHistory
Represents the history of changes to the values in the fields of a contact. This object is available in versions 11.0 and later.
ContactOwnerSharingRule
Represents the rules for sharing a contact with a User other than the owner.
ContactShare
Represents a list of access levels to a Contact along with an explanation of the access level. For example, if you have access to a
record because you own it, the ContactAccessLevel is All and RowCause is Owner.
ContactTag
Associates a word or short phrase with a Contact.

138

Standard Objects

ContentAsset
Represents a Salesforce file that has been converted to an asset file in a custom app inLightning Experience. Enables a Salesforce file
to be used for org setup and configuration purposes. Asset files can be packaged and referenced by other components. This object
is available in API version 38.0 and later.
ContentDistribution
Represents information about sharing a document externally. This object is available in API version 32.0 and later.
ContentDistributionView
Represents information about views of a shared document. This read-only object is available in API version 32.0 and later.
ContentDocument
Represents a document that has been uploaded to a library in Salesforce CRM Content or Salesforce Files.This object is available in
API versions 17.0 and later for Salesforce CRM Content. This object is available in API version 21.0 and later for Salesforce Files.
ContentDocumentFeed
Represents a single feed item associated with ContentDocument. A content document feed shows these content document changes:
creating a ContentDocument file and uploading a new ContentDocument. This object is available in versions 20.0 and later.
ContentDocumentHistory
Represents the history of a document. This object is available in versions 17.0 and later.
ContentDocumentLink
Represents the link between a Salesforce CRM Content document or Salesforce file and where it's shared. A file can be shared with
other users, groups, records, and Salesforce CRM Content libraries. This object is available in versions 21.0 and later for Salesforce
CRM Content documents and Salesforce Files.
ContentFolder
Represents a folder in a content library for adding files. This object is available in API version 34.0 and later.
ContentFolderItem
Represents a file (ContentDocument) or folder (ContentFolder) that resides in a ContentFolder in a ContentWorkspace. This object
is available in API version 35.0 and later.
ContentFolderLink
Defines the association between a library and its root folder. This object is available in API version 34.0 and later.
ContentFolderMember
Defines the association between a file and a folder. This object is available in API version 34.0 and later.
ContentHubItem
Represents a file or folder in a Files Connect external data source, such as Microsoft SharePoint or OneDrive for Business. This object
is available in API version 33.0 and later.
ContentHubRepository
Represents a Files Connect external data source such as Microsoft SharePoint or OneDrive for Business. This object is available in API
version 33.0 and later.
ContentNote
Represents a note in Salesforce. This object is available in API version 32.0 and later.
ContentVersion
Represents a specific version of a document in Salesforce CRM Content or Salesforce Files. This object is available in versions 17.0
and later for Salesforce CRM Content documents. This object is available in versions 20.0 and later for Salesforce Files.
ContentVersionHistory
Represents the history of a specific version of a document. This object is available in version 17.0 and later.

139

Standard Objects

ContentWorkspace
Represents a public library in Salesforce CRM Content. This object is available in versions 17.0 and later.
ContentWorkspaceDoc
Represents a link between a document and a public library in Salesforce CRM Content. This object is available in versions 17.0 and
later.
Contract
Represents a contract (a business agreement) associated with an Account.
ContractContactRole
Represents the role that a given Contact plays on a Contract.
ContractFeed
Represents a single feed item in the feed on the contract record detail page. This object is available in API version 18.0 and later.
ContractHistory
Represents the history of changes to the values in the fields of a contract.
ContractLineItem
Represents a Product2 in a ServiceContract (customer support agreement). This object is available in API version 18.0 and later.
ContractLineItemHistory
Represents the history of changes to the values in the fields on a ContractLineItem (items in a customer support agreement). This
object is available in API version 18.0 and later.
ContractStatus
Represents the status of a Contract, such as Draft, InApproval, Activated, Terminated, or Expired.
ContractTag
Associates a word or short phrase with a Contract.
CorsWhitelistEntry
Apex REST, Bulk API, Chatter REST API, Lightning API, Lightning Out, REST API, and Wave REST API support CORS (cross-origin resource
sharing). To access these APIs from JavaScript in a web browser, add the origin serving the script to the CORS whitelist.
CronJobDetail
Contains details about the associated scheduled job, such as the job’s name and type. This object is available in API version 29.0 and
later.
CronTrigger
Contains schedule information for a scheduled job. CronTrigger is similar to a cron job on UNIX systems. This object is available in
API version 17.0 and later.
CurrencyType
Represents the currencies used by an organization for which the multicurrency feature is enabled.
CustomBrand
Represents a custom branding and color scheme. This object is available in API version 28.0 and later.
CustomBrandAsset
Represents a branding element in a custom branding scheme. For example, a color, logo image, header image, or footer text. A
CustomBrandAsset can apply to a community or to an organization using Salesforce1. This object is available in API version 28.0 and
later.
Custom Metadata Type__mdt
Represents a custom metadata record. This object is available in API version 34.0 and later.

140

Standard Objects

Custom Object__Feed
Represents a single feed item on a custom object detail page. This object is available in API version 18.0 and later.
CustomPermission
Represents a permission created to control access to a custom process or app, such as sending email. This object is available in API
version 31.0 and later.
CustomPermissionDependency
Represents the dependency between two custom permissions when one custom permission requires that you enable another
custom permission. This object is available in API version 32.0 and later.
DandBCompany
Represents a Dun & Bradstreet® company record, which is associated with an account added from Data.com. This object is available
in API version 25.0 and later.
Dashboard
Represents a dashboard, which shows data from custom reports as visual components. Access is read-only. This object is available
in API version 20.0 and later.
DashboardComponent
Represents a dashboard component, which can be a chart, metric, table, or gauge on a dashboard. Access is read-only. This object
is available in API version 21.0 and later.
DashboardComponentFeed
Represents a single feed item in the feed displayed on a dashboard component. This object is available in API version 21.0 and later.
DashboardFeed
Represents a single feed item in the feed displayed on a dashboard. This object is available in API version 20.0 and later.
DashboardTag
Associates a word or short phrase with a Dashboard. This object is available in API version 20.0 and later.
DataAssessmentFieldMetric
Represents summary statistics for matched, blank, and differing fields in account records of an org compared to records in Data.com.This
object is available in API version 37.0 and later.
DataAssessmentMetric
Represents a summary of statistics for fields matched and unmatched in your account records with Data.com account records.This
object is available in API version 37.0 and later.
DataAssessmentValueMetric
Summarizes the number of fields matched for your account records with Data.com account records.This object is available in API
version 37.0 and later.
DatacloudCompany
Represents the fields for Data.com company records. This object is available in API version 30.0 or later.
DatacloudContact
The fields and properties for Data.com contact records. This object is available in API version 30.0 or later.
DatacloudDandBCompany
Represents a set of read-only fields that are used to return D&B company data from Data.com API calls. This object is available in API
version 30.0 or later.
DatacloudOwnedEntity
Represents fields in the DatacloudOwnedEntity object. The DatacloudOwnedEntity object tracks user-purchased records. This object
is available in API version 30.0 or later.

141

Standard Objects

DatacloudPurchaseUsage
Represents an object used to identify and track Data.com record purchases. This object is available in API version 30.0 or later.
DatacloudSocialHandle
Returns normalized URLs with userids for different social media used by Data.com contacts. The DatacloudSocialHandle object is a
child object of the DatacloudContact object.This object is available in API version 30.0 or later.
DatedConversionRate
Represents the dated exchange rates used by an organization for which the multicurrency and the effective dated currency features
are enabled.
DcSocialProfile
The DcSocialProfile object is a read-only object accessible only through the Data.com Social Key API. This object is available
in API version 32.0 or later.
DcSocialProfileHandle
The DcSocialProfileHandle object. a child object to DcSocialProfile, is a read-only object accessible only through
the Data.com Social Key API. The DcSocialProfileHandle object is a child object of the DcSocialProfile object.This
object is available in API version 32.0 or later.
DeclinedEventRelation
Represents invitees with the status Declined for a given event. This object is available in API versions 29.0 and later.
Division
A logical segment of your organization's data. For example, if your company is organized into different business units, you could
create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has
the Division permission enabled.
DivisionLocalization
When the Translation Workbench is enabled for your organization, the DivisionLocalization object provides the translation of the
label for a division.
Document
Represents a file that a user has uploaded. Unlike Attachment records, documents are not attached to a parent object.
DocumentAttachmentMap
Maps the relationship between an EmailTemplate and its attachment, which is stored as a Document.
DocumentTag
Associates a word or short phrase with a Document.
Domain
Read-only object that represents a custom Web address assigned to a site in your organization. This object is available in API version
26.0 and later.
DomainSite
Read-only junction object that joins together the Site and Domain objects. This object is available in API version 26.0 and later.
DuplicateRecordItem
Represents an individual record that’s part of a duplicate record set. Use this object to create custom report types.
DuplicateRecordSet
Represents a group of records that have been identified as duplicates. Each duplicate record set contains one or more duplicate
record items. Use this object to create custom report types.
DuplicateRule
Represents a duplicate rule for detecting duplicate records.

142

Standard Objects

EmailDomainKey
Represents a domain key for an organization’s domain, used to authenticate outbound email that Salesforce sends on the organization’s
behalf. This object is available in API version 28.0 and later.
EmailMessage
Represents an email in Salesforce.
EmailMessageRelation
Represents the relationship between an email and contacts, leads, and users. This object is available in API version 37.0 and later
EmailServicesAddress
An email service address.
EmailServicesFunction
An email service.
EmailStatus
Represents the status of email sent.
EmailTemplate
Represents a template for mass email, or email sent when the activity history related list of a record is modified.
EmbeddedServiceDetail
Represents a metadata catalog object that exposes fields from the underlying Embedded Service setup objects defined in each
EmbeddedServiceConfig deployment for guest users. Guest users don’t have direct access to the Embedded Service setup objects.
Available in API version 39.0 and later.
Entitlement
Represents the customer support an Account or Contact is eligible to receive. This object is available in API version 18.0 and later.
Entitlements may be based on an Asset, Product2, or ServiceContract.
EntitlementContact
Represents a Contact eligible to receive customer support via an Entitlement. This object is available in API version 18.0 and later.
EntitlementFeed
Represents a single feed item in the feed displayed on the detail page for an entitlement. An entitlement feed shows recent changes
to an entitlement record for any fields that are tracked in feeds, and comments and posts about the record. It's a useful way to stay
up-to-date with changes to entitlements. This object is available in API version 23.0 and later.
EntitlementHistory
Represents the changes to field values on an Entitlement. This object is available in API version 18.0 and later.
EntitlementTemplate
Represents predefined terms of customer support for a product (Product2). This object is available in API version 18.0 and later.
EntityHistory
Represents historical information about an object’s changed field values. This object is only available to users with the “View All Data”
permission. This object is unavailable beginning with API version 8.0. Use the object-specific History objects instead: CaseHistory,
ContractHistory, LeadHistory, OpportunityFieldHistory, OpportunityHistory ProcessInstanceHistory, QuantityForecastHistory,
RevenueForecastHistory, or SolutionHistory.
EntityMilestone
Represents a required step in a customer support process on a record. The Salesforce user interface uses the term “object milestone.”
This object is available in API version 37.0 and later.
EntitySubscription
Represents a subscription for a user following a record or another user. This object is available in API version 34.0 and later.

143

Standard Objects

EnvironmentHubMember
Represents a member organization in the Environment Hub. This object is available in API version 29.0 and later.
Event
Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities.
EventFeed
Represents a single feed item in the feed on an Event. This object is available in API version 20.0 and later.
EventLogFile
Represents event log files for event monitoring. This object is available in API version 32.0 and later.
Lightning Error Event Type
Lightning Error events represent errors that occurred during user interactions with Lightning Experience. This event type is available
in the EventLogFile object in API version 39.0 and later.
Lightning Interaction Event Type
Lightning Interaction events track user interactions with Lightning Experience. This event type is available in the EventLogFile object
in API version 39.0 and later.
Lightning Page View Event Type
Lightning Page View events represent information about the page on which the event occurred in Lightning Experience. This event
type is available in the EventLogFile object in API version 39.0 and later.
Lightning Performance Event Type
Lightning Performance events track trends in your Lightning Experience performance. This event type is available in the EventLogFile
object in API version 39.0 and later.
Login Event Type — LOGIN_STATUS Values
When users attempt to log in to your org, the success or failure of their login attempts is tracked in event log file data. Specifically,
the LOGIN_STATUS field in the Login event type contains the result of these login attempts. The data in LOGIN_STATUS can help
you determine whether your users’ login attempts were successful. This field is available in the Login event type in the EventLogFile
object in API version 39.0 and later.
EventRelation
Represents a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. This object lets you add
or remove invitees from an event and use the API to manage invitees’ responses to invitations. If Shared Activities is enabled,
EventRelation can also represent other objects that are related to an event. EventRelation does not support triggers, workflow, or
data validation rules.
EventTag
Associates a word or short phrase with an Event.
EventWhoRelation
Represents the relationship between an event and a lead or contacts. This derived object is a filtered version of the EventRelation
on page 993 object; that is, IsParent is true and IsWhat is false. It doesn’t represent relationships to invitees or to accounts,
opportunities, or other objects. This object is available in API versions 29.0 and later.
ExternalDataSource
Represents an external data source, which defines connection details for integration with data and content that are stored outside
the Salesforce org. This object is available in API version 27.0 and later.
ExternalDataUserAuth
Stores authentication settings for a Salesforce user to access an external system. The external system must be defined in an external
data source or a named credential that’s configured to use per-user authentication. This object is available in API version 27.0 and
later.

144

Standard Objects

FeedAttachment
Represents an attachment to a feed item, such as a file attachment or a link. Use FeedAttachment to add various attachments to
one feed item. This object is available in API version 36.0 and later.
FeedComment
Represents a comment added to a feed by a user. This object is available in API version 18.0 and later.
FeedItem
FeedItem represents an entry in the feed, such as changes in a record feed, including text posts, link posts, and content posts. This
object is available in API version 21.0 and later. This object replaces FeedPost.
FeedLike
Indicates that a user has liked a feed item. This object is available in API version 21.0 and later.
FeedPollChoice
Shows the choices for a poll posted in the feed. This object is available in API version 29.0 and later.
FeedPollVote
Shows how users voted on a poll posted in the feed. This object is available in API version 29.0 and later.
FeedPost
FeedPost represents the following types of changes in a record feed, such as AccountFeed: text posts, link posts, and content posts.
This object is available in API version 18.0 through 21.0. FeedPost is no longer available in later versions. Starting with API version
21.0, use FeedItem to represent text posts, link posts, and content posts in feeds.
FeedRevision
Holds the revision history of a specific feed item or comment, including a list of attributes that changed for each revision. This object
is available in API version 34.0 and later.
FeedTrackedChange
Represents an individual field change or set of field changes. A FeedTrackedChange is a child object of a record feed, such as
AccountFeed This object is available in API version 18.0 and later..
FieldHistoryArchive
Represents field history values for all objects that retain field history. FieldHistoryArchive is a BigObject, available only to
users with the “Retain Field History” permission. This object is available in API version 29.0 and later.
FieldPermissions
Represents the enabled field permissions for the parent PermissionSet. This object is available in API version 24.0 and later.
FiscalYearSettings
Settings to define a custom or standard fiscal year for your organization. This object has a parent-child relationship with the Period
object.
FlexQueueItem
Represents an asynchronous Apex job in the Apex flex queue. Provides information about the job type and flex queue position of
the AsyncApexJob. This object is available in API version 36.0 and later.
FlowInterview
Represents a flow interview. A flow interview is a running instance of a flow.
FlowInterviewOwnerSharingRule
Represents the rules for sharing a FlowInterview with users other than the owner. This object is available in API version 33.0 and
later.
FlowInterviewShare
Represents a sharing entry on a FlowInterview. This object is available in API version 33.0 and later.

145

Standard Objects

Folder
Represents a repository for a Document, EmailTemplate, Report, or Dashboard. Only one type of item can be contained in a folder.
FolderedContentDocument
Represents the relationship between a parent and child ContentFolderItem in a ContentWorkspace.
ForecastingAdjustment
This object represents an individual sales manager’s adjustment for a subordinate’s forecast via a ForecastingItem. Available in API
versions 26 and greater. This object is separate from the ForecastingOwnerAdjustment object, which represents forecast users’
adjustments of their own forecasts.
ForecastingFact
This is a read-only object linking a ForecastingItem with its opportunities, such as opportunities that share the same owner or forecast
category and have a closing date within the period of the forecasting item. Available in API versions 26 and greater.
ForecastingItem
This is a read-only object used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles.
The amounts users see include one of the following when forecasting in revenue: AmountWithoutAdjustments,
AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include
one of the following when forecasting in quantity: QuantityWithoutAdjustments,
QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API versions
26 and greater.
ForecastingOwnerAdjustment
This object represents an individual forecast user’s adjustment of their own forecast via a ForecastingItem. Available in API versions
33 and greater. This object is separate from the ForecastingAdjustment object, which represents managers’ adjustments of subordinates’
forecasts.
ForecastingQuota
This object represents an individual user’s quota for a specified time period. The “Manage Quotas” user permission is required for
creating, updating, or deleting quotas. (Users can only edit their subordinates’ quotas, not their own.) The “View All Forecasts”
permission is required to View any user's forecast, regardless of the forecast role hierarchy. Available in API versions 25 and greater.
Forecast managers can view the forecasts of subordinates who report to them in the forecast hierarchy.
ForecastingType
This object is used to identify the forecast type associated with ForecastingAdjustment,
ForecastingOwnerAdjustment, ForecastingQuota, ForecastingFact, and ForecastingItem objects.
Available in API versions 30.0 and greater.
ForecastingUserPreference
Represents the forecasting selections that a user has made, such as display options, date range, forecasting type, and currency.
ForecastShare
Represents the sharing of a customizable forecast at a given role and territory.
Goal
The Goal object represents the components of a goal such as its name, description, and status.
GoalFeed
Represents a single feed item in the feed displayed for a Goal record. The goal feed shows changes to a goal for fields that are tracked
in feeds, posts, and comments about the goal.
GoalHistory
This read-only object contains historical information about changes that have been made to the Goal object.

146

Standard Objects

GoalLink
Represents the relationship between two goals. This is a many-to-many relationship, meaning that each goal can link to many other
goals.
GoalShare
Represents a sharing entry on a Goal object.
GoogleDoc
Represents a link to a Google Document. This object is available in API version 14.0 and later.
Group
A set of User records.
GroupMember
Represents a User or Group that is a member of a public group.
HashtagDefinition
HashtagDefinition represents hashtag (#) topics in public Chatter posts and comments. Public posts and comments include those
on profiles and in public groups, but not those on records or in private groups. This object is available in API version 26.0 and later.
Holiday
Represents a period of time during which your customer support team is unavailable. Business hours and escalation rules associated
with business hours are suspended during any holidays with which they are affiliated.
Idea
Represents an idea on which users are allowed to comment and vote, for example, a suggestion for an enhancement to an existing
product or process. This object is available in API version 12 and later.
IdeaComment
Represents a comment that a user has submitted in response to an idea.
IdeaReputation
Represents a collection of statistics and scores derived from a user’s activity within an Ideas zone or internal organization. This object
is available in API version 28.0 and later.
IdeaReputationLevel
Represents a reputation level within an Ideas zone or internal organization and is used by the system to calculate reputation. You
can create up to 25 levels per zone or internal organization. This object is available in API version 28.0 and later.
IdeaTheme
Represents an invitation to community members to submit ideas that are focused on a specific topic. This object is available in API
version 26 and later.
KnowledgeableUser
Represents a user identified as knowledgeable about a specific topic, and ranks them relative to other knowledgeable users. This
object is available in API version 31.0 and later.
KnowledgeArticle
Provides read-only access to an article and the ability to delete the master article. This object is available in API version 19.0 and later.
KnowledgeArticleVersion
Provides a global view of standard article fields across all article types depending on their version. This object is available in API
version 18.0 and later.
KnowledgeArticleVersionHistory
Enables read-only access to the full history of an article. This object is available in API version 25.0 and later.

147

Standard Objects

KnowledgeArticleViewStat
Provides statistics on the number of views for the specified article across all article types. This object is read-only and available in API
version 20 and later.
KnowledgeArticleVoteStat
Provides the weighted rating for the specified article on a scale of 1 to 5 across all article types. This object is read-only and available
in API version 20 and later.
Lead
Represents a prospect or potential Opportunity.
LeadCleanInfo
Stores the metadata Data.com Clean uses to determine a lead record’s clean status. Helps you automate the cleaning or related
processing of lead records.
LeadFeed
Represents a single feed item in the feed displayed on the detail page for a lead record. This object is available in API version 18.0
and later.
LeadHistory
Represents the history of changes to the values in the fields of a lead.
LeadOwnerSharingRule
Represents the rules for sharing a lead with users other than the owner.
LeadShare
Represents a sharing entry on a Lead.
LeadStatus
Represents the status of a Lead, such as Open, Qualified, or Converted.
LeadTag
Associates a word or short phrase with a Lead.
LimitAllocationPerApp
Represents a connected app quota for an API limit. This object is available in API version 30.0 and later.
LineitemOverride
A forecast override of a line item on an Opportunity. This read-only object for customizable forecasting has a child-parent relationship
with OpportunityOverride.
LinkedArticle
Represents a Knowledge article that is attached to a record. This object is available in API version 37.0 and later.
LinkedArticleFeed
Represents a single feed item on a linked Knowledge article attached to a record. This object is available in API version 37.0 and later.
LinkedArticleHistory
Represents the history of changes made to tracked fields on a linked article. This object is available in API version 37.0 and later.
ListView
Represents a list view. A list view specifies a set of records for an object, based on specific criteria. This object is available in API version
32.0 and later.
ListViewChart
Represents a graphical chart that’s displayed on Salesforce1 list views. The chart aggregates data that is filtered based on the list
view that’s currently displayed. This object is available in API version 33.0 and later.

148

Standard Objects

ListViewChartInstance
Retrieves metadata for all standard and custom charts for a given entity in context of a given list view. This object is available in API
versions 34.0 and later.
LiveAgentSession
This object is automatically created for each Live Agent session and stores information about the session. This object is available in
API versions 28.0 and later.
LiveAgentSessionHistory
This object is automatically created for each Live Agent session and stores information about changes made to the session. This
object is available in API versions 28.0 and later.
LiveAgentSessionOwnerSharingRule
Represents the rules for sharing a Live Agent session record with users other than the record owner. This object is available in API
version 28.0 and later.
LiveAgentSessionShare
This object is automatically created for each Live Agent session and stores information about the session. This object is available in
API versions 28.0 and later.
LiveChatBlockingRule
Represents a rule for blocking chat visitors’ IP addresses from starting new chats with agents. This object is available in API version
34.0 and later.
LiveChatButton
Represents a button that allows visitors to request chats with Live Agent users. This object is available in API version 24.0 and later.
LiveChatButtonDeployment
Associates a Live Agent automated chat invitation with a specific deployment. This object is available in API versions 28.0 and later.
LiveChatButtonSkill
Represents all the skills available to a LiveChatButton except the one currently assigned. To retrieve the skill currently assigned, query
LiveChatButton. This object is available in API version 25.0 and later.
LiveChatDeployment
Represents the general settings for deploying Live Agent on a website. This object is available in API version 24.0 and later.
LiveChatSensitiveDataRule
Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex). This object is available
in API version 35.0 and later.
LiveChatTranscript
This object is automatically created for each Live Agent chat session and stores information about the session. This object is available
in API version 24.0 and later.
LiveChatTranscriptEvent
Captures specific events that occur over the lifetime of a chat. This object is available in API version 24.0 and later.
LiveChatTranscriptHistory
Represents changes to field values on a LiveChatTranscript object. This object is available in API version 24.0 and later.
LiveChatTranscriptOwnerSharingRule
Represents the rules for sharing a Live Agent chat transcript record with users other than the record owner. This object is available
in API version 29.0 and later.
LiveChatTranscriptShare
Represents a sharing entry on a LiveChatTranscript object. This object is available in API version 24.0 and later.

149

Standard Objects

LiveChatTranscriptSkill
Represents a join between LiveChatTranscript and Skill. This object is available in API version 25.0 and later.
LiveChatUserConfig
Represents a setting that controls the console settings for Live Agent users. This object is available in API version 24.0 and later.
LiveChatUserConfigProfile
Represents a join between LiveChatUserConfig and Profile. This object is available in API version 24.0 and later.
LiveChatUserConfigUser
Represents a join between LiveChatUserConfig and User. This object is available in API version 24.0 and later.
LiveChatVisitor
Represents a website visitor who has started or tried to start a chat session. This object is available in API version 24.0 and later.
LoginEvent
Represents a trackable user login event in your org. This object is available in API version 36.0 and later.
LoginGeo
Represents the geographic location of the user’s IP address for a login event. Due to the nature of geolocation technology, the
accuracy of geolocation fields (for example, country, city, postal code) may vary. This object is available in API version 34.0 and later.
LoginHistory
Represents the login history for all successful and failed login attempts for organizations and enabled portals. This object is available
in API version 21.0 and later.
LoginIp
Represents a validated IP address. This object is available in version 28.0 and later.
LookedUpFromActivity
This read-only object is displayed as a related list on an activity record (an event or a task); the list contains records that have custom
lookup relationships from the activity to another object. This object is not queryable.
Macro
Represents a macro, which is a set of instructions that tells the system to perform one or more tasks. This object is available in API
version 32.0 and later.
MacroInstruction
Represents an instruction in a macro. An instruction can specify the object that the macro interacts with, the context or publisher
that the macro works within, the operation or action that the macro performs, and the target of the macro’s actions. It is a useful
way to programmatically define instructions, instead of using the macro widget in the console.
MailmergeTemplate
Represents a mail merge template (a Microsoft Word document) used for performing mail merges for your organization.
MatchingRule
Represents a matching rule that is used to identify duplicate records. This object is available in API version 33.0 and later.
MatchingRuleItem
Represents criteria used by a matching rule to identify duplicate records. This object is available in API version 33.0 and later.
MetadataPackage
Represents a managed or unmanaged package that has been developed in the org you’re logged in to.
MetadataPackageVersion
Represents a package version (managed or unmanaged) that has been uploaded from the org you’re logged in to.

150

Standard Objects

Metric
The Metric object represents the components of a goal metric such as its name, metric type, and current value.
MetricDataLink
The link between the metric and the data source, such as a report.
MetricDataLinkHistory
This read-only object contains historical information about changes that have been made to the MetricDataLink object.
MetricFeed
Represents a single feed item in the feed displayed on a Metric record.
MetricHistory
This read-only object contains historical information about changes that have been made to the Metric object.
MetricsDataFile
Represents a data file containing usage metrics on all installations of a managed package in a Salesforce instance. This object is
available in API version 30.0 and later.
MetricShare
Represents a sharing entry on a Metric object.
MilestoneType
Represents a milestone (required step in a customer support process). This object is available in API version 18.0 and later.
Name
Non-queryable object that provides information about foreign key traversals when the foreign key has more than one parent.
NamedCredential
Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one
definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts. This object is available
in API version 33.0 and later.
NavigationLinkSet
Represents the navigation menu in a community. A navigation menu consists of items that users can click to go to other parts of
the community. This object is available in API version 36.0 and later.
NavigationMenuItem
Represents a single menu item in a NavigationLinkSet. Use this object to create, delete, or update menu items in your community’s
navigation menu. This object is available in API version 36.0 and later.
NavigationMenuItemLocalization
Represents the translated value of a navigation menu item in a community. This object is available in API version 36.0 and later.
Network
Represents a community, which is a customizable public or private space where employees, end-customers, and partners can
collaborate on best practices and business processes. Communities give you the opportunity to share information, records, and files
with coworkers and related external stakeholders all in one place. This object is available in API version 26.0 and later.
NetworkActivityAudit
Represents an audit trail of moderation actions in Communities. This object is available in API version 30.0 and later.
NetworkMember
Represents a member of a community. Members can be either users in your company or external users with portal profiles. This
object is available in API version 26.0 and later.

151

Standard Objects

NetworkMemberGroup
Represents a group of members in a community. Members can be either users in your internal organization or external users assigned
portal profiles. An administrator adds members to a community by adding a profile or a permission set, and any user with the profile
or permission set becomes a member of the community. This object is available in API version 26.0 and later.
NetworkModeration
Represents a flag on an item in a community. This object is available in API version 30.0 and later.
NetworkPageOverride
Represents information about custom pages used to override the default pages in communities. You can create Community Builder
(Site.com Studio) or Visualforce pages and override the default pages in a community. Using custom pages allows you to create a
more personalized experience for your users. This object is available in API version 34.0 and later.
NetworkSelfRegistration
Represents the account that self-registering community members are associated with by default. Self-registering users in a community
are required to be associated with an account, which the administrator must specify while setting up self-registration for the
community. If an account isn’t specified, Salesforce creates person accounts (when enabled) for self-registering users. This object is
available in API version 34.0 and later.
NewsFeed
Represents a single feed item on a user's home tab. A Chatter feed shows recent changes to records that the user is following.
Note
Represents a note, which is text associated with a custom object or a standard object, such as a Contact, Contract, or Opportunity.
OauthToken
Represents an OAuth access token for connected app authentication and can be used to create a user interface for token management.
This object is available in API version 32.0 and later.
NoteAndAttachment
This read-only object contains all notes and attachments associated with an object.
NoteTag
Associates a word or short phrase with a Note.
ObjectPermissions
Represents the enabled object permissions for the parent PermissionSet. This object is available in API version 24.0 and later.
ObjectTerritory2AssignmentRule
Represents a territory assignment rule that’s associated with an object, such as Account. ObjectTerritory2AssignmentRuleItem can
only be created or deleted if the BooleanFilter field on its corresponding ObjectTerritory2AssignmentRule is null. Available only
if Enterprise Territory Management has been enabled for your organization.
ObjectTerritory2AssignmentRuleItem
A single row of selection criteria for an ObjectTerritory2AssignmentRule object. ObjectTerritory2AssignmentRuleItem can only be
created or deleted if the BooleanFilter field on its corresponding ObjectTerritory2AssignmentRule object is a null value.
Available only if Enterprise Territory Management has been enabled for your organization.
ObjectTerritory2Association
Represents an association (by assignment) between a territory and an object record, such as an account. Available only if Enterprise
Territory Management has been enabled for your Salesforce org.
OpenActivity
This read-only object is displayed in a related list of open activities—future events and open tasks—related to an object. It includes
activities for all contacts related to the object. OpenActivity fields for phone calls are only available if your organization uses Salesforce
CRM Call Center.

152

Standard Objects

OperatingHours
Represents the hours in which a service territory, service resource, or account is available for field service work. This object is available
in API version 38.0 and later.
OperatingHoursFeed
Represents a single feed item on an operating hours record detail page. This object is available in API version 38.0 and later.
OperatingHoursHistory
Represents the history of changes made to tracked fields on an operating hours record. This object is available in API version 38.0
and later.
Opportunity
Represents an opportunity, which is a sale or pending deal.
OpportunityCompetitor
Represents a competitor on an Opportunity.
OpportunityContactRole
Represents the role that a Contact plays on an Opportunity.
OpportunityFeed
Represents a single feed item in the feed displayed on the detail page for an opportunity record. This object is available in API version
18.0 and later.
OpportunityFieldHistory
Represents the history of changes to the values in the fields of an opportunity. This object is available in versions 13.0 and later.
OpportunityHistory
Represents the stage history of an Opportunity.
OpportunityLineItem
Represents an opportunity line item, which is a member of the list of Product2 products associated with an Opportunity.
OpportunityLineItemSchedule
Represents information about the quantity, revenue distribution, and delivery dates for a particular OpportunityLineItem.
OpportunityOverride
Represents a forecast override of an Opportunity. This read-only object is specific to customizable forecasting. It has a parent-child
relationship with LineitemOverride.
OpportunityOwnerSharingRule
Represents a rule for sharing an opportunity with users other than the owner.
OpportunityPartner
This read-only object represents a partner relationship between an Account and an Opportunity. This object is automatically created
when a Partner object is created for a partner relationship between an account and an opportunity.
OpportunityShare
Represents a sharing entry on an Opportunity.
OpportunitySplit
OpportunitySplit credits one or more opportunity team members with a portion of the opportunity amount. This object is available
in API version 16.0 and later for pilot customers, and version 28.0 and later for others.
OpportunitySplitType
OpportunitySplitType provides unique labels and behavior for each split type. This object is available in API version 28.0 and later.

153

Standard Objects

OpportunityStage
Represents the stage of an Opportunity in the sales pipeline, such as New Lead, Negotiating, Pending, Closed, and so on.
OpportunityTag
Associates a word or short phrase with an Opportunity.
OpportunityTeamMember
Represents a User on the opportunity team of an Opportunity.
Order
Represents an order associated with a contract or an account.
OrderFeed
Represents a single feed item in the feed displayed on an order.
OrderHistory
Represents historical information about changes that have been made to the standard fields of the associated order, or to any custom
fields with history tracking enabled.
OrderItem
Represents an order product that your organization sells.
OrderItemFeed
Represents a single feed item in the feed displayed on the detail page for an order product record.
OrderItemHistory
Represents the history of changes to the values in the fields of an order product.
OrderOwnerSharingRule
Represents a rule which determines order sharing access for the order’s owners.
Organization
Represents key configuration information for an organization.
OrgWideEmailAddress
Represents an organization-wide email address for user profiles.
OwnedContentDocument
Represents a file owned by a user. This object is available in version 30.0 and later.
PackageLicense
Represents a license for an installed managed package. This object is available in API version 31.0 and later.
PackagePushError
Represents an error encountered during a push request. The number of PackagePushError records created depends on the number
of push jobs in the request that result in an error.
PackagePushJob
Represents an individual push job for upgrading a package in an org from one version to another version. There can be multiple
push jobs created for one push request. For example, if you want to upgrade five orgs as part of one push, you have one
PackagePushRequest record and five PackagePushJob records.
PackagePushRequest
Represents the push request for upgrading a package in one or many orgs from one version to another version.
PackageSubscriber
Represents an installation of a package in an org. This object contains installation information for managed packages developed in
the org you’re logged in to.

154

Standard Objects

Partner
Represents a partner relationship between two Account records or between an Opportunity and an Account.
PartnerNetworkConnection
Represents a Salesforce to Salesforce connection between Salesforce organizations.
PartnerNetworkRecordConnection
Represents a record shared between Salesforce organizations using Salesforce to Salesforce.
PartnerNetworkSyncLog
Represents the Org Sync Log tab in Salesforce, where Salesforce administrators can track the replication of record inserts and updates
being performed in Organization Sync. The Connection Detail page for the replication connection also displays the Org Sync Log’s
twenty most recent entries, and provides a link to the log.
PartnerRole
Represents a role for an account Partner, such as consultant, supplier, and so on.
Period
Represents a fiscal period defined in FiscalYearSettings.
PermissionSet
Represents a set of permissions that’s used to grant additional access to one or more users without changing their profile or reassigning
profiles. This object is available in API version 22.0 and later.
PermissionSetAssignment
Represents the association between a User and a PermissionSet. This object is available in API version 22.0 and later.
PermissionSetLicense
Represents a license that’s used to enable one or more users to receive a specified permission without changing their profile or
reassigning profiles. You can use permission set licenses to grant access, but not to deny access. This object is available in API version
29.0 and later.
PermissionSetLicenseAssign
Represents the association between a User and a PermissionSetLicense. This object is available in API version 29.0 and later.
PlatformAction
PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device
format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions.
PresenceUserConfig
Represents a configuration that determines a presence user’s settings. This object is available in API version 32.0 and later.
PresenceUserConfigProfile
Represents a configuration that determines the settings that are assigned to presence users who are assigned to a specific profile.
User-level configurations override profile-level configurations. This object is available in API version 32.0 and later.
PresenceUserConfigUser
Represents a configuration that determines the settings that are assigned to a presence user. These user-level configurations override
profile-level configurations. This object is available in API version 32.0 and later.
Pricebook2
Represents a price book that contains the list of products that your org sells.
Pricebook2History
Represents historical information about changes that have been made to the standard fields of the associated Pricebook2, or to any
custom fields with history tracking enabled. This object is available in API version 39.0 and later.

155

Standard Objects

PricebookEntry
Represents a product entry (an association between a Pricebook2 and Product2) in a price book.
ProcessDefinition
Represents the definition of a single approval process.
ProcessInstance
Represents an instance of a single, end-to-end approval process. Use this and the node, step, and workitem process instance objects
to create approval history reports.
ProcessInstanceHistory
This read-only object shows all steps and pending approval requests associated with an approval process (ProcessInstance).
ProcessInstanceStep
Represents one work item in an approval process (ProcessInstance).
ProcessInstanceNode
Represents a step in an instance of an approval process. Compare to ProcessNode, which describes the step in a process definition.
Use this object to retrieve approval history.
ProcessInstanceWorkitem
Represents a user’s pending approval request.
ProcessNode
Describes a step in a process definition. Compare to ProcessInstanceNode, which describes the step in a running process.
Product2
Represents a product that your org sells.
Product2Feed
Represents a single feed item in the feed displayed on the detail page for a product record. This object is available in API version
18.0 and later.
ProductEntitlementTemplate
Represents predefined terms of customer support (Entitlement) that users can add to products (Product2).
Profile
Represents a profile, which defines a set of permissions to perform different operations, such as querying, adding, updating, or
deleting information.
ProfileSkill
Represents a profile skill, which describes a user’s professional knowledge. This is a global record for the organization, and users are
associated through the ProfileSkillUser object.
ProfileSkillEndorsement
Represents a detail relationship of ProfileSkillUser. An endorsement of a profile skill shows approval and support of another user’s
publicly declared skill.
ProfileSkillEndorsementFeed
Represents a single feed item in the feed displayed on the detail page for a ProfileSkillEndorsement record. This object is available
in API version 34.0 and later.
ProfileSkillEndorsementHistory
Represents the history of changes to the fields of a ProfileSkillEndorsement.
ProfileSkillFeed
Represents a single feed item in the feed displayed on the detail page for a profile skill.

156

Standard Objects

ProfileSkillHistory
Represents the history of changes to the fields of a ProfileSkill.
ProfileSkillShare
Represents a sharing entry on a ProfileSkill.
ProfileSkillUser
Represents a detail relationship of User. The object connects profile skills with users.
ProfileSkillUserFeed
Represents a single feed item in the feed displayed on the detail page for a ProfileSkillUser record. This object is available in API
version 34.0 and later.
ProfileSkillUserHistory
Represents the history of changes to the fields of a ProfileSkillUser.
PushTopic
QuantityForecast
Represents a quantity-based forecast.
QuantityForecastHistory
Represents historical information about quantity-based forecasts that have been submitted (saved) in the user interface.
QueueRoutingConfig
Represents the settings that determine how work items are routed to agents. This object is available in API version 32.0 and later.
Question
Represents a question in a community that users can view and reply to.
QuestionDataCategorySelection
A data category selection represents a data category that classifies a question.
QuestionReportAbuse
Represents a user-reported abuse on a Question in a Chatter Answers community. This object is available in API version 24.0 and
later.
QuestionSubscription
Represents a subscription for a user following a Question. This object is available in API version 24.0 and later.
QueueSobject
Represents the mapping between a queue Group and the sObject types associated with the queue, including custom objects.
QuickText
This object stores a snippet of text that allows an agent to send a quick response to a customer in the Live Agent console. This object
is available in API version 24.0 and later.
QuickTextHistory
Represents changes to field values on a QuickText object. This object is available in API version 24.0 and later.
QuickTextOwnerSharingRule
Represents a rule for sharing a QuickText object with users other than the owner.
QuickTextShare
Represents a sharing entry on a QuickText object. This object is available in API version 24.0 and later.
Quote
The Quote object represents a quote, which is a record showing proposed prices for products and services. Available in API version
18.0 and later.

157

Standard Objects

QuoteDocument
Represents a quote in document format. Available in API version 18.0 and later.
QuoteFeed
Represents a single feed item on the quote record detail page. This object is available in API version 39.0 and later.
QuoteLineItem
The QuoteLineItem object represents a quote line item, which is a member of the list of Product2 products associated with a Quote,
along with other information about those line items on that quote. Available in API version 18.0 and later.
RecentlyViewed
Represents records that the current user has recently viewed or referenced (by viewing a related record).
RecordType
Represents a record type.
RecordTypeLocalization
Represents the translated value of a label for a record type when the Translation Workbench is enabled for your organization.
Reply
Represents a reply that a user has submitted to a question in an answers community.
ReplyReportAbuse
Represents a user-reported abuse on a Reply in a Chatter Answers community. This object is available in API version 24.0 and later.
Report
Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available
in API version 20.0 and later.
ReportFeed
Represents a single feed item in the feed displayed on a report. This object is available in API version 20.0 and later.
ReportTag
Associates a word or short phrase with a Report. This object is available in API version 20.0 and later.
ReputationLevel
Represents a reputation level defined for a community. This object is available in API version 32.0 and later.
ReputationLevelLocalization
Represents the translated value of a reputation level. Reputation level localization only applies for reputation levels in communities.
This object is available in API version 35.0 and later.
ReputationPointsRule
Represents the reputation point rules for a community. Each rule specifies an action that community members can earn points from
and the points associated with those actions in a particular community. This object is available in API version 32.0 and later.
ResourceAbsence
Represents a time period in which a service resource is unavailable to work. This object is available in API version 38.0 and later.
ResourceAbsenceFeed
Represents a single feed item on a resource absence record detail page. This object is available in API version 38.0 and later.
ResourceAbsenceHistory
Represents the history of changes made to tracked fields on a resource absence. This object is available in API version 38.0 and later.
RevenueForecast
Represents a revenue-based forecast.

158

Standard Objects

RevenueForecastHistory
Represents historical information about revenue-based forecasts that have been submitted (saved) in the user interface.
RuleTerritory2Association
Represents a record-assignment rule and its association to an object, such as Account. Available only if Enterprise Territory Management
has been enabled for your organization.
SamlSsoConfig
Represents a SAML Single Sign-On configuration. This object is available in API version 32.0 and later.
Scontrol
A custom s-control, which is custom content that is hosted by the system but executed by the client application.
ScontrolLocalization
The translated value of the field label for an s-control.
SearchPromotionRule
Represents a promoted search term, which is one or more keywords that you associate with a Salesforce Knowledge article. When
a user’s search query includes these keywords, the associated article is returned first in search results. This object is available in API
version 31.0 and later.
SecureAgent
Represents a Secure Agent that connects Salesforce to on-premises external data sources like SharePoint 2010 and 2013. This object
is available in API version 32.0 and later.
SecureAgentsCluster
Represents a cluster consisting of several Secure Agents on different servers. Clusters provide failover protection if an agent on a
particular server becomes inaccessible. This object is available in API version 35.0 and later.
SecurityCustomBaseline (Beta)
Provides the ability to read, create, and delete user-defined custom security baselines, which define an org’s security standards. This
object is available in API version 39.0 and later.
SelfServiceUser
Represents a Contact who has been enabled to use your organization’s Self-Service portal, where he or she can obtain online support.
ServiceAppointment
Represents an appointment to complete field service work for a customer. This object is available in API version 38.0 and later.
ServiceAppointmentFeed
Represents a single feed item on a service appointment record detail page. This object is available in API version 38.0 and later.
ServiceAppointmentHistory
Represents the history of changes made to tracked fields on a service appointment. This object is available in API version 38.0 and
later.
ServiceAppointmentOwnerSharingRule
Represents the rules for sharing a service appointment with user records other than the owner or anyone above the owner in the
role hierarchy. This object is available in API version 38.0 and later.
ServiceAppointmentShare
Represents a sharing entry on a service appointment. This object is available in API version 38.0 and later.
ServiceChannel
Represents a channel of work items that are received from your organization—for example, cases, chats, or leads. This object is
available in API version 32.0 and later.

159

Standard Objects

ServiceChannelStatus
Represents the status that’s associated with a specific service channel. This object is available in API version 32.0 and later.
ServiceContract
Represents a customer support contract (business agreement). This object is available in API version 18.0 and later.
ServiceContractFeed
Represents a single feed item in the feed displayed on the detail page for a service contract record. This object is available in API
version 23.0 and later.
ServiceContractHistory
Represents the history of changes to the values in the fields on a ServiceContract (customer support agreement). This object is
available in API version 18.0 and later.
ServiceContractOwnerSharingRule
Represents the rules for sharing a ServiceContract (customer service agreement) with users other than the owner. This object is
available in API version 18.0 and later.
ServiceContractShare
Represents a sharing entry on a ServiceContract (customer support agreement). This object is available in API version 18.0 and later.
ServicePresenceStatus
Represents a presence status that can be assigned to a service channel. This object is available in API version 32.0 and later.
ServiceResource
Represents a service technician or dispatcher in field service. This object is available in API version 38.0 and later.
ServiceResourceCapacity
Represents the maximum number of scheduled hours or number of service appointments that a capacity-based service resource
can complete within a specific time period. This object is available in API version 38.0 and later.
ServiceResourceCapacityFeed
Represents a single feed item on a service resource capacity record detail page. This object is available in API version 38.0 and later.
ServiceResourceCapacityHistory
Represents the history of changes made to tracked fields on a service resource capacity record. This object is available in API version
38.0 and later.
ServiceResourceFeed
Represents a single feed item on a service resource record detail page. This object is available in API version 38.0 and later.
ServiceResourceHistory
Represents the history of changes made to tracked fields on a service resource. This object is available in API version 38.0 and later.
ServiceResourceOwnerSharingRule
Represents the rules for sharing a service resource with user records other than the owner or anyone above the owner in the role
hierarchy. This object is available in API version 38.0 and later.
ServiceResourceShare
Represents a sharing entry on a service resource. This object is available in API version 38.0 and later.
ServiceResourceSkill
Represents a skill that a service resource possesses. This object is available in API version 38.0 and later.
ServiceResourceSkillFeed
Represents a single feed item on a service resource skill record detail page. This object is available in API version 38.0 and later.

160

Standard Objects

ServiceResourceSkillHistory
Represents the history of changes made to tracked fields on a service resource skill. This object is available in API version 38.0 and
later.
ServiceTerritory
Represents a region in which field service work can be performed. This object is available in API version 38.0 and later.
ServiceTerritoryFeed
Represents a single feed item on a service territory record detail page. This object is available in API version 38.0 and later.
ServiceTerritoryHistory
Represents the history of changes made to tracked fields on a service territory. This object is available in API version 38.0 and later.
ServiceTerritoryMember
Represents a service resource who is able to be assigned to service appointments in the service territory. This object is available in
API version 38.0 and later.
ServiceTerritoryMemberFeed
Represents a single feed item on a service territory member record detail page. This object is available in API version 38.0 and later.
ServiceTerritoryMemberHistory
Represents the history of changes made to tracked fields on a service territory member. This object is available in API version 38.0
and later.
SessionPermSetActivation
The SessionPermSetActivation object represents a permission set assignment activated during an individual user session. When a
SessionPermSetActivation object is inserted into a permission set, an activation event fires, allowing the permission settings to apply
to the user’s specific session. This object is available in API versions 37.0 and later as part of the Session-Based Permission Sets
Developer Preview.
SetupAuditTrail
Represents changes you or other admins made in your org’s Setup area for at least the last 180 days. This object is available in API
version 15.0 and later.
SetupEntityAccess
Represents the enabled setup entity access settings (such as for Apex classes) for the parent PermissionSet. This object is available
in API version 25.0 and later.
SignupRequest
Represents a request for a new Trialforce sign-up. This object is available in API version 27.0 and later.
Site
Represents a public website that is integrated with an Organization. This object is generally available in API version 16.0 and later.
SiteDomain
SiteDomain is a read-only object, and a one-to-many replacement for the Site.TopLevelDomain field. This object is available in API
version 21.0, and has been deprecated as of API version 26.0. In API version 26.0 and later, use the Domain and DomainSite objects
instead.
SiteHistory
Represents the history of changes to the values in the fields of a site. This object is generally available in API version 18.0 and later.
Skill
Represents a category or group that Live Agent users or field service resources can be assigned to. This object is available in API
version 24.0 and later.

161

Standard Objects

SkillProfile
Represents a join between Skill and Profile. This object is available in API version 24.0 and later.
SkillRequirement
Represents a skill that is required to complete a particular task. Skill requirements can be added to work types, work orders, and work
order line items. This object is available in API version 38.0 and later.
SkillRequirementFeed
Represents a single feed item on a skill requirement record detail page. This object is available in API version 38.0 and later.
SkillRequirementHistory
Represents the history of changes made to tracked fields on a skill requirement. This object is available in API version 38.0 and later.
SkillUser
Represents a join between Skill and User. This object is available in API version 24.0 and later.
SlaProcess
Represents an entitlement process associated with an Entitlement. This object is available in API version 19.0 and later.
Solution
Represents a detailed description of a customer issue and the resolution of that issue.
SolutionFeed
Represents a single feed item in the feed displayed on the detail page for a solution record. This object is available in API version
18.0 and later.
SolutionHistory
Represents the history of changes to the values in the fields of a solution.
SolutionStatus
Represents the status of a Solution, such as Draft, Reviewed, and so on.
SolutionTag
Associates a word or short phrase with a Solution.
SOSDeployment
Represents the general settings for deploying SOS video call capability in a native mobile application. This object is available in API
version 34.0 and later.
SOSSession
This object is automatically created for each SOS session and stores information about the session. This object is available in API
versions 34.0 and later.
SOSSessionActivity
Captures information about specific events that occur during an SOS video call, such as when an SOS call begins or ends. This object
is available in API version 34.0 and later.
SOSSessionHistory
This object is automatically created for each SOS session and stores information about changes made to the session. This object is
available in API versions 34.0 and later.
SOSSessionOwnerSharingRule
Represents the rules for sharing an SOS session record with users other than the record owner. This object is available in API version
34.0 and later.
SOSSessionShare
Represents a sharing entry on an SOS session. This object is available in API version 34.0 and later.

162

Standard Objects

Stamp
Represents a User Specialty. This object is available in API version 39.0 and later.
StampAssignment
Represents assignment of a User Specialty to a user. This object is available in API version 39.0 and later.
StaticResource
Represents a static resource that can be used in Visualforce markup.
StreamingChannel
TagDefinition
Defines the attributes of child Tag objects.
Task
Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are
collectively referred to as activities.
TaskFeed
Represents a single feed item in the feed on a Task. This object is available in API version 20.0 and later.
TaskPriority
Represents the importance or urgency of a Task, such as High, Normal, or Low.
TaskRelation
Represents the relationship between a task and a lead, contacts, and other objects related to the task. If Shared Activities is enabled,
this object doesn’t support triggers, workflow, or data validation rules. This object is available in API version 24.0 and later.
TaskStatus
Represents the status of a Task, such as Not Started, Completed, or Closed.
TaskTag
Associates a word or short phrase with a Task.
TaskWhoRelation
Represents the relationship between a task and a lead or contacts. This object is available in API version 29.0 and later.
TenantSecret
This object stores an encrypted organization-specific key fragment that is used with the master secret to produce organization-specific
data encryption keys. This object is available in API version 34.0 and later.
Territory
Represents a flexible collection of accounts and users where the users have at least read access to the accounts, regardless of who
owns the accounts. Only available if territory management has been enabled for your organization.
Territory2
Represents a sales territory. Available only if Enterprise Territory Management has been enabled for your organization.
Territory2Model
Represents a territory model. Available only if Enterprise Territory Management has been enabled for your organization.
Territory2ModelHistory
Represents the history of changes to the values in the fields on a territory model. Available only if Enterprise Territory Management
has been enabled for your organization.
Territory2Type
Represents a category for territories (Territory2). Every Territory2 must have a Territory2Type. Available only if Enterprise Territory
Management has been enabled for your organization.

163

Standard Objects

TestSuiteMembership
Associates an Apex class with an ApexTestSuite. This object is available in API version 36.0 and later.
ThirdPartyAccountLink
Represents the list of external users who authenticated using an Auth. Provider. This object is available in API version 32.0 and later.
TimeSlot
Represents a period of time on a specified day of the week during which field service work can be performed. Operating hours consist
of one or more time slots. This object is available in API version 38.0 and later.
TimeSlotHistory
Represents the history of changes made to tracked fields on a time slot. This object is available in API version 38.0 and later.
Topic
Represents a topic on a Chatter post or record. This object is available in API version 28.0 and later.
TopicAssignment
Represents the assignment of a topic to a specific feed item, record, or file. This object is available in API version 28.0 and later.
TopicFeed
Represents a single feed item on a topic page. This object is available in API version 29.0 and later.
TopicLocalization—Beta
Represents the translated version of a topic name. Topic localization applies only to navigational and featured topics in communities.
This object is available in API version 33.0 and later.
TwoFactorInfo
Stores a user’s secret for two-factor operations. Use this object when customizing two-factor authentication in your organization.
This object is available in API version 32.0 and later.
TwoFactorMethodsInfo
Stores information about which identity verification methods a user has registered. This object is available in API version 37.0 and
later.
TwoFactorTempCode
Stores information about a user’s temporary identity verification code. This object is available in API version 37.0 and later.
UndecidedEventRelation
Represents invitees with the status Not Responded for a given event. This object is available in API versions 29.0 and later.
User
Represents a user in your organization.
UserAccountTeamMember
Represents a User on the default account team of another User.
UserAppInfo
Stores the last Lightning app logged in to. This object is available in API version 38.0 and later.
UserAppMenuCustomization
Represents an individual user’s settings for items in the Force.com app menu or App Launcher. This object is available in API version
35.0 and later.
UserAppMenuCustomizationShare
Represents a sharing entry on a UserAppMenuCustomization record. This object is available in API version 35.0 and later.

164

Standard Objects

UserAppMenuItem
Represents the organization-wide settings for items in the Force.com app menu or App Launcher that the requesting user has access
to in Setup. This object is available in API version 35.0 and later.
UserConfigTransferButton
Represents the association between a Live Agent configuration and a live chat button. This association allows users associated with
a specific configuration to transfer chats to a button queue.
UserConfigTransferSkill
Represents the association between a Live Agent configuration and a skill. This association allows users associated with a specific
configuration to transfer chats to agents who have that skill.
UserCustomBadge
Represents a custom badge for a user. This object is available in API version 38.0 and later.
UserCustomBadgeLocalization
Represents the translated version of a custom badge for a user. This object is available in API version 38.0 and later.
UserFeed
Represents a single feed item in the feed displayed on a Chatter user profile feed. A user profile feed shows changes to a user record
for fields that are tracked in feeds, and posts and comments about the record. This object is available in API version 18.0 and later.
UserLicense
Represents a user license in your organization. A user license entitles a user to specific functionality and determines the profiles and
permission sets available to the user.
UserLogin
Represents the settings that affect a user’s ability to log into an organization. To access this object, you need the
UserPermissions.ManageUsers permission. This object is available in API version 29.0 and later.
UserMembershipSharingRule
Represents the rules for sharing user records from a source group to a target group. A user record contains details about a user. Users
who are members of the source group can be shared with members of the target group. The source and target groups can be based
on roles, portal roles, public groups, or territories. This object is available in API version 26.0 and later.
UserPackageLicense
Represents a license for an installed managed package, assigned to a specific user. This object is available in API version 31.0 and
later.
UserPreference
Represents a functional preference for a specific user in your organization.
UserProfile
Represents a Chatter user profile.
UserProfileFeed
Represents a user profile feed, which tracks all actions by a user on records that can be tracked in a feed. This feed is displayed on
the user profile page.
UserProvAccount
Represents information that links a Salesforce user account with an account in a third-party (target) system, such as Google, for users
of connected apps with Salesforce user provisioning enabled. This object is available in API version 33.0 and later.
UserProvAccountStaging
Temporarily stores user account information while a user completes the User Provisioning Wizard. This information that is stored in
the UserProvAccount object when you click the button to collect and analyze accounts on the target system.

165

Standard Objects

UserProvMockTarget
Represents an entity for testing user data before committing the data to a third-party system for user provisioning.
UserProvisioningConfig
Represents information for a flow to use during a user provisioning request process, such as the attributes for an update. This object
is available in API version 34.0 and later.
UserProvisioningLog
Represents messages generated during the process of provisioning users for third-party applications. This object is available in API
version 33.0 and later.
UserProvisioningRequest
Represents an individual provisioning request to create, update, or delete a single user account in a third-party service system (or
another Salesforce organization). This object is available in API version 33.0 and later.
UserProvisioningRequestOwnerSharingRule
Represents a rule for sharing a UserProvisioningRequest object with users other than the owner. This object is available in API version
34.0 and later.
UserProvisioningRequestShare
Represents a sharing entry on a UserProvisioningRequest record. This object is available in API version 34.0 and later.
UserRecordAccess
Represents a user’s access to a set of records. This object is read only and is available in API version 24.0 and later.
UserRole
Represents a user role in your organization.
UserServicePresence
Represents a presence user’s real-time presence status. This object is available in API version 32.0 and later.
UserShare
Represents a sharing entry on a user record. This object is available in API version 26.0 and later.
UserTeamMember
Represents a single User on the default opportunity team of another User.
UserTerritory
Represents a User who has been assigned to a Territory.
UserTerritory2Association
Represents an association (by assignment) between a territory and a user record. Available only if Enterprise Territory Management
has been enabled for your organization.
VerificationHistory
Represents the past six months of your org users’ attempts to verify their identity. This object is available in API version 36.0 and later.
VoiceCall
Represents a Voice phone call.
VoiceCallList
Represents a prioritized list of numbers to call.
VoiceCallListItem
Represents a single phone number in a prioritized call list.
VoiceCallListShare
Represents a sharing entry on a VoiceCallList.

166

Standard Objects

VoiceCallShare
Represents a sharing entry on a VoiceCall object.
VoiceMailContent
Represents a voicemail message.
VoiceMailContentShare
Represents a sharing entry on a VoiceMailContent.
VoiceUserLine
Represents a user’s forwarding phone number.
VoiceUserLineShare
Represents a sharing entry on a user’s phone number.
VoiceVendorInfo
Represents information about the voice provider’s vendor.
VoiceVendorLine
Represents a user’s phone number reserved with the vendor.
VoiceVendorLineShare
Represents a sharing entry on a vendor’s phone number.
Vote
Represents a vote that a user has made on an Idea or a Reply.
WebLink
Represents a custom link to a URL or Scontrol.
WebLinkLocalization
Represents the translated value of the field label for a custom link to a URL or s-control when the Translation Workbench is enabled
for your organization.
WorkAccess
Used to grant or restrict user access to give badge definitions. Each badge definition record must have one WorkAccess record.
WorkAccessShare
Used to control Givers of WorkBadgeDefinition records.
WorkBadge
Represents information about who the badge was given to and which badge was given. A WorkBadge record is created for each
recipient of a WorkBadgeDefinition.
WorkBadgeDefinition
Represents the attributes of a badge including the badge name, description, and image. Each WorkBadge record must have a lookup
to a WorkBadgeDefinition since badge attributes (like badge name) are derived from the WorkBadgeDefinition object.
WorkBadgeDefinitionHistory
Represents the history of changes to the values in the fields of a WorkBadgeDefinition object.
WorkBadgeDefinitionShare
Represents a sharing entry on a WorkBadgeDefinition object.
WorkCoaching
Represents a single coaching relationship between two users. One of the users is defined as the coach and the other is defined as a
coachee. WorkCoaching is feed-enabled so there is a private feed available to the coach and coachee.

167

Standard Objects

WorkCoachingFeed
Represents a single feed item in the feed on the detail page for a coaching record.
WorkCoachingHistory
Represents the history of changes to the values in the fields of a WorkCoaching object.
WorkCoachingShare
Represents a sharing entry on a WorkCoaching object.
WorkFeedback
Represents the answer to a question that a person was asked via a feedback request. Also used to store offered feedback without
linking it to a particular question.
WorkFeedbackHistory
Represents the history of changes to the values in the fields of a WorkFeedback object. Access is read-only.
WorkFeedbackQuestion
Represents a free-form text type or multiple choice question within a set of questions.
WorkFeedbackQuestionHistory
Represents the history of changes to the values in the fields of a WorkFeedbackQuestion.
WorkFeedbackQuestionSet
Represents a set of questions being asked. The question set is used to link all the individual requests where different recipients were
asked the same set of questions on the same subject.
WorkFeedbackQuestionSetHistory
Represents the history of changes to the values in the fields of a WorkFeedbackQuestionSet object. Access is read-only.
WorkFeedbackQuestionSetShare
Represents a sharing entry on a WorkFeedbackQuestionSet.
WorkFeedbackQuestionShare
Represents a sharing entry on a WorkFeedbackQuestion.
WorkFeedbackRequest
Represents a single feedback request on a subject or topic (question) to a single recipient in the feedback application. In the case of
offered feedback, WorkFeedbackRequest represents feedback that is offered about a subject. In the performance application,
WorkFeedbackRequest represents a request for feedback on a set of questions from a question set, on a subject—for the recipient
to complete and submit.
WorkFeedbackRequestFeed
Represents a single feed item in the feed displayed on the feedback request detail page.
WorkFeedbackRequestHistory
Represents the history of changes to the values in the fields of a WorkFeedbackRequest.
WorkFeedbackRequestShare
Represents a sharing entry on a WorkFeedbackRequest.
WorkFeedbackShare
Represents a sharing entry on a WorkFeedback object.
WorkGoal
Represents the components of a goal, such as its description and associated metrics. This object has been deprecated as of API
version 35.0. Use the Goal object to query information about Work.com goals.

168

Standard Objects

WorkGoalCollaborator
Represents collaborators on a WorkGoal object. This doesn’t include WorkGoal followers, which is handled by Chatter Feed Follow
functionality. This object has been deprecated as of API version 35.0. Use the Goal object to query information about Work.com
goals.
WorkGoalCollaboratorHistory
Represents the history of changes to the values in the fields in a WorkGoalCollaborator object. Access is read-only.
WorkGoalFeed
Represents a single feed item in the feed displayed on the goal page for a Goal record. The goal feed shows changes to a goal for
fields that are tracked in feeds, posts, and comments about the goal, and updates on metrics. This object has been deprecated as
of API version 35.0. Use the GoalFeed object to query information about feed items for Work.com goals.
WorkGoalHistory
Represents the history of changes to the values in the fields of a WorkGoal. Access is read-only. This object has been deprecated as
of API version 35.0. Use the GoalHistory object to query historical information for Work.com goals.
WorkGoalLink
Represents the relationship between two goals (many to many relationship). This object has been deprecated as of API version 35.0.
Use the GoalLink object to query information about the relationship between two Work.com goals.
WorkGoalShare
Represents a sharing entry on a WorkGoal object. This object has been deprecated as of API version 35.0. Use the GoalShare object
to query information about sharing for Work.com goals.
WorkOrder
Represents a task or series of tasks to be performed, typically in field service. This object is available in API version 36.0 and later.
WorkOrderFeed
Represents a single feed item on a work order record detail page. This object is available in API version 36.0 and later.
WorkOrderHistory
Represents the history of changes made to tracked fields on a work order. This object is available in API version 36.0 and later.
WorkOrderLineItem
Represents a subtask on a work order, typically in field service. This object is available in API version 36.0 and later.
WorkOrderLineItemFeed
Represents a single feed item on a work order line item record detail page. This object is available in API version 36.0 and later.
WorkOrderLineItemHistory
Represents the history of changes made to tracked fields on a work order line item. This object is available in API version 36.0 and
later.
WorkOrderShare
Represents a sharing entry on a work order. This object is available in API version 36.0 and later.
WorkPerformanceCycle
Represents feedback that is gathered to assess the performance of a specific set of employees.
WorkPerformanceCycleFeed
Represents a single feed item in the feed that is displayed on a Work.com Performance detail page.
WorkPerformanceCycleHistory
Represents the history of changes to the values in the fields of a WorkPerformanceCycle object.
WorkPerformanceCycleShare
Represents a sharing entry on a WorkPerformanceCycle object.

169

Standard Objects

AcceptedEventRelation

WorkReward
Used to store reward codes tied to a Reward Fund. Reward Funds must have at least one WorkReward record.
WorkRewardFund
Represents a Reward Fund and describes the Reward Fund attributes.
WorkRewardFundHistory
Represents the history of changes to the values in the fields of a WorkRewardFund object.
WorkRewardFundShare
Share records for WorkRewardFund.
WorkRewardFundType
Represents the type of WorkRewardFund object.
WorkRewardFundTypeHistory
Represents the history of changes to the values in the fields of a WorkRewardFundType object.
WorkRewardFundTypeShare
Represents a sharing entry on a WorkRewardFundType.
WorkRewardHistory
Represents the history of changes to the fields of a WorkReward.
WorkRewardShare
Share records for WorkReward object.
WorkThanks
Represents the source and message of a thanks post.
WorkThanksShare
Share records for WorkThanks object.
WorkType
Represents a type of work to be performed. Work types are templates that can be applied to work order or work order line items.
This object is available in API version 38.0 and later.
WorkTypeFeed
Represents a single feed item on a work type record detail page. This object is available in API version 38.0 and later.
WorkTypeHistory
Represents the history of changes made to tracked fields on a work type. This object is available in API version 38.0 and later.
Reusable Terms for API Objects

AcceptedEventRelation
Represents invitees with the status Accepted for a given event.
This object is available in API versions 29.0 and later.

Supported Calls
describeSObjects(), query(), retrieve()

170

Standard Objects

AcceptedEventRelation

Fields
Field Name

Details

EventId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the event.

RelationId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the invitee.

RespondedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates the most recent date and time when the invitee accepted an invitation
to the event.

Response

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Indicates the content of the response field. Label is Comment.

Type

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Indicates whether the invitee is a user, lead or contact, or resource.

171

Standard Objects

Account

Usage
Query invitees who have accepted an invitation to an event
SELECT eventId, type, response FROM AcceptedEventRelation WHERE eventid='00UTD000000ZH5LA'

SEE ALSO:
DeclinedEventRelation
UndecidedEventRelation

Account
Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and
partners).

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), merge(),
query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules
Customer Portal users can access their own accounts and any account shared with them.

Fields
Field Name

Details

AccountNumber

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Account number assigned to this account (not the unique, system-generated ID assigned
during creation). Maximum size is 40 characters.

AccountSource

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The source of the account record. For example, Advertisement, Data.com, or Trade
Show. The source is selected from a picklist of available values, which are set by an
administrator. Each picklist value can have up to 40 characters.

172

Standard Objects

Account

Field Name

Details

AnnualRevenue

Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Estimated annual revenue of the account.

BillingAddress

Type
address
Properties
Filter, Nillable
Description
The compound form of the billing address. Read-only. See Address Compound Fields for
details on compound address fields.

BillingCity

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details for the billing address of this account. Maximum size is 40 characters.

BillingCountry

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details for the billing address of this account. Maximum size is 80 characters.

BillingCountryCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO country code for the account’s billing address.

BillingGeocodeAccuracy

Type
picklist
Properties
Retrieve, Query, Restricted picklist, Nillable

173

Standard Objects

Field Name

Account

Details
Description
Accuracy level of the geocode for the billing address. See Compound Field Considerations
and Limitations for details on geolocation compound fields.

BillingLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with BillingLongitude to specify the precise geolocation of a billing address.
Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See
Compound Field Considerations and Limitations for details on geolocation compound fields.

BillingLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with BillingLatitude to specify the precise geolocation of a billing address.
Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See
Compound Field Considerations and Limitations for details on geolocation compound fields.

BillingPostalCode

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details for the billing address of this account. Maximum size is 20 characters.

BillingState

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details for the billing address of this account. Maximum size is 80 characters.

BillingStateCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO state code for the account’s billing address.

174

Standard Objects

Account

Field Name

Details

BillingStreet

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Street address for the billing address of this account.

CleanStatus

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates the record’s clean status as compared with Data.com. Values are: Matched,
Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch,
or Skipped.
Several values for CleanStatus display with different labels on the account record detail
page.
• Matched displays as In Sync
• Acknowledged displays as Reviewed
• Pending displays as Not Compared

ConnectionReceivedId

Type
reference
Properties
Filter, Nillable
Description
ID of the PartnerNetworkConnection that shared this record with your organization. This
field is only available if you have enabled Salesforce to Salesforce.

ConnectionSentId

Type
reference
Properties
Filter, Nillable
Description
ID of the PartnerNetworkConnection that you shared this record with. This field is only
available if you have enabled Salesforce to Salesforce. Beginning with API version 15.0, the
ConnectionSentId field is no longer supported. The ConnectionSentId field
is still visible, but the value is null. You can use the new PartnerNetworkRecordConnection
object to forward records to connections.

Description

Type
textarea

175

Standard Objects

Field Name

Account

Details
Properties
Create, Nillable, Update
Description
Text description of the account. Limited to 32,000 KB.

DunsNumber

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number
assigned to every business location in the Dun & Bradstreet database that has a unique,
separate, and distinct operation. D-U-N-S numbers are used by industries and organizations
around the world as a global standard for business identification and tracking. Maximum
size is 9 characters.
Note: This field is only available to organizations that use Data.com Prospector or
Data.com Clean.

Fax

Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Fax number for the account.

Industry

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
An industry associated with this account. Maximum size is 40 characters.

IsCustomerPortal

Type
boolean
Properties
Defaulted on create, Filter, Update
Description
Indicates whether the account has at least one contact enabled to use the organization's
Customer Portal (true) or not (false). This field is available if Customer Portal is enabled
OR Communities is enabled and you have Customer Portal licenses.

176

Standard Objects

Field Name

Account

Details
If you change this field's value from true to false, you can disable up to 100 Customer
Portal users associated with the account and permanently delete all of the account's Customer
Portal roles and groups. You can't restore deleted Customer Portal roles and groups.
This field can be updated in API version 16.0 and later.
Tip: We recommend that you only update up to 50 contacts simultaneously when
changing the accounts on contacts enabled for a Customer Portal or partner portal.
We also recommend that you make this update during times outside of your
organization's business hours.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

IsPartner

Type
boolean
Properties
Defaulted on create, Filter, Update
Description
Indicates whether the account has at least one contact enabled to use the organization's
partner portal (true) or not (false). This field is available if partner relationship
management (partner portal) is enabled OR Communities is enabled and you have partner
portal licenses.
If you change this field's value from true to false, you can disable up to 15 partner
portal users associated with the account and permanently delete all of the account's partner
portal roles and groups. You can't restore deleted partner portal roles and groups.
Disabling a partner portal user in the Salesforce user interface or the API does not change
this field's value from true to false.
Even if this field's value is false, you can enable a contact on an account as a partner
portal user via the API.
This field can be updated in API version 16.0 and later.
Tip: We recommend that you only update up to 50 contacts simultaneously when
changing the accounts on contacts enabled for a Customer Portal or partner portal.
We also recommend that you make this update during times outside of your
organization's business hours.

IsPersonAccount

Type
boolean

177

Standard Objects

Field Name

Account

Details
Properties
Defaulted on create, Filter
Description
Read only. Label is Is Person Account. Indicates whether this account has a record type of
Person Account (true) or not (false).

Jigsaw

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the ID of a company in Data.com. If an account has a value in this field, it means
that the account was imported from Data.com. If the field value is null, the account was
not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0
and later. Label is Data.com Key.
Important: The Jigsaw field is exposed in the API to support troubleshooting for
import errors and reimporting of corrected data. Do not modify the value in the
Jigsaw field.

LastActivityDate

Type
date
Properties
Filter, Group, Nillable, Sort
Description
Value is one of the following, whichever is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.

LastReferencedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed this record. If this value is null, this
record might only have been referenced (LastReferencedDate) and not viewed.

178

Standard Objects

Account

Field Name

Details

MasterRecordId

NaicsCode

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The six-digit North American Industry Classification System (NAICS) code is the standard
used by business and government to classify business establishments into industries,
according to their economic activity for the purpose of collecting, analyzing, and publishing
statistical data related to the U.S. business economy. Maximum size is 8 characters.
Note: This field is only available to organizations that use Data.com Prospector or
Data.com Clean.

NaicsDesc

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A brief description of an organization’s line of business, based on its NAICS code. Maximum
size is 120 characters.
Note: This field is only available to organizations that use Data.com Prospector or
Data.com Clean.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Label is Account Name. Name of the account. Maximum size is 255 characters.
If the account has a record type of Person Account:
• This value is the concatenation of the FirstName, MiddleName, LastName, and
Suffix of the associated person contact.
• You can't modify this value.

179

Standard Objects

Account

Field Name

Details

NumberOfEmployees

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Label is Employees. Number of employees working at the company represented by this
account. Maximum size is eight digits.

OperatingHoursId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The operating hours associated with the account. Available only if Field Service Lightning is
enabled.

OwnerId

Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who currently owns this account. Default value is the user logged in to
the API to perform the create.
If you have set up account teams in your organization, updating this field has different
consequences depending on your version of the API:
• For API version 12.0 and later, sharing records are kept, as they are for all objects.
• For API version before 12.0, sharing records are deleted.
• For API version 16.0 and later, users must have the “Transfer Record” permission in order
to update (transfer) account ownership using this field.

Ownership

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Ownership type for the account, for example Private, Public, or Subsidiary.

ParentId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update

180

Standard Objects

Field Name

Account

Details
Description
ID of the parent object, if any.

Phone

Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Phone number for this account. Maximum size is 40 characters.

PhotoUrl

Type
url
Properties
Filter, Group, Nillable, Sort
Description
Path to be combined with the URL of a Salesforce instance (for example,
https://yourInstance.salesforce.com/) to generate a URL to request the social network
profile image associated with the account. Generated URL returns an HTTP redirect (code
302) to the social network profile image for the account.
Blank if Social Accounts and Contacts isn't enabled for the organization or if Social Accounts
and Contacts is disabled for the requesting user.

Rating

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account’s prospect rating, for example Hot, Warm, or Cold.

RecordTypeId

Type
reference
Properties
Create, Filter, Nillable, Update
Description
ID of the record type assigned to this object.

Salutation

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update

181

Standard Objects

Field Name

Account

Details
Description
Honorific added to the name for use in letters, etc.

ShippingAddress

Type
address
Properties
Filter, Nillable
Description
The compound form of the shipping address. Read-only. See Address Compound Fields for
details on compound address fields.

ShippingCity

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details of the shipping address for this account. City maximum size is 40 characters

ShippingCountry

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details of the shipping address for this account. Country maximum size is 80 characters.

ShippingCountryCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO country code for the account’s shipping address.

ShippingGeocodeAccuracy Type

picklist
Properties
Retrieve, Query, Restricted picklist, Nillable
Description
Accuracy level of the geocode for the shipping address. See Compound Field Considerations
and Limitations for details on geolocation compound fields.
ShippingLatitude

Type
double

182

Standard Objects

Field Name

Account

Details
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with ShippingLongitude to specify the precise geolocation of a shipping address.
Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See
Compound Field Considerations and Limitations for details on geolocation compound fields.

ShippingLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with ShippingLatitude to specify the precise geolocation of an address.
Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See
Compound Field Considerations and Limitations for details on geolocation compound fields.

ShippingPostalCode

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details of the shipping address for this account. Postal code maximum size is 20 characters.

ShippingState

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details of the shipping address for this account. State maximum size is 80 characters.

ShippingStateCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO state code for the account’s shipping address.

ShippingStreet

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update

183

Standard Objects

Field Name

Account

Details
Description
The street address of the shipping address for this account. Maximum of 255 characters.

Sic

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Standard Industrial Classification code of the company’s main business categorization, for
example, 57340 for Electronics. Maximum of 20 characters.

SicDesc

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A brief description of an organization’s line of business, based on its SIC code. Maximum
length is 80 characters.

Site

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of the account’s location, for example Headquarters or London. Label is
Account Site. Maximum of 80 characters.

TickerSymbol

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The stock market symbol for this account. Maximum of 20 characters.

Tradestyle

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A name, different from its legal name, that an organization may use for conducting business.
Similar to “Doing business as” or “DBA”. Maximum length is 255 characters.

184

Standard Objects

Field Name

Account

Details
Note: This field is only available to organizations that use Data.com Prospector or
Data.com Clean.

Type

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Type of account, for example, Customer, Competitor, or Partner.

Website

Type
url
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The website of this account. Maximum of 255 characters.

YearStarted

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when an organization was legally established. Maximum length is 4 characters.
Note: This field is only available to organizations that use Data.com Prospector or
Data.com Clean.

IsPersonAccount Fields
These fields are the subset of person account fields that are contained in the child person contact record of each person account. If the
IsPersonAccount field has the value false, the following fields have a null value and can't be modified. If true, the fields
contain the value indicated in the Description column in the following table and can be modified.
Person accounts are not enabled by default.
Field Name

Details

FirstName

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
First name of the person for a person account. Maximum size is 40 characters.

185

Standard Objects

Account

Field Name

Details

LastName

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Last name of the person for a person account. Required if the record type is a person account
record type. Maximum size is 80 characters.

MiddleName

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Middle name of the person for a person account. Maximum size is 40 characters. Contact
Salesforce Customer Support to enable this field.

PersonAssistantName

Type
string
Properties
Create, Filter, Nillable, Update
Description
The person account’s assistant name. Label is Assistant. Maximum size is 40 characters.

PersonAssistantPhone

Type
phone
Properties
Create, Filter, Nillable, Update
Description
The person account’s assistant phone. Label is Asst. Phone. Maximum size is 40 characters.

PersonBirthDate

Type
date
Properties
Create, Filter, Nillable, Update
Description
The assistant name. Label is Birthdate.

186

Standard Objects

Field Name

Account

Details
Note: The year portion of the PersonBirthDate field is ignored in filter criteria,
including report filters, list view filters, and SOQL queries. For example, the following
SOQL query returns person accounts with birthdays later in the year than today:
SELECT FirstName, LastName, PersonBirthDate
FROM Account
WHERE Birthdate > TODAY

PersonContactId

Type
reference
Properties
Filter, Nillable, Update
Description
The ID for the contact associated with this person account. Label is Contact ID.

PersonDepartment

Type
string
Properties
Create, Filter, Nillable, Update
Description
The department. Label is Department. Maximum size is 80 characters.

PersonEmail

Type
email
Properties
Create, Filter, Nillable, Update
Description
Email address for thisperson account. Label is Email.

PersonEmailBouncedDate

Type
dateTime
Properties
Create, Filter, Nillable, Update
Description
If bounce management is activated and an email sent to the person account bounces, the
date and time the bounce occurred.

PersonEmailBouncedReason Type

string
Properties
Create, Filter, Nillable, Update

187

Standard Objects

Field Name

Account

Details
Description
If bounce management is activated and an email sent to the person account bounces, the
reason the bounce occurred

PersonHasOptedOutOfEmail Type

boolean
Properties
Create, Filter, Nillable, Update
Description
Indicates whether the person account has opted out of email (true) or not (false). Label
is Email Opt Out.
PersonHomePhone

Type
phone
Properties
Create, Filter, Nillable, Update
Description
The home phone number for this person account. Label is Home Phone.

PersonLastCURequestDate Type

dateTime
Properties
Create, Filter, Nillable, Update
Description
The last date that this person account was requested. Label is Last Stay-in-Touch Request
Date.
PersonLastCUUpdateDate

Type
dateTime
Properties
Create, Filter, Nillable, Update
Description
The last date a person account was updated. Label is Last Stay-in-Touch Save Date.

PersonLeadSource

Type
picklist
Properties
Create, Filter, Nillable, Update
Description
The person account’s lead source. Label is Lead Source.

188

Standard Objects

Account

Field Name

Details

PersonMailingAddress

Type
address
Properties
Filter, Nillable
Description
The compound form of the person account mailing address. Read-only. See Address
Compound Fields for details on compound address fields.

PersonMailingCity

Type
string
Properties
Create, Filter, Nillable, Update
Description
Details about the person account’s mailing city. Labels are Mailing City, Mailing Country,
Postal Code, and State. Maximum size for city and country is 40 characters. Maximum size
for postal code and state is 20 characters.

PersonMailingGeocodeAccuracy Type

picklist
Properties
Retrieve, Query, Restricted picklist, Nillable
Description
Accuracy level of the geocode for the person’s mailing address. See Compound Field
Considerations and Limitations for details on geolocation compound fields.
PersonMailingLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with PersonMailingLongitude to specify the precise geolocation of a person
account’s mailing address. Acceptable values are numbers between –90 and 90 with up to
15 decimal places. See Compound Field Considerations and Limitations for details on
geolocation compound fields.

PersonMailingLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with PersonMailingLatitude to specify the precise geolocation of a person
account’s mailing address. Acceptable values are numbers between –180 and 180 with up

189

Standard Objects

Field Name

Account

Details
to 15 decimal places. See Compound Field Considerations and Limitations on page 42 for
details on geolocation compound fields.

PersonMailingStreet

Type
textarea
Properties
Create, Filter, Nillable, Update
Description
The mailing street address for this person account. Label is Mailing Street. Maximum size
is 255 characters.

PersonMobilePhone

Type
phone
Properties
Create, Filter, Nillable, Update
Description
The mobile phone number for this person account. Label is Mobile.

•

PersonOtherCity

Type
string

•

PersonOtherCountry

•

PersonOtherPostalCode Properties

•

PersonOtherState

Create, Filter, Nillable, Update
Description
Details about the alternate address for this person account. Labels are Other City, Other
Country, Other Zip/Postal Code, and Other State.

• PersonOtherCountryCode Type
picklist
• PersonOtherStateCode
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO country or state code for the alternate address of the person account.
PersonOtherLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with PersonOtherLongitude to specify the precise geolocation of a person
account’s alternate address. Acceptable values are numbers between –90 and 90 with up
to 15 decimal places. See Compound Field Considerations and Limitations for details on
geolocation compound fields.

190

Standard Objects

Account

Field Name

Details

PersonOtherLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with PersonOtherLatitude to specify the precise geolocation of a person
account’s alternate address. Acceptable values are numbers between –180 and 180 with up
to 15 decimal places. See Compound Field Considerations and Limitations for details on
geolocation compound fields.

PersonOtherPhone

Type
phone
Properties
Create, Filter, Nillable, Update
Description
The alternate phone number for this person account. Label is Other Phone.

PersonOtherStreet

Type
textarea
Properties
Create, Filter, Nillable, Update
Description
The person account’s alternate street address. Label is Other Street.

PersonTitle

Type
string
Properties
Create, Filter, Nillable, Update
Description
The person account’s title. Label is Title. Maximum size is 80 characters.

Suffix

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name suffix of the person for a person account. Maximum size is 40 characters. Contact
Salesforce Customer Support to enable this field.

Note: If you are importing Account data into Salesforce and need to set the value for an audit field, such as CreatedDate,
contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself.

191

Standard Objects

AccountContactRelation

Usage
Use this object to query and manage accounts in your organization. Client applications can create, update, delete, or query Attachment
records associated with an account via the API.
Client applications can also create or update account objects by converting a Lead via the convertLead() call.
If the values in the IsPersonAccount Fields are not null, you can't change IsPersonAccount to false, or an error occurs.
SEE ALSO:
AccountShare
AccountTeamMember
Person Account Record Types
AccountHistory

AccountContactRelation
Represents a relationship between a contact and one or more accounts.
This object is available in API version 37.0. The AccountContactRelation object supports person accounts. That means that a person
account can be either a related contact on a business account or a related account on a contact. A person account can also be related
to another person account as either a related contact or related account.

Supported Calls
create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),update(),upsert()

Special Access Rules
Fields
Field Name

Details

AccountContactRelationshipCurrency Type

picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Available only for organizations with the multicurrency feature enabled. Contains
the ISO code for any currency allowed by the organization.
AccountId

Type
reference
Properties
Create, Filter, Group, Sort

192

Standard Objects

Field Name

AccountContactRelation

Details
Description
ID of the account that is related to the contact. Field can't be modified when
updating existing account-contact relationship records.

ContactId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the contact that is related to the account. Field can't be modified when
updating existing account-contact relationship records.

EndDate

Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date a relationship between a contact and account began. Use with the
Start Date to keep a history of the relationship.

IsActive

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether relationship is active (true) or not (false).

IsDirect

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the account associated with the contact is the contact's primary
account (true) or not (false).

Roles

Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
The contact’s participating role in the account. Values are Business User,
Decision Maker, Economic Buyer, Economic Decision

193

Standard Objects

Field Name

AccountCleanInfo

Details
Maker, Evaluator, Executive Sponsor, Influencer,
Technical Buyer, and Other.

StartDate

Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date a relationship between a contact and account ended. Use with the End
Date to keep a history of the relationship.

Usage
Use this object to associate a single contact record to multiple account records so you can easily track the relationships between the
people and businesses they work with.

AccountCleanInfo
Stores the metadata Data.com Clean uses to determine an account record’s clean status. AccountCleanInfo helps you automate the
cleaning or related processing of account records.
Account Clean Info provides a snapshot of the data in your Salesforce account record and its matched Data.com record at the time the
Salesforce record was cleaned.
Account Clean Info includes a number of bit vector fields, whose component fields each correspond to individual object fields and
provide related data or status information about those fields. For example, the bit vector field IsDifferent has an
IsDifferentState field. If the IsDifferentState field’s value is False, that means the State field value is the same
on the Salesforce account record and its matched Data.com record.
AccountCleanInfo bit vector fields include:
• CleanedBy indicates who (a user) or what (a Clean job) cleaned the account record.
• IsDifferent indicates whether or not a field on the account record has a value that differs from the corresponding field on the
matched Data.com record.
• IsFlaggedWrong indicates whether or not a field on the account record has a value that is flagged as wrong to Data.com.
• IsReviewed indicates whether or not a field on the account record is in a Reviewed state, which means that the value was
reviewed but not accepted.
Their individual bits are defined here.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()

194

Standard Objects

AccountCleanInfo

Fields
Field Name

Details

AccountId

Type
reference
Properties
Filter, Group, Sort
Description
The unique, system-generated ID assigned when the account record was created.

AccountSite

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Information about the account’s location, such as single location, headquarters,
or branch.

Address

Type
address
Properties
Filter, Nillable
Description
The compound form of the address. Read-only. See Address Compound Fields
for details on compound address fields.

AnnualRevenue

Type
currency
Properties
Filter, Nillable, Sort
Description
Estimated annual revenue of the account.

City

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of the account.

CleanedByJob

Type
boolean

195

Standard Objects

Field Name

AccountCleanInfo

Details
Properties
Filter
Description
Indicates whether the account record was cleaned by a Data.com Clean job
(true) or not (false).

CleanedByUser

Type
boolean
Properties
Filter
Description
Indicates whether the account record was cleaned by a Salesforce user (true)
or not (false).

CompanyName

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the company.

CompanyStatusDataDotCom

Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
The status of the company per Data.com. Values are: Company is In
Business per Data.com or Company is Out of Business
per Data.com.

Country

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of the account.

DandBCompanyDunsNumber

Type
string
Properties
Filter, Group, Nillable, Sort

196

Standard Objects

Field Name

AccountCleanInfo

Details
Description
The D-U-N-S Number on the D&B Company record (if any) that is linked to the
account.

DataDotComId

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The ID Data.com maintains for the company.

Description

Type
textarea
Properties
Nillable
Description
A description of the account.

DunsNumber

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit
number assigned to every business location in the Dun & Bradstreet database
that has a unique, separate, and distinct operation. D-U-N-S numbers are used
by industries and organizations around the world as a global standard for business
identification and tracking.

DunsRightMatchConfidence

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The account’s DUNSRight confidence code.

DunsRightMatchGrade

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The account’s DUNSRight match grade.

197

Standard Objects

AccountCleanInfo

Field Name

Details

Fax

Type
phone
Properties
Filter, Group, Nillable, Sort
Description
The account’s fax number.

Industry

Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
The industry the account belongs to.

IsDifferentAccountSite

Type
boolean
Properties
Filter
Description
Indicates whether the account’s AccountSite field value is different from
the corresponding value on its matched Data.com record (true) or not (false).

IsDifferentAnnualRevenue

Type
boolean
Properties
Filter
Description
Indicates whether the account’s AnnualRevenue field value is different from
the corresponding value on its matched Data.com record (true) or not (false).

IsDifferentCity

Type
boolean
Properties
Filter
Description
Indicates whether the account’s City field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentCompanyName

Type
boolean
Properties
Filter

198

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s AccountName field value is different from
the corresponding value on its matched Data.com record (true) or not (false).

IsDifferentCountry

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Country field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentCountryCode

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Country Code field value is different from
the corresponding value on its matched Data.com record (true) or not (false).

IsDifferentDandBCompanyDunsNumber Type

boolean
Properties
Filter
Description
Indicates whether the account’s DandBCompanyID field value is different
from the corresponding value on its matched Data.com record (true) or not
(false).
IsDifferentDescription

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Description field value is different from
the corresponding value on its matched Data.com record (true) or not (false).

IsDifferentDunsNumber

Type
boolean
Properties
Filter

199

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s DunsNumber field value is different from the
D-U-N-S Number on its matched Data.com record (true) or not (false).

IsDifferentFax

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Fax field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentIndustry

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Industry field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentNaicsCode

Type
boolean
Properties
Filter
Description
Indicates whether the account’s NaicsCode field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentNaicsDescription

Type
boolean
Properties
Filter
Description
Indicates whether the account’s NaicsDescription field value is different
from the corresponding value on its matched Data.com record (true) or not
(false).

IsDifferentNumberOfEmployees

Type
boolean
Properties
Filter

200

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s NumberOf Employees field value is
different from the corresponding value on its matched Data.com record (true)
or not (false).

IsDifferentOwnership

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Ownership field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentPhone

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Phone field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentPostalCode

Type
boolean
Properties
Filter
Description
Indicates whether the account’s PostalCode field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentSic

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Sic field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentSicDescription

Type
boolean
Properties
Filter

201

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s SicDescription field value is different
from the corresponding value on its matched Data.com record (true) or not
(false).

IsDifferentState

Type
boolean
Properties
Filter
Description
Indicates whether the account’s State field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentStateCode

Type
boolean
Properties
Filter
Description
Indicates whether the account’s State Code field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentStreet

Type
boolean
Properties
Filter
Description
Indicates whether the account’s State field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentTickerSymbol

Type
boolean
Properties
Filter
Description
Indicates whether the account’s TickerSymbol field value is different from
the corresponding value on its matched Data.com record (true) or not (false).

IsDifferentTradestyle

Type
boolean
Properties
Filter

202

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s Tradestyle field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentWebsite

Type
boolean
Properties
Filter
Description
Indicates whether the account’s Website field value is different from the
corresponding value on its matched Data.com record (true) or not (false).

IsDifferentYearStarted

Type
boolean
Properties
Filter
Description
Indicates whether the account’s YearStarted field value is different from
the corresponding value on its matched Data.com record (true) or not (false).

IsFlaggedWrongAccountSite

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s AccountSite field value is flagged as wrong
to Data.com (true) or not (false).

IsFlaggedWrongAddress

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Address field value is flagged as wrong to
Data.com (true) or not (false).

IsFlaggedWrongAnnualRevenue

Type
boolean
Properties
Filter, Update

203

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s AnnualRevenue field value is flagged as
wrong to Data.com (true) or not (false).

IsFlaggedWrongCompanyName

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s CompanyName field value is flagged as wrong
to Data.com (true) or not (false).

IsFlaggedWrongDescription

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Description field value is flagged as wrong
to Data.com (true) or not (false).

IsFlaggedWrongDunsNumber

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s DunsNumber field value is flagged as wrong
to Data.com (true) or not (false).

IsFlaggedWrongFax

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Fax field value is flagged as wrong to Data.com
(true) or not (false).

IsFlaggedWrongIndustry

Type
boolean
Properties
Filter, Update

204

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s Industry field value is flagged as wrong to
Data.com (true) or not (false).

IsFlaggedWrongNaicsCode

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s NaicsCode field value is flagged as wrong
to Data.com (true) or not (false).

IsFlaggedWrongNaicsDescription Type

boolean
Properties
Filter, Update
Description
Indicates whether the account’s NaicsDescription field value is flagged
as wrong to Data.com (true) or not (false).
IsFlaggedWrongNumberOfEmployees Type

boolean
Properties
Filter, Update
Description
Indicates whether the account’s NumberOfEmployees field value is flagged
as wrong to Data.com (true) or not (false).
IsFlaggedWrongOwnership

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Ownership field value is flagged as wrong
to Data.com (true) or not (false).

IsFlaggedWrongPhone

Type
boolean
Properties
Filter, Update

205

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s Phone field value is flagged as wrong to
Data.com (true) or not (false).

IsFlaggedWrongSic

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Sic field value is flagged as wrong to Data.com
(true) or not (false).

IsFlaggedWrongSicDescription

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s SicDescription field value is flagged as
wrong to Data.com (true) or not (false).

IsFlaggedWrongTickerSymbol

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s TickerSymbol field value is flagged as
wrong to Data.com (true) or not (false).

IsFlaggedWrongTradestyle

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Tradestyle field value is flagged as wrong
to Data.com (true) or not (false).

IsFlaggedWrongWebsite

Type
boolean
Properties
Filter, Update

206

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s Website field value is flagged as wrong to
Data.com (true) or not (false).

IsFlaggedWrongYearStarted

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s YearStarted field value is flagged as wrong
to Data.com (true) or not (false).

IsInactive

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the account has been reported to Data.com as Inactive
(true) or not (false).

IsReviewedAccountSite

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s AccountSite field value is in a Reviewed
state (true) or not (false).

IsReviewedAddress

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Address field value is in a Reviewed state
(true) or not (false).

IsReviewedAnnualRevenue

Type
boolean
Properties
Filter, Update

207

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s AnnualRevenue field value is in a
Reviewed state (true) or not (false).

IsReviewedCompanyName

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s CompanyName field value is in a Reviewed
state (true) or not (false).

IsReviewedDandBCompanyDunsNumber Type

boolean
Properties
Filter, Update
Description
Indicates whether the account’s DandBCompanyID field value is in a
Reviewed state (true) or not (false).
IsReviewedDescription

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Description field value is in a Reviewed
state (true) or not (false).

IsReviewedDunsNumber

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s DunsNumber field value is in a Reviewed
state (true) or not (false).

IsReviewedFax

Type
boolean
Properties
Filter, Update

208

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s Fax field value is in a Reviewed state (true)
or not (false).

IsReviewedIndustry

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Industry field value is in a Reviewed
state (true) or not (false).

IsReviewedNaicsCode

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s NaicsCode field value is in a Reviewed
state (true) or not (false).

IsReviewedNaicsDescription

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s NaicsDescription field value is in a
Reviewed state (true) or not (false).

IsReviewedNumberOfEmployees

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s NumberOfEmployees field value is in a
Reviewed state (true) or not (false).

IsReviewedOwnership

Type
boolean
Properties
Filter, Update

209

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s Ownership field value is in a Reviewed
state (true) or not (false).

IsReviewedPhone

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Phone field value is in a Reviewed state
(true) or not (false).

IsReviewedSic

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Sic field value is in a Reviewed state (true)
or not (false).

IsReviewedSicDescription

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s SicDescription field value is in a
Reviewed state (true) or not (false).

IsReviewedTickerSymbol

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s TickerSymbol field value is in a Reviewed
state (true) or not (false).

IsReviewedTradestyle

Type
boolean
Properties
Filter, Update

210

Standard Objects

Field Name

AccountCleanInfo

Details
Description
Indicates whether the account’s Tradestyle field value is in a Reviewed
state (true) or not (false).

IsReviewedWebsite

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s Website field value is in a Reviewed state
(true) or not (false).

IsReviewedYearStarted

Type
boolean
Properties
Filter, Update
Description
Indicates whether the account’s YearStarted field value is in a Reviewed
state (true) or not (false).

LastMatchedDate

Type
dateTime
Properties
Filter, Sort
Description
The date the account record was last matched and linked to a Data.com record.

LastStatusChangedById

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of who or what last changed the record’s Clean Status field value:
a Salesforce user or a Clean job.

LastStatusChangedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date on which the record’s Clean Status field value was last changed.

211

Standard Objects

AccountCleanInfo

Field Name

Details

Latitude

Type
double
Properties
Filter, Nillable, Sort
Description
Used with Longitude to specify the precise geolocation of a billing address.
Data not currently provided.

Longitude

Type
double
Properties
Filter, Nillable, Sort
Description
Used with Latitude to specify the precise geolocation of a billing address.
Data not currently provided.

NaicsCode

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The six-digit North American Industry Classification System (NAICS) code is the
standard used by business and government to classify business establishments
into industries, according to their economic activity for the purpose of collecting,
analyzing, and publishing statistical data related to the U.S. business economy.

NaicsDescription

Type
string
Properties
Filter, Group, Nillable, Sort
Description
A brief description of an organization’s line of business, based on its NAICS code.

Name

Type
string
Properties
Filter, Group, Sort, Update
Description
Field label is Account Clean Info Name. The name of the account. Maximum
size is 255 characters.

212

Standard Objects

AccountCleanInfo

Field Name

Details

NumberOfEmployees

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of employees working at the account.

Ownership

Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
Ownership type for the account, for example Private, Public, or Subsidiary.

Phone

Type
phone
Properties
Filter, Group, Nillable, Sort
Description
The phone number for the account.

PostalCode

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of the account.

Sic

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Standard Industrial Classification code of the company’s main business
categorization, for example, 57340 for Electronics.

SicDescription

Type
string
Properties
Filter, Group, Nillable, Sort

213

Standard Objects

Field Name

AccountCleanInfo

Details
Description
A brief description of an organization’s line of business, based on its SIC code.

State

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of the account.

Street

Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of the account.

TickerSymbol

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The stock market symbol for the account.

Tradestyle

Type
string
Properties
Filter, Group, Nillable, Sort
Description
A name, different from its legal name, that an organization can use for conducting
business. Similar to “Doing business as” (DBA).

Website

Type
url
Properties
Filter, Group, Nillable, Sort
Description
The website of the account.

YearStarted

Type
string

214

Standard Objects

Field Name

AccountCleanInfo

Details
Properties
Filter, Group, Nillable, Sort
Description
The year the company was established or the year when current ownership or
management assumed control of the company.

Usage
Administrators can modify a limited set of AccountCleanInfo fields from the Account Clean Info page.
Developers can create triggers that read the Account Clean Info fields to help automate the cleaning or related processing of account
records. For example, you might create a trigger that reads the Clean Status field on the Account object. If an account record’s
Clean Status field value is Different but the record has no Billing Street value, the trigger could update the record’s
status to Not Compared.
Create triggers that read AccountCleanInfo fields to help automate the cleaning or related processing of account records. For example:
• Keep account records’ status InSync if the only difference from matched records is the Phone format (for example, (415)
353-8000 on the account record versus 415 353 8000 on the matched Data.com record).
trigger AccountPhoneTrigger on Account (before update) {
for (Account account: Trigger.new) {
Account oldAccount = Trigger.oldMap.get(account.ID);
if (account.CleanStatus == 'Different') {
List cleanInfo = [Select Id, IsDifferentPhone,
IsReviewedPhone, Phone from AccountCleanInfo where AccountId = :account.Id];
if (cleanInfo.size() > 0 && cleanInfo[0].IsDifferentPhone &&
cleanInfo[0].Phone.StartsWith('+')) {
// if Data.com phone number is marked Different but starts with ‘+’,
ignore this
// and set the status to “Reviewed”
AccountCleanInfo cleanInfoToUpdate = new AccountCleanInfo();
cleanInfoToUpdate.Id = cleanInfo[0].Id;
cleanInfoToUpdate.IsReviewedPhone = true;
update cleanInfoToUpdate;
account.CleanStatus = 'Reviewed';
}
}
}
}

• Create a customized set of Industry field values for accounts. Use triggers to map values from fields on imported or cleaned
records onto a standard set of values.
• Read the CleanStatus field value on the Account object. If that value is Different, but a Salesforce record has no street
address value, update the record’s status to Not Compared.

215

Standard Objects

AccountContactRole

AccountContactRole
Represents the role that a Contact plays on an Account.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Special Access Rules
Customer Portal users can't access this object.

Fields
Field

Details

AccountId

Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. ID of the Account.

ContactId

Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Required. ID of the Contact associated with this account.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

IsPrimary

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update

216

Standard Objects

Field

AccountFeed

Details
Description
Specifies whether the Contact plays the primary role on the Account (true) or not (false).
Note that each account has only one primary contact role. Label is Primary. Default value
is false.

Role

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of the role played by the Contact on this Account, such as Decision Maker, Approver,
Buyer, and so on. Must be unique—there can't be multiple records in which the
AccountId, ContactId, and Role values are identical. Different contacts can play
the same role on the same account. A contact can play different roles on the same account.

Usage
Use this object to define the role that a Contact plays on a given Account within the context of a specific Opportunity.
SEE ALSO:
Account
Contact

AccountFeed
Represents a single feed item on an account record detail page. This object is available in API version 18.0 and later.
An account feed shows changes to an account record for fields that are tracked in feeds, and posts and comments about the record. It
is a useful way to stay up-to-date with changes made to accounts in Salesforce.

Supported Calls
delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions:
• “Modify All Data”
• “Modify All” on the Account object
• “Moderate Chatter”
Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.

217

Standard Objects

AccountFeed

Fields
Field

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The content of AccountFeed. Required when Type is TextPost. Optional when Type
is ContentPost or LinkPost. This field is the message that appears in the feed.

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of FeedComments associated with this feed item.
Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a
comment is published. For example, say you comment on a post that already has one
published comment and your comment triggers moderation. Now there are two
comments on the post, but the count says there's only one. In a moderated feed, your
comment isn’t counted until it's approved by an admin or a person with
“CanApproveFeedPostAndComment” or “ModifyAllData” permission.
This has implications for how you retrieve feed comments. In a moderated feed, rather
than retrieving comments by looping through CommentCount, go through pagination
until end of comments is returned.

ConnectionId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field
contains the ID of the system administrator. The ConnectionId contains the ID of the
PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your
organization.

ContentData

Type
base64
Properties
Nillable

218

Standard Objects

Field

AccountFeed

Details
Description
Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded
file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to
ContentPost.

ContentDescription

Type
textarea
Properties
Nillable, Sort
Description
Available in API version 36.0 and earlier only. The description of the file specified in
ContentData.

ContentFileName

Type
string
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. This field is required if Type is
ContentPost.The name of the file uploaded to the feed. Setting ContentFileName
automatically sets Type to ContentPost.

ContentSize

Type
int
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the
feed. This field is read-only and is automatically determined during insert.

ContentType

Type
string
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed.
This field is read-only and is automatically determined during insert.

CreatedDate

Type
dateTime
Properties
Defaulted on create, Filter, Sort

219

Standard Objects

Field

AccountFeed

Details
Description
Date and time when this record was created. This field is a standard system field.
Ordering by CreatedDateDESC sorts the feed by the most recent feed item.

FeedPostId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
This field was removed in API version 22.0, and is available in earlier versions for backward
compatibility only.
ID of the associated FeedPost. A FeedPost represents the following types of changes in an
FeedItem: changes to tracked fields, text posts, link posts, and content posts.

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if an application migrates
posts and comments from another application into a feed, the InsertedBy value is set
to the ID of the logged-in user.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Standard system field. Indicates whether the record has been moved to the Recycle Bin
(true) or not (false).

isRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the feed item Body contains rich text. Set IsRichText to true if
you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text.
Rich text supports the following HTML tags:
•

220

Standard Objects

Field

AccountFeed

Details
Tip: Though the
tag isn’t supported, you can use
to create lines.
•
•
•
•
•
•
•
•
•
The tag is accessible only via the API and must reference files in Salesforce
similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text
with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text
representation.

LastModifiedDate

Type
dateTime
Properties
Defaulted on create, Filter, Sort
Description
Date and time when a user last modified this record. This field is a standard system field.
When a feed item is created, LastModifiedDate is the same as CreatedDate. If
a FeedComment is inserted on that feed item, then LastModifiedDate becomes the
CreatedDate for that FeedComment. Deleting the FeedComment does not change the
LastModifiedDate.
Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed
item or comment.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of FeedLikes associated with this feed item.

LinkUrl

Type
url

221

Standard Objects

Field

AccountFeed

Details
Properties
Nillable, Sort
Description
The URL of a LinkPost.

NetworkScope

Type
picklist
Properties
Group, Nillable, Restricted picklist, Sort
Description
Specifies whether this feed item is available in the default community, a specific community,
or all communities. This field is available in API version 26.0 and later, if Salesforce Communities
is enabled for your organization.
NetworkScope can have the following values:

• NetworkId—The ID of the community in which the FeedItem is available. If left empty,
the feed item is only available in the default community.
• AllNetworks—The feed item is available in all communities.
Note the following exceptions for NetworkScope:
• Only feed items with a Group or User parent can set a NetworkId or a null value for
NetworkScope.
• For feed items with a record parent, users can set NetworkScope only to
AllNetworks.
• You can’t filter a FeedItem on the NetworkScope field.
ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the account record that is tracked in the feed. The feed is displayed on the detail page
for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a ContentPost. This field is null for all
posts except ContentPost.

222

Standard Objects

AccountFeed

Field

Details

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and
this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of feed item:
• ActivityEvent—indirectly generated event when a user or the API adds a Task
associated with a feed-enabled parent record (excluding email tasks on cases). Also
occurs when a user or the API adds or updates a Task or Event associated with a case
record (excluding email and call logging).
For a recurring Task with CaseFeed disabled, one event is generated for the series only.
For a recurring Task with CaseFeed enabled, events are generated for the series and each
occurrence.
• AdvancedTextPost—created when a user posts a group announcement.
• AnnouncementPost—Not used.
• ApprovalPost—generated when a user submits an approval.
• BasicTemplateFeedItem—Not used.
• CanvasPost—a post made by a canvas app posted on a feed.
• CollaborationGroupCreated—generated when a user creates a public group.
• CollaborationGroupUnarchived—Not used.
• ContentPost—a post with an attached file.
• CreatedRecordEvent—generated when a user creates a record from the publisher.
• DashboardComponentAlert—generated when a dashboard metric or gauge
exceeds a user-defined threshold.
• DashboardComponentSnapshot—created when a user posts a dashboard
snapshot on a feed.
• LinkPost—a post with an attached URL.
• PollPost—a poll posted on a feed.
• ProfileSkillPost—generated when a skill is added to a user’s Chatter profile.
• QuestionPost—generated when a user posts a question.
• ReplyPost—generated when Chatter Answers posts a reply.
• RypplePost—generated when a user creates a Thanks badge in Work.com.

223

Standard Objects

Field

AccountFeed

Details
• TextPost—a direct text entry on a feed.
• TrackedChange—a change or group of changes to a tracked field.
• UserStatus—automatically generated when a user adds a post. Deprecated.
The following values appear in the Type picklist for all feed objects but apply only to
CaseFeed:
• CaseCommentPost—generated event when a user adds a case comment for a case
object
• EmailMessageEvent—generated event when an email related to a case object is
sent or received
• CallLogPost—generated event when a user logs a call for a case through the user
interface. CTI calls also generate this event.
• ChangeStatusPost—generated event when a user changes the status of a case
• AttachArticleEvent—generated event when a user attaches an article to a case
Note: If you set Type to ContentPost, also specify ContentData and
ContentFileName.

Visibility

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies whether this feed item is available to all users or internal users only. This field is
available in API version 26.0 and later, if Salesforce Communities is enabled for your
organization.
Visibility can have the following values:

• AllUsers—The feed item is available to all users who have permission to see the
feed item.
• InternalUsers—The feed item is available to internal users only.
Note the following exceptions for Visibility:
• For record posts, Visibility is set to InternalUsers for all internal users by
default.
• External users can set Visibility only to AllUsers.
• On user and group posts, only internal users can set Visibility to
InternalUsers.

224

Standard Objects

AccountHistory

Usage
Use this object to track changes for an account record.
SEE ALSO:
Account
EntitySubscription
NewsFeed
UserProfileFeed

AccountHistory
Represents the history of changes to the values in the fields of an account. This object is available in versions 11.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

AccountId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the Account. Label is Account ID.

225

Standard Objects

AccountOwnerSharingRule

Field

Details

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The latest value of the field before it was changed.

Usage
Use this object to identify changes to an account.
This object respects field level security on the parent object.
SEE ALSO:
Account

AccountOwnerSharingRule
Represents the rules for sharing an account with a User other than the owner.
Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer
support to enable access to this object for your org.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Special Access Rules
Customer Portal users can't access this object.

226

Standard Objects

AccountOwnerSharingRule

Fields
Field

Details

AccountAccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Update
Description
A value that represents the type of sharing being allowed. The possible values are:
• Read
• Edit
• All (This value isn’t valid for creating or updating.)

CaseAccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
A value that represents the type of access granted to the target Group for all child cases. The
possible values are:
• None
• Read
• Edit

ContactAccessLevel

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
A value that represents the type of access granted to the target Group, UserRole, or User for
any associated contacts. The possible values are:
• None
• Read
• Edit
Note: When DefaultContactAccess is set to Controlled by Parent,
you can’t create or update this field.

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update

227

Standard Objects

Field

AccountOwnerSharingRule

Details
Description
A description of the sharing rule. Maximum size is 1000 characters. This field is available in
API version 29.0 and later.

DeveloperName

Type
string
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores and
alphanumeric characters, and must be unique in your org. It must begin with a letter, not
include spaces, not end with an underscore, and not contain two consecutive underscores.
In managed packages, this field prevents naming conflicts on package installations. With
this field, a developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization. Corresponds to Rule Name in the user interface.
This field is available in API version 24.0 and later.
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

GroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the source group. An Account owned by a User in the source Group
triggers the rule to give access.

OpportunityAccessLevel Type

picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
A value that represents the type of access granted to the target Group for any associated
Opportunity. The possible values are:
• None
• Read
• Edit
Name

Type
string

228

Standard Objects

Field

AccountPartner

Details
Properties
Create, Filter, Group, Sort, Update
Description
Label of the sharing rule as it appears in the user interface. Limited to 80 characters.
Corresponds to Label on the user interface.

UserOrGroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the User or Group being granted access.

Usage
Use this object to manage the sharing rules for accounts. General sharing and territory management-related sharing use this object. For
example, the following code creates an account owner sharing rule between two public groups, which can also contain portal users.
AccountOwnerSharingRule rule = new AccountOwnerSharingRule();
rule.setName("RuleName"); // Set the sharing rule name
rule.setDeveloperName("RuleDeveloperName"); // Set the sharing rule developer name
rule.setGroupId("00Gx00000000000"); // Set the group of users to share records from
rule.setUserOrGroupId("00Gx00000000001"); // Set the group of users to share records to
rule.setAccountAccessLevel("Edit");
rule.setOpportunityAccessLevel("Read");
rule.setCaseAccessLevel("None");
connection.create(rule);

SEE ALSO:
Account
AccountShare
Metadata API Developer Guide: SharingRules

AccountPartner
This read-only object represents a partner relationship between two Account objects. It is automatically created when a Partner object
is created for a partner relationship between two accounts.
Note: This object is completely distinct and independent of Account records that have been enabled for the partner portal.

Supported Calls
describeSObjects(), query(), retrieve()

229

Standard Objects

AccountPartner

Special Access Rules
Customer Portal users can't access this object.

Fields
Field

Details

AccountFromId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the main Account in the partner relationship.

AccountToId

Type
reference
Properties
Filter, Group, Nillable, Sort,
Description
ID of the partner Account in the partner relationship.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

IsPrimary

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the AccountPartner is the main account’s primary partner (true) or not
(false).

OpportunityId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the opportunity in a partner relationship with the related account.

230

Standard Objects

AccountShare

Field

Details

Role

Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
The UserRole that the partner Account has on the main Account. For example, Consultant
or Distributor.

Creating an Account-Account Partner Relationship
When you create a partner relationship between two accounts (when you create a Partner object and specify the AccountFromId),
the API automatically creates two AccountPartner objects, one for the forward relationship and one for the reverse. For example, if you
create a Partner object with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId, the API automatically
creates two AccountPartner objects:
• The forward relationship AccountPartner with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId.
• The reverse relationship AccountPartner with “Acme Consulting” as the AccountFromId and “Acme, Inc.” as the AccountToId.
• The value of the Role field in the reverse relationship AccountPartner is set to the PartnerRole object ReverseRole value
associated with the value of the Role field in the forward relationship AccountPartner.
This mapping allows the API to manage the objects and their relationship efficiently.
SEE ALSO:
Partner
OpportunityPartner

AccountShare
Represents a sharing entry on an Account.

Supported Calls
describeSObjects(), create(), delete(), query(), retrieve(), update(), upsert()

Special Access Rules
Customer Portal users can't access this object.

Fields
The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the
default settings of such fields.

231

Standard Objects

AccountShare

Field

Details

AccountAccessLevel

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Level of access that the User or Group has to the Account. The possible values are:
• Read
• Edit
• All (This value isn't valid for create or update calls.)
This field must be set to an access level that is at least equal to the organization’s default
Account access level. In addition, either this field, the OpportunityAccessLevel
field, or the CaseAccessLevel field must be set higher than the organization’s default
access level.

AccountId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the Account associated with this sharing entry. This field can't be updated.

CaseAccessLevel

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Level of access that the User or Group has to cases associated with the account. The possible
values are:
• None
• Read
• Edit
This field must be set to an access level that is at least equal to the organization’s default
CaseAccessLevel. This field can't be updated via the API if the
AccountAccessLevel field is set to All. You can't update this field for the associated
account owner via the API. You must update the account owner’s CaseAccessLevel
via the Salesforce user interface.

ContactAccessLevel

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort

232

Standard Objects

Field

AccountShare

Details
Description
Level of access that the User or Group has to contacts associated with the account. The
possible values are:
• None
• Read
• Edit
This field must be set to an access level that is at least equal to the organization’s default
ContactAccessLevel. This field can't be updated via the API if the
ContactAccessLevel field is set to “Controlled by Parent.” You can't update this field
for the associated account owner using the API. You must update the account owner’s
ContactAccessLevel via the Salesforce user interface.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

OpportunityAccessLevel

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Level of access that the User or Group has to opportunities associated with the Account. The
possible values are:
• None
• Read
• Edit
This field must be set to an access level that is at least equal to the organization’s default
opportunity access level. This field can’t be updated via the API if the
AccountAccessLevel field is set to All. You can't use the API to update this field
for the associated Account owner. You must update the Account owner’s
opportunityAccessLevel via the Salesforce user interface.

RowCause

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort

233

Standard Objects

Field

AccountShare

Details
Description
Reason that this sharing entry exists. You can only write to this field when its value is either
omitted or set to Manual (default). You can create a value for this field in API versions 32.0
and later with the correct organization-wide sharing settings.
Valid values include:
• Manual—The User or Group has access because a User with “All” access manually
shared the Account with the user or group.
• ImplicitParent—The User or Group has access because they’re the owner of or
have sharing access to records related to the account, such as opportunities, cases,
contacts, contracts, or orders.
• Owner—The User is the owner of the Account
• Team—The User or Group has team access (is an AccountTeamMember).
• Rule—The User or Group has access via an Account sharing rule.

UserOrGroupId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the User or Group that has been given access to the Account. This field can't be updated.

Usage
This object allows you to determine which users and groups can view or edit Account records owned by other users.
If you attempt to create an AccountShare record that matches an existing record, the request updates any modified fields and returns
the existing record.
For example, the following code finds all accounts owned by a user and manually shares them to a portal user.
QueryResult result = conn.query("SELECT Id FROM Account WHERE OwnerId = '005D0000001LPFB'");
// Create a new AccountShare object
List shares = new ArrayList();
for (SObject rec : result.getRecords()) {
AccountShare share = new AccountShare();
share.setAccountId(rec.getId());
//Set the portal user Id to share the accounts with
share.setUserOrGroupId("003D000000QA8Tl");
share.setAccountAccessLevel("Edit");
share.setOpportunityAccessLevel("Read");
share.setCaseAccessLevel("Edit");
shares.add(share);
}
conn.create(shares.toArray(new AccountShare[shares.size()]));

This code shares the accounts that the user owns at the time, but not those accounts that are owned later. For these types of shares,
use an owner-based sharing rule, such as AccountOwnerSharingRule.

234

Standard Objects

AccountTag

If an account is shared in multiple ways with a user, you don’t always see multiple sharing records. If a user has access to an account for
one or more of the following RowCause values, the records in the AccountShare object are compressed into one record with the highest
level of access.
• ImplicitParent
• Manual
• Owner
SEE ALSO:
Account
CaseShare
LeadShare
OpportunityShare

AccountTag
Associates a word or short phrase with an Account.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve()

Fields
Field Name

Details

ItemId

Type
reference
Properties
Create, Filter
Description
ID of the tagged item.

Name

Type
string
Properties
Create, Filter
Description
Name of the tag. If this value does not already exist, a new TagDefinition is created and
becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name
becomes the parent of this Tag object. Parent relationships are created automatically.

TagDefinitionId

Type
reference

235

Standard Objects

Field Name

AccountTeamMember

Details
Properties
Filter
Description
ID of the parent TagDefinition object that owns the tag.

Type

Type
picklist
Properties
Create, Filter, Restricted picklist
Description
Defines the visibility of a tag.
Valid values:
• Public—The tag can be viewed and manipulated by all users in an organization.
• Personal—The tag can be viewed or manipulated only by a user with a matching
OwnerId.

Usage
AccountTag stores the relationship between its parent TagDefinition and the Account being tagged. Tag objects act as metadata,
allowing users to describe and organize their data.
When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting
a TagDefinition sends it to the Recycle Bin, along with any associated tag entries.

AccountTeamMember
Represents a User who is a member of an Account team.
See also UserAccountTeamMember, which represents a User who is on the default account team of another user.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), update(), upsert()

Special Access Rules
• This object is available only for Enterprise, Unlimited, and Performance Edition users who have enabled the account team functionality.
• Customer Portal users can't access this object.

236

Standard Objects

AccountTeamMember

Fields
Field Name

Details

AccountAccessLevel

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Level of access that the User has to the Account. The possible values are:
• Read
• Edit
• All
This field must be set to an access level that is at least equal to the organization’s default
Account access level. In addition, the users’s AccountAccessLevel,
ContactAccessLevel, OpportunityAccessLevel, or CaseAccessLevel
field must be set higher than the organization’s default access level.

AccountId

Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. ID of the Account to which this user is a team member. Must be a valid account
ID.

CaseAccessLevel

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Level of access that the User has to cases associated with the account. The possible values
are:
• None
• Read
• Edit
This field must be set to an access level that is at least equal to the organization’s default
case access level. In addition, the users’s AccountAccessLevel,
ContactAccessLevel, OpportunityAccessLevel, or CaseAccessLevel
field must be set higher than the organization’s default access level. This field is available in
API version 37.0 and later.

237

Standard Objects

AccountTeamMember

Field Name

Details

ContactAccessLevel

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Level of access that the User has to contacts associated with the account. The possible values
are:
• None
• Read
• Edit
This field must be set to an access level that is at least equal to the organization’s default
contact access level. In addition, the users’s AccountAccessLevel,
ContactAccessLevel, OpportunityAccessLevel, or CaseAccessLevel
field must be set higher than the organization’s default access level. This field is available in
API version 37.0 and later.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.
Note: An AccountTeamMember record that is deleted is not moved to the Recycle Bin.
A deleted AccountTeamMember record can’t be undeleted unless the record was
cascade-deleted when deleting a related Account. For directly deleted
AccountTeamMember records, don’t use the isDeleted field to detect deleted records in
SOQL queries or queryAll() calls. Instead, use getDeleted().

OpportunityAccessLevel

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Level of access that the User has to opportunities associated with the account. The possible
values are:
• None
• Read
• Edit
This field must be set to an access level that is at least equal to the organization’s default
opportunity access level. In addition, the users’s AccountAccessLevel,

238

Standard Objects

Field Name

AccountTeamMember

Details
ContactAccessLevel, OpportunityAccessLevel, or CaseAccessLevel
field must be set higher than the organization’s default access level. This field is available in
API version 37.0 and later.

PhotoURL

Type
URL
Properties
Filter, Nillable, Sort, Group
Description
Read only. Retrieves the users Chatter photo URL. This field is available in API version 37.0
and later.

TeamMemberRole

Type
picklist
Properties
Create, Filter, Nillable, Update
Description
Role associated with this team member. One of the valid team member roles defined for
your organization. Label is Team Role.

Title

Type
string
Properties
Filter, Nillable, Sort, Group
Description
Read only. Retrieves the user’s title. This field is available in API version 37.0 and later.

UserId

Type
reference
Properties
Create, Filter
Description
Required. ID of the User who is a member of this account team. Must be a valid User ID.

Usage
Use this object to manage the team members of a particular Account and to specify team member roles for those users on that account.
SEE ALSO:
Account

239

Standard Objects

AccountTerritoryAssignmentRule

AccountTerritoryAssignmentRule
An account assignment rule that assigns accounts to territories based on account fields. Only available if territory management has been
enabled for your organization.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Special Access Rules
Customer Portal users can't access this object.

Fields
Field

Details

BooleanFilter

Type
string
Properties
Create, Filter, Nillable, Update
Description
Advanced filter conditions that were specified for the rule in the online application. For
example, “(1 AND 2) OR 3.”

IsActive

Type
boolean
Properties
Create, Defaulted on create, Filter, Update
Description
Indicates whether the rule is active (true) or inactive (false). Via the API, active rules run
automatically when new accounts are created and existing accounts are edited. The exception
is when the IsExcludedFromRealign field on an account is true, which prevents
account assignment rules from evaluating that account.

IsInherited

Type
boolean
Properties
Create, Defaulted on create, Filter, Update
Description
Indicates whether the rule is an inherited rule (true) or a local rule (false). An inherited
rule also acts upon territories below it in the territory hierarchy. A local rule is created at the
immediate territory and only impacts the immediate territory.

240

Standard Objects

AccountTerritoryAssignmentRuleItem

Field

Details

Name

Type
string
Properties
Create, Filter, Update
Description
A name for the rule. Limit is 80 characters.

TerritoryId

Type
reference
Properties
Create, Filter, Update
Description
ID of the territory where accounts that satisfy this rule are assigned.

Usage
A territory will not have any accounts (with the exception of manually assigned accounts) unless at least one account assignment rule
is active for the territory.
SEE ALSO:
AccountTerritoryAssignmentRuleItem
Territory
UserTerritory

AccountTerritoryAssignmentRuleItem
A row of selection criteria for an AccountTerritoryAssignmentRule object. Only available if territory management has been enabled for
your organization.
AccountTerritoryAssignmentRuleItem can be created or deleted if the BooleanFilter field on its corresponding
AccountTerritoryAssignmentRule object is a null value.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Special Access Rules
Customer Portal users can't access this object.

241

Standard Objects

AccountTerritoryAssignmentRuleItem

Fields
Field

Details

Field

Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
The standard or custom account field to use as a criteria.

Operation

Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
The criteria to apply, such as “equals” or “starts with.”

RuleID

Type
reference
Properties
Create, Filter, Update
Description
ID of the associated AccountTerritoryAssignmentRule.

SortOrder

Type
int
Properties
Create, Filter, Update
Description
The order in which this row is evaluated compared to other
AccountTerritoryAssignmentRuleItem objects for the given AccountTerritoryAssignmentRule.

Value

Type
string
Properties
Create, Filter, Nillable, Update
Description
The field value(s) to evaluate, such as 94105 if the Field is Billing Zip/Postal
Code.

242

Standard Objects

AccountTerritorySharingRule

Usage
• Both standard and custom account fields can be used as criteria for account assignment rules.
• A territory will not have any accounts (with the exception of manually assigned accounts) unless at least one account assignment
rule is active for the territory.
SEE ALSO:
AccountTerritoryAssignmentRule
Territory
UserTerritory

AccountTerritorySharingRule
Represents the rules for sharing an Account within a Territory.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Special Access Rules
Customer Portal users can't access this object.

Fields
Field

Details

AccountAccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
A value that represents the type of sharing being allowed. The possible values are:
• Read
• Edit
• All

CaseAccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update

243

Standard Objects

Field

AccountTerritorySharingRule

Details
Description
A value that represents the type of access granted to the target group for all child cases of
the account. The possible values are:
• None
• Read
• Edit

ContactAccessLevel

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
A value that represents the type of access granted to the target group for all related contacts
on the account. The possible values are:
• None
• Read
• Edit
Note: This field is read only.

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A description of the sharing rule. Maximum size is 1000 characters. This field is available in
API version 29.0 and later.

DeveloperName

244

Standard Objects

Field

AccountTerritorySharingRule

Details
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

GroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the source group. Accounts owned by users in the source territory trigger
the rule to give access.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Label of the sharing rule as it appears in the user interface. Limited to 80 characters.
Corresponds to Label on the user interface.

OpportunityAccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
A value that represents the type of access granted to the target group for all opportunities
associated with the account. The possible values are:
• None
• Read
• Edit

UserOrGroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the user or group being given access, or, if a territory ID, the users assigned
to that territory.

245

Standard Objects

ActionLinkGroupTemplate

Usage
Use this object to manage the sharing rules for a particular object. General sharing and Territory-related sharing use this object.
SEE ALSO:
Account
AccountShare

ActionLinkGroupTemplate
Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed
element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external
server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an action
link group and action links within the group are mutually exclusive. This object is available in API version 33.0 and later.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules
Only users with the “Customize Application” permission can modify or delete this object.

Fields
Field Name

Details

Category

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The location of the action link group within the feed element. Values are:
• Primary—The action link group is displayed in the body of the feed
element.
• Overflow—The action link group is displayed in the overflow menu of
the feed element.

DeveloperName

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the action link group template to use in code.

246

Standard Objects

ActionLinkGroupTemplate

Field Name

Details

ExecutionsAllowed

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The number of times an action link can be executed. Values are:
• Once—An action link can be executed only once across all users.
• OncePerUser—An action link can be executed only once for each user.
• Unlimited—An action link can be executed an unlimited number of
times by each user. If the action link’s actionType is Api or ApiAsync,
you can’t use this value.

HoursUntilExpiration

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of hours from when the action link group is created until it's removed
from associated feed elements and can no longer be executed. The maximum
value is 8,760.

IsPublished

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If true, the action link group template is published. Action link group templates
shouldn’t be published until at least one ActionLinkTemplate is associated with
it. Once set to true, this can’t be set back to false.

Language

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the MasterLabel.

MasterLabel

Type
string
Properties
Create, Filter, Group, Sort, Update

247

Standard Objects

Field Name

ActionLinkTemplate

Details
Description
The name of the action link group template.

NamespacePrefix

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition
organization that creates a managed package has a unique namespace prefix.
Limit: 15 characters. You can refer to a component in a managed package by
using the namespacePrefix__componentName notation.
The namespace prefix can have one of the following values:
• In Developer Edition organizations, the namespace prefix is set to the
namespace prefix of the organization for all objects that support it. There is
an exception if an object is in an installed managed package. In that case,
the object has the namespace prefix of the installed managed package. This
field’s value is the namespace prefix of the Developer Edition organization
of the package developer.
• In organizations that are not Developer Edition organizations,
NamespacePrefix is only set for objects that are part of an installed
managed package. There is no namespace prefix for all other objects.

Usage
Define action link templates in Setup and use ConnectApi in Apex or Chatter REST API to instantiate action links from the templates
and to post feed elements with the action links.
If you delete a published action link group template, you delete all related action link information which includes deleting all action links
that were instantiated using the template from feed items.

ActionLinkTemplate
Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed
element. Clicking an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server
or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. This object is available in API version 33.0
and later.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

248

Standard Objects

ActionLinkTemplate

Special Access Rules
Only users with the “Customize Application” permission can modify or delete this object.

Fields
Field Name

Details

ActionLinkGroupTemplateId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the ActionLinkGroupTemplate with which this action link template is
associated.

ActionUrl

Type
textarea
Properties
Create, Update
Description
The action link URL. For example, a Ui action link URL is a Web page. A
Download action link URL is a link to the file to download. Ui and Download
action link URLs are provided to clients. An Api or ApiAsync action link URL
is a REST resource. Api and ApiAsync action link URLs aren’t provided to
clients. Links to Salesforce can be relative. All other links must be absolute and
start with https://.
Links to resources hosted on Salesforce servers can be relative, starting with a
/. All other links must be absolute and start with https://. This field can
contain context variables and binding variables in the form
{!Bindings.key}, for example,
https://www.example.com/{!Bindings.itemId}. Set the binding
variable’s value when you instantiate the action link group from the template.

Headers

Type
textarea
Properties
Create, Nillable, Update
Description
Template for the HTTP headers sent when corresponding action links are invoked.
This field can be used only for Api and ApiAsync action links. This field can
contain context variables and binding variables in the form
{!Bindings.key}.

249

Standard Objects

ActionLinkTemplate

Field Name

Details

IsConfirmationRequired

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If true, a confirmation dialog appears before the action is executed.

IsGroupDefault

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If true, action links derived from this template are the default or primary action
in their action groups. There can be only one default action per action group.

Label

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A custom label to display on the action link button. If none of the LabelKey
values make sense for an action link, use a custom label. Set the LabelKey
field to None and enter a label name in the Label field.
Action links have four states: new, pending, success, and failed. These strings are
appended to the label for each state:
• Label
• Label Pending
• Label Success
• Label Failed
For example, if the value of Label is “Call Home,” the values of the four action
link states are: Call Home, Call Home Pending, Call Home Success, and Call Home
Failed.
If LabelKey has any value other than None, the Label field is empty.

LabelKey

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Key for the set of labels to display for these action link states: new, pending,
success, failed. For example, the Approve set contains these labels: Approve,

250

Standard Objects

Field Name

ActionLinkTemplate

Details
Pending, Approved, Failed. For a complete list of keys and labels, see Action Links
Labels in the Chatter REST API Developer Guide or the Apex Developer Guide.
If none of the label key values make sense for an action link, set this field to None
and enter a custom label name in the Label field.

LinkType

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of action link. One of these values:
• Api—The action link calls a synchronous API at the action URL. Salesforce
sets the status to SuccessfulStatus or FailedStatus based on
the HTTP status code returned by your server.
• ApiAsync—The action link calls an asynchronous API at the action URL.
The action remains in a PendingStatus state until a third party makes
a request to /connect/action-links/actionLinkId to set the
status to SuccessfulStatus or FailedStatus when the
asynchronous operation is complete.
• Download—The action link downloads a file from the action URL.
• Ui—The action link takes the user to a Web page at the action URL.

Method

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
HTTP method for the action URL. One of these values:
• HttpDelete—Returns HTTP 204 on success. Response body or output
class is empty.
• HttpGet—Returns HTTP 200 on success.
• HttpHead—Returns HTTP 200 on success. Response body or output class
is empty.
• HttpPatch—Returns HTTP 200 on success or HTTP 204 if the response
body or output class is empty.
• HttpPost—Returns HTTP 201 on success or HTTP 204 if the response
body or output class is empty. Exceptions are the batch posting resources
and methods, which return HTTP 200 on success.
• HttpPut—Return HTTP 200 on success or HTTP 204 if the response body
or output class is empty.
Ui and Download action links must use HttpGet.

251

Standard Objects

ActionLinkTemplate

Field Name

Details

Position

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
An integer specifying the position of the action link template relative to other
action links in the group. 0 is the first position.

RequestBody

Type
textarea
Properties
Create, Nillable, Update
Description
Template for the HTTP request body sent when corresponding action links are
invoked. This field can be used only for Api and ApiAsync action links. This
field can contain context variables and binding variables in the form
{!Bindings.key}.

UserAlias

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
If you selected CustomUser or CustomExcludedUser for
UserVisibility, this field is the alias for the custom user. Use the alias in
a template binding to specify the custom user when an action link group is
created using the template.

UserVisibility

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Who can see the action link. This value is set per action link, not per action link
group. One of these values:
• Creator—Only the creator of the action link can see the action link.
• Everyone—Everyone can see the action link.
• EveryoneButCreator—Everyone but the creator of the action link
can see the action link.
• Manager—Only the manager of the creator of the action link can see the
action link.
• CustomUser—Only the custom user can see the action link.

252

Standard Objects

ActivityHistory

Field Name

Details
• CustomExcludedUser—Everyone but the custom user can see the
action link.

Usage
Create action link templates in Setup. Use Apex classes in the ConnectApi namespace or Chatter REST API to instantiate action links
from templates and to post feed elements with the action links.
For information about action links, see “Working with Action Links” in the Apex Developer Guide or the Chatter REST API Developer Guide.

ActivityHistory
This read-only object is displayed in a related list of closed activities—past events and closed tasks—related to an object. It includes
activities for all contacts related to the object. ActivityHistory fields for phone calls are only available if your organization uses Salesforce
CRM Call Center.

Supported Calls
describeSObjects()

Fields
Field

Details

AccountId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the related account, which is determined as follows:
• The account associated with the WhatId, if it exists; or
• The account associated with the WhoId, if it exists; otherwise
• null
For information on IDs, see ID Field Type.

ActivityDate

Type
date
Properties
Filter, Group, Nillable, Sort
Description
Indicates one of the following:

253

Standard Objects

Field

ActivityHistory

Details
• The due date of a task
• The due date of an event if IsAllDayEvent is set to true
This field has a time stamp that is always set to midnight in the Universal Time Coordinated
(UTC) time zone. The time stamp doesn’t represent the time of the activity; don’t attempt
to alter it to accommodate time zone differences. Label is Date.

ActivitySubtype

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Provides standard subtypes to facilitate creating and searching for specific activity subtypes.
This field isn’t updateable.
ActivitySubtype values:

• Task
• Email
• Call
• Event
ActivityType

Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
Represents one of the following values: Call, Meeting, or Other. Label is Type.

AlternateDetailId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of a record the activity is related to which contains more details about the activity.
For example, an activity can be related to an EmailMessage record.

CallDisposition

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit
is 255 characters.

254

Standard Objects

ActivityHistory

Field

Details

CallDurationInSeconds

Type
int
Properties
Filter, Group, Nillable, Sort
Description
Duration of the call in seconds.

CallObject

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name of a call center. Limit is 255 characters.

CallType

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of call being answered: Inbound, Internal, or Outbound.

ConnectionReceivedId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the PartnerNetworkConnection that shared this record with your
organization. This field is available only if your organization has enabled Salesforce to
Salesforce and only in API versions 28.0 and later.

ConnectionSentId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the PartnerNetworkConnection that your organization shared this record
with. This field is available only if your organization has enabled Salesforce to Salesforce, and
only in API versions 28.0 and later. The value is always null. You can use the
PartnerNetworkRecordConnection object to forward records to connections.

255

Standard Objects

ActivityHistory

Field

Details

Description

Type
textarea
Properties
Nillable
Description
Contains a description of the event or task. Limit is 32 KB.

Division

Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
A logical segment of your organization's data. For example, if your company is organized
into different business units, you could create a division for each business unit, such as “North
America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division
permission enabled.

DurationInMinutes

Type
int
Properties
Filter, Group, Nillable, Sort
Description
Indicates the duration of the event or task.

EndDateTime

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates the end date and time of the event or task. Available in versions 27.0 and later. This
field is optional, depending on the following:
• If IsAllDayEvent is true, you can supply a value for either DurationInMinutes
or EndDateTime. Supplying values in both fields is allowed if the values add up to
the same amount of time. If both fields are null, the duration defaults to one day.
• If IsAllDayEvent is false, a value must be supplied for either
DurationInMinutes or EndDateTime. Supplying values in both fields is allowed
if the values add up to the same amount of time.

IsAllDayEvent

Type
boolean

256

Standard Objects

Field

ActivityHistory

Details
Properties
Defaulted on create, Filter, Group, Sort
Description
If the value of this field is set to true, then the activity is an event spanning a full day, and
the ActivityDate defines the date of the event. If the value of this field is set to false,
then the activity may be an event spanning less than a full day, or it may be a task. Label is
All-Day Event.

IsClosed

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a task is closed; value is always true. This field is set indirectly by setting
the Status field on the task—each picklist value has a corresponding IsClosed value.
Label is Closed.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the activity has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

IsHighPriority

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates a high-priority task. This field is derived from the Priority field.

IsOnlineMeeting

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the activity represents an online meeting (true) or not (false).
Note: This field is not available in API version 16.0 or later.

257

Standard Objects

ActivityHistory

Field

Details

IsReminderSet

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a reminder is set for an activity (true) or not (false).

IsTask

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If the value of this field is set to true, then the activity is a task. If the value is set to false,
then the activity is an event. Label is Task.

IsVisibleInSelfService

Type
boolean
Properties
Defaulted on create, Filter
Description
If the value of this field is set to true, then the activity can be viewed in the self-service
portal. Label is Visible in Self-Service.

Location

Type
string
Properties
Filter, Group, Nillable, Sort
Description
If the activity is an event, then this field contains the location of the event. If the activity is a
task, then the value is null.

OwnerId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the user who owns the activity.

PrimaryAccountId

Type
reference

258

Standard Objects

Field

ActivityHistory

Details
Properties
Filter, Group, Nillable, Sort
Description
Contains the AccountId value from the activity record. Available in API versions 30.0 and
later to organizations that use Shared Activities.

PrimaryWhoId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Contains the WhoId value from the activity record. Available in API versions 30.0 and later
to organizations that have enabled Shared Activities.

Priority

Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Indicates the priority of a task, such as high, normal, or low.

ReminderDateTime

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to
true. If IsReminderSet is set to false, then the user may have deselected the
reminder checkbox in the Salesforce user interface, or the reminder has already fired at the
time indicated by the value.

Status

Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Indicates the current status of a task, such as in progress or complete. Each predefined status
field sets a value for IsClosed. To obtain picklist values, query TaskStatus.

Subject

Type
combobox

259

Standard Objects

Field

ActivityHistory

Details
Properties
Filter, Nillable, Sort
Description
Contains the subject of the task or event.

WhatId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The WhatId represents nonhuman objects such as accounts, opportunities, campaigns,
cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is
equivalent to the ID of a related object. The label is Related To ID.

WhoId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic.
Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name
ID.
If Shared Activities is enabled, the value of this field is the ID of the related lead or primary
contact. If you add, update, or remove the WhoId field, you might encounter problems with
triggers, workflows, and data validation rules that are associated with the record. The label
is Name ID.
If your organization uses Shared Activities, when you query activities in API version 30.0 or
later, the returned value of the WhoId field matches the value in the queried object, not
necessarily in the activity record itself.

Usage
Query activities that are related to an object
1. Optionally, issue a describe call against the object whose activities you wish to query, to get a suggestion of the correct SOQL
to use.
2. Issue a SOQL relationship query with a main clause that references the object, and an inner clause that references the activity
history; for example:
SELECT
(SELECT ActivityDate, Description
FROM ActivityHistories)

260

Standard Objects

AdditionalNumber

FROM Account
WHERE Name Like 'XYZ%'

The user interface enforces sharing rules, filtering out related-list items that a user doesn’t have permission to see.
The following constraints on users who don’t have the “View All Data” permission help prevent performance issues.
• In the main clause of the relationship query, you can reference only one record. For example, you can’t filter on all records where
the account name starts with “A.” Instead, you must reference a single account record.
SELECT
(SELECT ActivityDate, Description
FROM ActivityHistory
ORDER BY ActivityDate DESC NULLS LAST, LastModifiedDate DESC
LIMIT 500)
FROM Account
WHERE Name = 'Acme'
LIMIT 1

• In the inner clause of the query, you can’t use WHERE.
• In the inner clause of the query, you must specify a limit of 500 or fewer on the number of rows that are returned in the list.
• In the inner clause of the query, you must sort on ActivityDate in descending order and LastModifiedDate in
descending order. You can optionally display nulls last. For example: ORDER BY ActivityDate DESC NULLS LAST,
LastModifiedDate DESC.
SEE ALSO:
Task

AdditionalNumber
Represents an optional additional number for a call center. This additional number is visible in the call center's phone directory.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(),
undelete(), update(), upsert()

Special Access Rules
Customer Portal users can't access this object.

Fields
Field

Details

CallCenterId

Type
reference

261

Standard Objects

Field

AgentWork

Details
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
System field that contains the ID of the user who created the call center associated with this
additional number. If value is null, this additional number is displayed in every call center's
phone directory.

Description

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Description of the additional number, such as Conference Room B.
Limit: 255 characters.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the additional number.
Limit: 80 characters.

Phone

Type
phone
Properties
Create, Filter, Nillable, Group, Sort, Update
Description
The phone number that corresponds to this additional number.

Usage
Create an additional number for a call center directory. Use this object if the number is not easily categorized as a User, Contact, Lead,
Account, or the other object. Examples include phone queues or conference rooms.

AgentWork
Represents a work assignment that’s been routed to an agent. This object is available in API version 32.0 and later.

262

Standard Objects

AgentWork

Supported Calls
create(), delete(), query(), getDeleted(), getUpdated(), retrieve(), undelete()

Fields
Field

Details

AcceptDatetime

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work item was accepted.

ActiveTime

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The amount of time an agent actively worked on the work item. Tracks when the item is
open and in focus in the agent’s console.

AgentCapacityWhenDeclined Type

double
Properties
Filter, Nillable, Sort
Description
The agent’s capacity when declining work, either explicitly or through push timeout.
AssignedDateTime

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work item was assigned to an agent,

CancelDateTime

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work item was canceled.

263

Standard Objects

AgentWork

Field

Details

CapacityPercentage

Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of an agent’s capacity for work items that’s consumed by a specific type of
work item from this service channel.
When combined work items reach 100% for an agent, the agent won’t receive new work
items until there is enough open capacity for more work. For example, if you give phone
calls a capacity percentage of 100. an agent on a call doesn’t receive new work items until
the call ends.

CapacityWeight

Type
double
Properties
Filter, Nillable, Sort
Description
The amount of an agent’s capacity for work items that’s consumed by a work item from this
service channel.
For example, if cases are assigned a capacity weight of 2, an agent with a capacity of 6 can
accept up to 3 cases before the agent is at capacity and can’t receive new work items.

CloseDateTime

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work item was closed.

CreatedById

Type
reference
Properties
Defaulted on create, Filter, Group, Sort
Description
ID of the User who created this record.

CreatedDate

Type
dateTime
Properties
Defaulted on createFilter, Sort
Description
Date and time when this record was created.

264

Standard Objects

AgentWork

Field

Details

DeclineDatetime

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time when this record was declined by an agent.

DeclineReason

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The provided reason for why an agent declined the work request.

HandleTime

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The amount of time an agent had the work item open. Calculated by Close Time –
Accepted Time.

Type
ID
Properties
Defaulted on create, Filter, Group, idLookup, Sort
Description
The ID of the AgentWork object.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the record has been moved to the Recycle Bin (true) or not (false).

LastModifiedById

Type
reference
Properties
Defaulted on create, Filter, Group, Sort

265

Standard Objects

Field

AgentWork

Details
Description
The ID of the user who last modified this record.

LastModifiedDate

Type
dateTime
Properties
Defaulted on create, Filter, Sort
Description
Date and time when a user last modified this record.

Name

Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
An automatically generated ID number that identifies the record.

OriginalQueueId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the queue that the work assignment was originally routed to.

PushTimeout

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of seconds set for push timeout. 0 is returned when push timeout isn’t enabled.
Available in API version 36.0 and later.

PushTimeoutDateTime

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the push timeout event occurred. Available in API version 36.0 and later.

RequestDateTime

Type
dateTime

266

Standard Objects

Field

AgentWork

Details
Properties
Filter, Nillable, Sort
Description
Indicates when the work was requested.

ServiceChannelId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the service channel that’s associated with the work assignment.

SpeedToAnswer

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The amount of time between when the work was requested and when an agent accepted
it.

Status

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The working status of the work item. Valid values are:
• Assigned – The item is assigned to the agent but hasn’t been opened.
• Opened – The item was opened by the agent.
• Unavailable – The item was assigned to the agent but the agent became unavailable
(went offline or lost connection).
• Declined – The item was assigned to the agent but the agent explicitly declined it.
• DeclinedOnPushTimeout – The item was declined because push time-out is enabled
and the item request timed out with the agent.
• Closed – The item is closed.
• Canceled – The item no longer needs to be routed. For example: a chat visitor cancels
their Omni-Channel routed chat request before it reaches an agent.

SystemModstamp

Type
dateTime
Properties
Defaulted on create, Filter, Sort

267

Standard Objects

Field

AllowedEmailDomain

Details
Description
Date and time when a user or automated process (such as a trigger) last modified this record.

UserId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the user that the work item was assigned to.

WorkItemId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the object that’s routed to the agent through Omni-Channel.

Usage
AgentWork records can only be deleted if they have the status Closed, Declined, or Unavailable. They can’t be deleted if their status

is Assigned or Opened because they’re active in Omni-Channel.
AgentWork records have the status Assigned when they’re created. Once created, the record is automatically pushed to the assigned

agent.
While the metadata for AgentWork indicates support for upsert() and update(), these calls aren’t used with AgentWork
because none of its fields can be updated.

AllowedEmailDomain
Represents an allowed email domain for users in your organization. You can define a whitelist to restrict the email domains allowed in
a user’s Email field. This object is available in API version 29.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules
You must have the “Manage Internal Users” user permission to use this object.
Note: If you don't see this object, contact your Salesforce representative to enable it.

268

Standard Objects

Announcement

Fields
Field

Details

Domain

Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
An allowed email domain for users.

Announcement
Represents a Chatter group announcement. This object is available in API version 30.0 and later.

Supported Calls
create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()

Fields
Field Name

Details

ExpirationDate

Type
dateTime
Properties
Create, Filter, Sort, Update
Description
Required. The date on which the announcement expires. Announcements display
on the group UI until 11:59 p.m. local time on the selected date.

FeedItemId

Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. The ID of the FeedItem that contains the content of the announcement.
Announcements are stored as text posts.

ParentId

Type
reference

269

Standard Objects

Field Name

Announcement

Details
Properties
Filter, Group, Nillable, Sort
Description
The ID of the parent CollaborationGroup that the announcement belongs to. An
announcement can belong only to a single Chatter group.

SendEmails

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Set to true to email all group members when an announcement is posted to
the group. The default is false. This requires the user to have the “Send
announcement on email” permission.
This field is available in API version 36.0 and later.
Note: This field is currently available to select customers through a pilot
program. To be nominated to join this pilot program, contact Salesforce.
Additional terms and conditions may apply to participate in the pilot
program. Please note that pilot programs are subject to change, and as
such, we cannot guarantee acceptance into this pilot program or a
particular time frame in which this feature can be enabled. Any unreleased
services or features referenced in this document, press releases, or public
statements are not currently available and may not be delivered on time
or at all. Customers who purchase our services should make their purchase
decisions based upon features that are currently available.

Usage
Group owners, managers, and users with the “Modify All Data” permission can use the Announcement object to create, edit, and delete
group announcements. Creating a group announcement is a three-step process.
1. Use the FeedItem object to create a text post with the announcement’s content. Use the CollaborationGroup record you want to
post the announcement to as the parent of this feed item.
2. Next, use the feed item ID and an expiration date to create the announcement record.
3. Finally, update the AnnouncementId field in the CollaborationGroup record with the ID of the announcement you created.
To delete the group announcement, simply delete the AnnouncementId value in the CollaborationGroup record. To restore a group
announcement, update the AnnouncementId field for a group with the announcement’s ID. The expiration date for the announcement
should be in the future and the feed item used to create the announcement should be parented by the same group.

270

Standard Objects

ApexClass

ApexClass
Represents an Apex class.
Note: Although Apex classes and triggers have the Create and Update field properties, a runtime exception occurs if you try to
create or update them using the API. Instead, use the Force.com Migration Tool, the Salesforce user interface, or the Force.com
IDE to create or update Apex classes or triggers.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Fields
Field

Details

ApiVersion

Type
double
Properties
Create, Filter, Sort, Update
Description
The API version for this class. Every class has an API version specified at creation.

Body

Type
textarea
Properties
Create, Nillable, Update
Description
The Apex class definition.
Limit: 1 million characters.

bodyCrc

Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
The CRC (cyclic redundancy check) of the class or trigger file.

IsValid

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update

271

Standard Objects

Field

ApexClass

Details
Description
Indicates whether any dependent metadata has changed since the class was last compiled
(true) or not (false).

LengthWithoutComments

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
Length of the class without comments.

Name

Type
string
Properties
Group, Sort, Create, Filter, Update
Description
Name of the class.
Limit: 255 characters

NamespacePrefix

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that
creates a managed package has a unique namespace prefix. Limit: 15 characters. You can
refer to a component in a managed package by using the
namespacePrefix__componentName notation.
The namespace prefix can have one of the following values:
• In Developer Edition organizations, the namespace prefix is set to the namespace prefix
of the organization for all objects that support it. There is an exception if an object is in
an installed managed package. In that case, the object has the namespace prefix of the
installed managed package. This field’s value is the namespace prefix of the Developer
Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix
is only set for objects that are part of an installed managed package. There is no
namespace prefix for all other objects.

Status

Type
picklist

272

Standard Objects

Field

ApexComponent

Details
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The current status of the Apex class. The following string values are valid:
• Active—The class is active.
• Deleted—The class is marked for deletion. This is useful for managed packages,
because it allows a class to be deleted when a managed package is updated.
Note: The ApexTrigger Status field includes an Inactive option, but it is only
supported for ApexTrigger. For more information, see the Metadata API Developer
Guide.

SEE ALSO:
ApexTrigger
Developer Guide: Apex Developer Guide

ApexComponent
Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as
and .
Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as
and . For information, see the Visualforce Developers Guide.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Fields
Field

Details

ApiVersion

Type
double
Properties
Create, Filter, Sort, Update
Description
The API version for this custom component. Every custom component has an API version
specified at creation. If the API version is less than 15.0 and ApiVersion is not specified,
ApiVersion defaults to 15.0.

273

Standard Objects

ApexComponent

Field

Details

ControllerKey

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier for the controller associated with this custom component:
• If the ControllerType parameter is set to Standard or StandardSet, this
value is the name of the sObject that defines the controller.
• If the ControllerType parameter is set to Custom, this value is the name of the
Apex class that defines the controller.

ControllerType

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of controller associated with this Visualforce custom component. Possible values
include:
• Not Specified, for custom components defined without a value for the
controller attribute on the tag
• Standard, a value that can't be used with custom components or errors may occur
• StandardSet, a value that can't be used with custom components or errors may
occur
• Custom, for components that have a value for the controller attribute on the
tag

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Description of the Visualforce custom component.

Markup

Type
textarea
Properties
Create, Update
Description
The Visualforce markup, HTML, Javascript, and any other Web-enabled code that defines the
content of the custom component.

274

Standard Objects

ApexComponent

Field

Details

MasterLabel

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The text used to identify the Visualforce custom component in the Setup area of Salesforce.
The Label for this field is Label.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Name of this Visualforce custom component.

NamespacePrefix

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that
creates a managed package has a unique namespace prefix. Limit: 15 characters. You can
refer to a component in a managed package by using the
namespacePrefix__componentName notation.
The namespace prefix can have one of the following values:
• In Developer Edition organizations, the namespace prefix is set to the namespace prefix
of the organization for all objects that support it. There is an exception if an object is in
an installed managed package. In that case, the object has the namespace prefix of the
installed managed package. This field’s value is the namespace prefix of the Developer
Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix
is only set for objects that are part of an installed managed package. There is no
namespace prefix for all other objects.

275

Standard Objects

ApexLog

Usage
Use custom components to encapsulate a common design pattern and then reuse that pattern several times in one or more Visualforce
pages. All users who can view Visualforce pages can view custom components, but the “Customize Application” permission is required
to create or update custom components.
SEE ALSO:
ApexPage
StaticResource
Developer Guide: Visualforce Developer Guide

ApexLog
Represents a debug log, containing information about a transaction, including information about Apex, Visualforce, workflow and
validation rules. This object is available in API version 19.0 and later.

Supported Calls
delete(), describeSObjects(), query(), retrieve()

Fields
Field

Details

Application

Type
string
Properties
Filter, Group, Sort
Description
This value depends on the client type that triggered the log.
• For API clients, this value is the client ID
• For browser clients, this value is Browser

DurationMilliseconds

Type
int
Properties
Filter, Group, Sort
Description
Duration of the transaction in milliseconds.

Location

Type
picklist

276

Standard Objects

Field

ApexLog

Details
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies the location of the origin of the log. Values are:
• Monitoring—log is generated as part of debug log monitoring. These types of logs
are maintained until the user or the system overwrites them.
• SystemLog—log is generated from the Developer Console. These types of logs are
only maintained for 60 minutes or until the user clears them.

LogLength

Type
int
Properties
Filter, Group, Sort
Description
Length of the log in bytes.

LogUserId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the user whose actions triggered the debug log.

Operation

Type
string
Properties
Filter, Group, Sort
Description
Name of the operation that triggered the debug log, such as APEXSOAP, Apex Sharing
Recalculation, and so on.

Request

Type
string
Properties
Filter, Group, Sort
Description
Request type. Values are:
• API—request came from the API
• Application—request came from the Salesforce user interface

277

Standard Objects

ApexPage

Field

Details

StartTime

Type
dateTime
Properties
Filter, Sort
Description
Start time of the transaction.

Status

Type
string
Properties
Filter, Group, Sort
Description
Status of the transaction. This value is either Success, or the text of an unhandled Apex
exception.

Usage
You can read information about this object, as well as delete it, but you can't update or insert it.
SEE ALSO:
ApexClass
ApexTrigger
Developer Guide: Apex Developer Guide

ApexPage
Represents a single Visualforce page.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Fields
Field

Details

ApiVersion

Type
double

278

Standard Objects

Field

ApexPage

Details
Properties
Create, Filter, Sort, Update
Description
The API version for this page. Every page has an API version specified at creation. If the API
version is less than 15.0 and ApiVersion is not specified, ApiVersion defaults to
15.0.

ControllerKey

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier for the controller associated with this page:
• If the ControllerType parameter is set to Standard or StandardSet, this
value is the name of the sObject that defines the controller.
• If the ControllerType parameter is set to Custom, this value is the name of the
Apex class that defines the controller.

ControllerType

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of controller associated with this Visualforce page. Possible values include:
• Not Specified, for pages defined with neither a standardController nor
a controller attribute on the tag
• Standard, for pages defined with the standardController attribute on the
tag
• StandardSet, for pages defined using the standardController and
recordSetVar attribute on the tag
• Custom, for pages defined with the controller attribute on the
tag

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Description of the Visualforce page.

isAvailableInTouch

Type
boolean

279

Standard Objects

Field

ApexPage

Details
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if Visualforce tabs associated with the Visualforce page can be used in the Salesforce1
app (true) or not (false). (Use of this field for Salesforce Touch is deprecated.) This field
is available in API version 27.0 and later.
Standard object tabs that are overridden with a Visualforce page aren’t supported in
Salesforce1, even if you set this field for the page. The default Salesforce1 page for the object
is displayed instead of the Visualforce page.

IsConfirmationTokenRequired Type

boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether GET requests for the page require a CSRF confirmation token (true) or
not (false). This field is available in API version 28.0 and later.
If you change this field’s value from false to true, links to the page require a CSRF token
to be added to them, or the page will be inaccessible.
Markup

Type
textarea
Properties
Create, Update
Description
The Visualforce markup, HTML, Javascript, and any other Web-enabled code that defines the
content of the page.

MasterLabel

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The text used to identify the Visualforce page in the Setup area of Salesforce. The Label is
Label.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Name of this Visualforce page.

280

Standard Objects

ApexTestQueueItem

Field

Details

NamespacePrefix

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that
creates a managed package has a unique namespace prefix. Limit: 15 characters. You can
refer to a component in a managed package by using the
namespacePrefix__componentName notation.
The namespace prefix can have one of the following values:
• In Developer Edition organizations, the namespace prefix is set to the namespace prefix
of the organization for all objects that support it. There is an exception if an object is in
an installed managed package. In that case, the object has the namespace prefix of the
installed managed package. This field’s value is the namespace prefix of the Developer
Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix
is only set for objects that are part of an installed managed package. There is no
namespace prefix for all other objects.

Usage
Use Visualforce pages to add custom content that extends the base Salesforce application functionality. All users in Visualforce-enabled
organizations can view Visualforce pages, but the “Customize Application” permission is required to create or update them.
SEE ALSO:
ApexComponent
StaticResource
Developer Guide: Visualforce Developer Guide

ApexTestQueueItem
Represents a single Apex class in the Apex job queue. This object is available in API version 23.0 and later.
This object is available in API version 23.0 and later.

Supported Calls
create(), describeSObjects(), query(), retrieve(), update(), upsert()

281

Standard Objects

ApexTestQueueItem

Fields
Field Name

Description

ApexClassId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The Apex class whose tests are to be executed.

ExtendedStatus

Type
string
Properties
Filter, Nillable, Sort
Description
The pass rate of the test run.
For example: “(4/6)”. This means that four out of a total of six tests passed.
If the class fails to execute, this field contains the cause of the failure.

ParentJobId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Points to the AsyncApexJob that represents the entire test run.
If you insert multiple Apex test queue items in a single bulk operation, the queue
items will share the same parent job. This means that a test run can consist of
the execution of the tests of several classes if all the test queue items are inserted
in the same bulk operation.

Status

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort, Update
Description
The status of the job. Valid values are:
1
• Holding

• Queued
• Preparing
• Processing
• Aborted

282

Standard Objects

Field Name

ApexTestResult

Description
• Completed
• Failed
1

TestRunResultID

This status applies to batch jobs in the Apex flex queue.

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the associated ApexTestRunResult object.

Usage
Insert an ApexTestQueueItem object to place its corresponding Apex class in the Apex job queue for execution. The Apex job
executes the test methods in the class.
To abort a class that is in the Apex job queue, perform an update operation on the ApexTestQueueItem object and set its Status
field to Aborted.
If you insert multiple Apex test queue items in a single bulk operation, the queue items will share the same parent job. This means that
a test run can consist of the execution of the tests of several classes if all the test queue items are inserted in the same bulk operation.

ApexTestResult
Represents the result of an Apex test method execution. This object is available in API version 23.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update()

Fields
Field Name

Details

ApexClassId

Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The Apex class whose test methods were executed.

283

Standard Objects

ApexTestResult

Field Name

Details

ApexLogId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Points to the ApexLog for this test method execution if debug logging is enabled;
otherwise, null.

ApexTestRunResultId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the ApexTestRunResult that represents the entire test run.

AsyncApexJobId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Points to the AsyncApexJob that represents the entire test run.
This field points to the same object as
ApexTestQueueItem.ParentJobId.

Message

Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
The exception error message if a test failure occurs; otherwise, null.

MethodName

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The test method name.

Outcome

Type
picklist

284

Standard Objects

Field Name

ApexTestResult

Details
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The result of the test method execution. Can be one of these values:
• Pass
• Fail
• CompileFail
• Skip

QueueItemId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Points to the ApexTestQueueItem which is the class that this test method is part
of.

RunTime

Type
int
Properties
Create, Filter, Nillable, Sort, Update
Description
The time it took the test method to run, in seconds.

StackTrace

Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
The Apex stack trace if the test failed; otherwise, null.

TestTimestamp

Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The start time of the test method.

285

Standard Objects

ApexTestResultLimits

Usage
You can query the fields of the ApexTestResult record that corresponds to a test method executed as part of an Apex class
execution.
Each test method execution is represented by a single ApexTestResult record. For example, if an Apex test class contains six test
methods, six ApexTestResult records are created. These records are in addition to the ApexTestQueueItem record that
represents the Apex class.
Each ApexTestResult record has an associated ApexTestResultLimits on page 286 record, which captures the Apex limits used during
execution of the test method.

ApexTestResultLimits
Captures the Apex test limits used for a particular test method execution. An instance of this object is associated with each ApexTestResult
record. This object is available in API version 37.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update()

Fields
Field Name

Details

ApexTestResultId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the associated ApexTestResult object.

AsyncCalls

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of asynchronous calls made during the test run.

Callouts

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of callouts made during the test run.

286

Standard Objects

ApexTestResultLimits

Field Name

Details

Cpu

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The amount of CPU used during the test run, in milliseconds.

Dml

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of DML statements made during the test run.

DmlRows

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of rows accessed by DML statements during the test run.

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of email invocations made during the test run.

LimitContext

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates whether the test run was synchronous or asynchronous.

LimitExceptions

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update

287

Standard Objects

Field Name

ApexTestResultLimits

Details
Description
Indicates whether your org has any limits that differ from the default limits.

MobilePush

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of mobile push calls made during the test run.

QueryRows

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of rows queried during the test run.

Soql

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of SOQL queries made during the test run.

Sosl

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of SOSL queries made during the test run.

Usage
The ApexTestResultLimits object is populated for each test method execution, and it captures the limits used between the Test.startTest()
and Test.stopTest() methods. If startTest() and stopTest() aren’t called, limits usage is not captured. Note the following:
• The associated test method must be run asynchronously.
• Limits for asynchronous Apex operations (batch, scheduled, future, and queueable) that are called within test methods are not
captured.
• Limits are captured only for the default namespace.

288

Standard Objects

ApexTestRunResult

ApexTestRunResult
Contains summary information about all the test methods that were run in a particular Apex job. This object is available in API version
37.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update()

Fields
Field Name

Details

AsyncApexJobId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The parent Apex job ID for the result.

ClassesCompleted

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The total number of classes executed during the test run.

ClassesEnqueued

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The total number of classes enqueued during the test run.

EndTime

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The time at which the test run ended.

289

Standard Objects

ApexTestRunResult

Field Name

Details

IsAllTests

Type
boolean
Properties
Create, Filter, Group, Sort, Update
Description
Indicates whether all Apex test classes were run.

JobName

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reserved for future use.

MethodsCompleted

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The total number of methods completed during the test run. This value is updated
after each class is run.

MethodsEnqueued

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The total number of methods enqueued for the test run. This value is initialized
before the test runs.

MethodsFailed

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The total number of methods that failed during this test run. This value is updated
after each class is run.

Source

Type
string

290

Standard Objects

Field Name

ApexTestRunResult

Details
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The source of the test run, such as the Developer Console.

StartTime

Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The time at which the test run started.

Status

Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
The status of the test run. Values include:
• Queued
• Processing
• Aborted
• Completed
• Failed

TestTime

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The time it took the test to run, in seconds.

UserId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user who ran the test run.

291

Standard Objects

ApexTestSuite

ApexTestSuite
Represents a suite of Apex classes to include in a test run. A TestSuiteMembership object associates each class with the suite. This object
is available in API version 36.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
Field Name

Description

TestSuiteName

Type
string
Properties
Create, Filter, Group, Sort, Unique, Update
Description
The name of the Apex test suite. This label appears in the user interface.
This value is case-sensitive and must be unique.

Usage
Insert a TestSuiteMembership object using an API call to associate an Apex class with an ApexTestSuite object. (ApexTestSuite and
TestSuiteMembership aren’t editable through Apex DML.) To remove the class from the test suite, delete the TestSuiteMembership
object. If you delete an Apex test class or test suite, all TestSuiteMembership objects that contain that class or suite are deleted.
The following SOQL query returns the membership object that relates this Apex class to this test suite.
SELECT Id FROM TestSuiteMembership WHERE ApexClassId = '01pD0000000Fhy9IAC'
AND ApexTestSuiteId = '05FD00000004CDBMA2'

SEE ALSO:
EventLogFile

Lightning Interaction Event Type
Lightning Interaction events track user interactions with Lightning Experience. This event type is available in the EventLogFile object in
API version 39.0 and later.
For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.

Fields
Field

Details

APP_NAME

Type
String
Description
The name of the application that the user accessed.

BROWSER_NAME

Type
String

968

Standard Objects

Field

Lightning Interaction Event Type

Details
Description
The name of the browser that the user accessed.
Example
Chrome, IE, Safari, Gecko

BROWSER_VERSION

Type
String
Description
The version of the browser that the user accessed in major.minor version format.
Some browsers don’t provide a minor version.

CLIENT_ID

Type
String
Description
The API client ID.

CLIENT_IP

Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26

CONNECTION_TYPE

Type
String
Description
The type of connection.
Possible Values
• CDMA1x
• CDMA
• EDGE
• EVDO0
• EVDOA
• EVDOB
• GPRS
• HRPD
• HSDPA
• HSUPA
• LTE
• WIFI

969

Standard Objects

Lightning Interaction Event Type

Field

Details

DEVICE_ID

Type
String
Description
The unique identifier used to identify a device when tracking events. DEVICE_ID is a
generated value that’s created when the mobile app is initially run after installation.

DEVICE_MODEL

Type
String
Description
The name of the device model.
Example
iPad, iPhone

DEVICE_PLATFORM

DEVICE_SESSION_ID

Type
Id
Description
The unique identifier of the user’s session based on page load time. When the user reloads
a page, a new session is started.
Example
321a1ddfaf924803a075f1e69fc87bc06f53ccd0

970

Standard Objects

Lightning Interaction Event Type

Field

Details

DURATION

Type
Number
Description
The duration in milliseconds since the page start time.

GRANDPARENT_UI_ELEMENT

Type
String
Description
Grandparent scope of the page element where the event occurred.

ORGANIZATION_ID

Type
String
Description
The 15-character ID of the org.
Example
00D000000000123

OS_NAME

Type
String
Description
The operating system name, derived from USER_AGENT.
Example
Android, iOS, OSX, Windows

OS_VERSION

Type
String
Description
The operating system version, derived from USER_AGENT.

PAGE_CONTEXT

Type
String
Description
Context of the page where the event occurred.

PAGE_ENTITY_ID

Type
Id
Description
The unique entity identifier of the event.
Example
0013000000I3zJAAAZ

971

Standard Objects

Lightning Interaction Event Type

Field

Details

PAGE_ENTITY_TYPE

Type
String
Description
The entity type of the event.
Example
Task, contacts

PAGE_START_TIME

Type
Number
Description
The time when the page was initially loaded, measured in milliseconds.
Example
1471564788642

PARENT_UI_ELEMENT

Type
String
Description
Parent scope of the page element where the event occurred.

REQUEST_ID

Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each
event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV

SDK_APP_TYPE

Type
String
Description
The mobile SDK application type.
Possible Values
• HYBRID
• HYBRIDLOCAL
• HYBRIDREMOTE
• NATIVE
• REACTNATIVE

SDK_APP_VERSION

Type
String

972

Standard Objects

Field

Lightning Interaction Event Type

Details
Description
The mobile SDK application version number.
Example
5.0

SDK_VERSION

Type
String
Description
The mobile SDK version number.
Example
2.1.0

SESSION_ID

Type
String
Description
The user’s unique session ID. You can use the ID to identify all events in Lightning Experience
within a session. When the user logs out and logs in again, a new session is started.
Example
cdd09305cb6babf34059e27f70e47f1b11dec868

TARGET_UI_ELEMENT

Type
String
Description
The target page element where the event occurred.
Example
label bBody truncate, tabitem-link

TIMESTAMP

Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670

UI_EVENT_SEQUENCE_NUM

Type
Number
Description
An auto-incremented sequence number of the current event since the session started.

UI_EVENT_SOURCE

Type
String

973

Standard Objects

Field

Lightning Interaction Event Type

Details
Description
The event source of the error.
Example
AuraError

UI_EVENT_TIMESTAMP

Type
Number
Description
The time at which this event occurred, measured in milliseconds.
Example
1479769912796

UI_EVENT_TYPE

Type
String
Description
The type of interaction.
Example
User, system, error

USER_AGENT

Type
String
Description
The numeric code for the type of client used to make the request (for example, the browser,
application, or API) as a string.

USER_ID

Type
String
Description
The 15-character ID of the user accessing Salesforce services through the UI or API.
Example
00530000009M943

USER_TYPE

974

Standard Objects

Field

Lightning Page View Event Type

Details
• F: Self Service
• G: Guest
• L: Package License Manager
• N: Salesforce to Salesforce
• n: CSN Only
• O: Power Custom
• o: Custom
• P: Partner
• p: Customer Portal Manager
• S: Standard
• X: Black Tab User

SEE ALSO:
EventLogFile

Lightning Page View Event Type
Lightning Page View events represent information about the page on which the event occurred in Lightning Experience. This event
type is available in the EventLogFile object in API version 39.0 and later.
For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.

Fields
Field

Details

APP_NAME

Type
String
Description
The name of the application that the user accessed.

BROWSER_NAME

Type
String
Description
The name of the browser that the user accessed.
Example
Chrome, IE, Safari, Gecko

BROWSER_VERSION

Type
String

975

Standard Objects

Field

Lightning Page View Event Type

Details
Description
The version of the browser that the user accessed in major.minor version format.
Some browsers don’t provide a minor version.

CLIENT_ID

Type
String
Description
The API client ID.

CLIENT_IP

Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26

CONNECTION_TYPE

Type
String
Description
The type of connection.
Possible Values
• CDMA1x
• CDMA
• EDGE
• EVDO0
• EVDOA
• EVDOB
• GPRS
• HRPD
• HSDPA
• HSUPA
• LTE
• WIFI

DEVICE_ID

Type
String
Description
The unique identifier used to identify a device when tracking events. DEVICE_ID is a
generated value that’s created when the mobile app is initially run after installation.

976

Standard Objects

Lightning Page View Event Type

Field

Details

DEVICE_MODEL

Type
String
Description
The name of the device model.
Example
iPad, iPhone

DEVICE_PLATFORM

DEVICE_SESSION_ID

Type
Id
Description
The unique identifier of the user’s session based on page load time. When the user reloads
a page, a new session is started.
Example
321a1ddfaf924803a075f1e69fc87bc06f53ccd0

DURATION

Type
Number
Description
The duration in milliseconds since the page start time.

EPT

Type
Number

977

Standard Objects

Field

Lightning Page View Event Type

Details
Description
The effective page time indicating how long it took for the page to load.

GRANDPARENT_UI_ELEMENT

Type
String
Description
The grandparent scope of the page element where the event occurred.

ORGANIZATION_ID

Type
String
Description
The 15-character ID of the org.
Example
00D000000000123

OS_NAME

Type
String
Description
The operating system name, derived from USER_AGENT.
Example
Android, iOS, OSX, Windows

OS_VERSION

Type
String
Description
The operating system version, derived from USER_AGENT.

PAGE_CONTEXT

Type
String
Description
The context of the page where the event occurred.

PAGE_ENTITY_ID

Type
Id
Description
The unique entity identifier of the event.
Example
0013000000I3zJAAAZ

PAGE_ENTITY_TYPE

Type
String

978

Standard Objects

Field

Lightning Page View Event Type

Details
Description
The entity type of the event.
Example
Task, contacts

PAGE_START_TIME

Type
Number
Description
The time when the page was initially loaded, measured in milliseconds.
Example
1471564788642

PARENT_UI_ELEMENT

Type
String
Description
The parent scope of the page element where the event occurred.

PREVPAGE_CONTEXT

Type
String
Description
The context of the previous page where the event occurred.

PREVPAGE_ENTITY_ID

Type
Id
Description
The unique previous page entity identifier of the event.

PREVPAGE_ENTITY_TYPE

Type
String
Description
The previous page entity type of the event.
Example
Task, contacts

REQUEST_ID

Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each
event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV

979

Standard Objects

Lightning Page View Event Type

Field

Details

SDK_APP_TYPE

Type
String
Description
The mobile SDK application type.
Possible Values
• HYBRID
• HYBRIDLOCAL
• HYBRIDREMOTE
• NATIVE
• REACTNATIVE

SDK_APP_VERSION

Type
String
Description
The mobile SDK application version number.
Example
5.0

SDK_VERSION

Type
String
Description
The mobile SDK version number.
Example
2.1.0

SESSION_ID

TARGET_UI_ELEMENT

Type
String
Description
The target page element where the event occurred.
Example
label bBody truncate, tabitem-link

980

Standard Objects

Lightning Page View Event Type

Field

Details

TIMESTAMP

Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670

UI_EVENT_SEQUENCE_NUM

Type
Number
Description
An auto-incremented sequence number of the current event since the session started.

UI_EVENT_SOURCE

Type
String
Description
The event source of the error.
Example
AuraError

UI_EVENT_TIMESTAMP

Type
Number
Description
The time at which this event occurred, measured in milliseconds.
Example
1479769912796

UI_EVENT_TYPE

Type
String
Description
The type of interaction.
Example
User, system, error

USER_AGENT

Type
String
Description
The numeric code for the type of client used to make the request (for example, the browser,
application, or API) as a string.

USER_ID

Type
String

981

Standard Objects

Field

Lightning Performance Event Type

Details
Description
The 15-character ID of the user accessing Salesforce services through the UI or API.
Example
00530000009M943

USER_TYPE

Type
String
Description
The category of user license of the user accessing Salesforce services through the UI or API.
Possible Values
• A: Automated Process
• b: High Volume Portal
• C: Customer Portal User
• D: External Who
• F: Self Service
• G: Guest
• L: Package License Manager
• N: Salesforce to Salesforce
• n: CSN Only
• O: Power Custom
• o: Custom
• P: Partner
• p: Customer Portal Manager
• S: Standard
• X: Black Tab User

SEE ALSO:
EventLogFile

Lightning Performance Event Type
Lightning Performance events track trends in your Lightning Experience performance. This event type is available in the EventLogFile
object in API version 39.0 and later.
For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.

982

Standard Objects

Lightning Performance Event Type

Fields
Field

Details

APP_NAME

Type
String
Description
The name of the application that the user accessed.

BROWSER_NAME

Type
String
Description
The name of the browser that the user accessed.
Example
Chrome, IE, Safari, Gecko

BROWSER_VERSION

Type
String
Description
The version of the browser that the user accessed in major.minor version format.
Some browsers don’t provide a minor version.

CLIENT_ID

Type
String
Description
The API client ID.

CLIENT_IP

Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26

CONNECTION_TYPE

Type
String
Description
The type of connection.
Possible Values
• CDMA1x
• CDMA
• EDGE
• EVDO0

983

Standard Objects

Field

Lightning Performance Event Type

Details
• EVDOA
• EVDOB
• GPRS
• HRPD
• HSDPA
• HSUPA
• LTE
• WIFI

DEVICE_ID

Type
String
Description
The unique identifier used to identify a device when tracking events. DEVICE_ID is a
generated value that’s created when the mobile app is initially run after installation.

DEVICE_MODEL

Type
String
Description
The name of the device model.
Example
iPad, iPhone

DEVICE_PLATFORM

984

Standard Objects

Lightning Performance Event Type

Field

Details

DEVICE_SESSION_ID

Type
Id
Description
The unique identifier of the user’s session based on page load time. When the user reloads
a page, a new session is started.
Example
321a1ddfaf924803a075f1e69fc87bc06f53ccd0

DURATION

Type
Number
Description
The duration in milliseconds since the page start time.

ORGANIZATION_ID

Type
String
Description
The 15-character ID of the org.
Example
00D000000000123

OS_NAME

Type
String
Description
The operating system name, derived from USER_AGENT.
Example
Android, iOS, OSX, Windows

OS_VERSION

Type
String
Description
The operating system version, derived from USER_AGENT.

PAGE_START_TIME

Type
Number
Description
The time when the page was initially loaded, measured in milliseconds.
Example
1471564788642

REQUEST_ID

Type
String

985

Standard Objects

Field

Lightning Performance Event Type

Details
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each
event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV

SDK_APP_TYPE

Type
String
Description
The mobile SDK application type.
Possible Values
• HYBRID
• HYBRIDLOCAL
• HYBRIDREMOTE
• NATIVE
• REACTNATIVE

SDK_APP_VERSION

Type
String
Description
The mobile SDK application version number.
Example
5.0

SDK_VERSION

Type
String
Description
The mobile SDK version number.
Example
2.1.0

SESSION_ID

TIMESTAMP

Type
String

986

Standard Objects

Field

Lightning Performance Event Type

Details
Description
The access time of Salesforce services.
Example
20130715233322.670

UI_EVENT_SOURCE

Type
String
Description
The event source of the error.
Example
AuraError

UI_EVENT_TIMESTAMP

Type
Number
Description
The time at which this event occurred, measured in milliseconds.
Example
1479769912796

UI_EVENT_TYPE

Type
String
Description
The type of interaction.
Example
User, system, error

USER_AGENT

Type
String
Description
The numeric code for the type of client used to make the request (for example, browser,
application, or API) as a string.

USER_ID

Type
String
Description
The 15-character ID of the user accessing Salesforce services through the UI or API.
Example
00530000009M943

USER_TYPE

Type
String

987

Standard Objects

Field

SEE ALSO:
EventLogFile

Login Event Type — LOGIN_STATUS Values
When users attempt to log in to your org, the success or failure of their login attempts is tracked in event log file data. Specifically, the
LOGIN_STATUS field in the Login event type contains the result of these login attempts. The data in LOGIN_STATUS can help you
determine whether your users’ login attempts were successful. This field is available in the Login event type in the EventLogFile object
in API version 39.0 and later.
For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.
API Error Code

Details (If Available)

LOGIN_CHALLENGE_ISSUED

Failed: Computer activation required

LOGIN_CHALLENGE_PENDING

Failed: Computer activation pending

LOGIN_DATA_DOWNLOAD_ONLY
LOGIN_END_SESSION_TXN_SECURITY_POLICY
LOGIN_ERROR_APPEXCHANGE_DOWN

Unable to process your login request

LOGIN_ERROR_ASYNC_USER_CREATE

988

Standard Objects

API Error Code

Details (If Available)

LOGIN_ERROR_AVANTGO_DISABLED
LOGIN_ERROR_AVANTGO_TRIAL_EXP
LOGIN_ERROR_CLIENT_NO_ACCESS
LOGIN_ERROR_CLIENT_REQ_UPDATE

Failed: Client update required

LOGIN_ERROR_CSS_FROZEN
LOGIN_ERROR_CSS_PW_LOCKOUT
LOGIN_ERROR_DUPLICATE_USERNAME
LOGIN_ERROR_EXPORT_RESTRICTED

Restricted country

LOGIN_ERROR_GLOBAL_BLOCK_DOMAIN

Restricted domain

LOGIN_ERROR_HT_DOWN
LOGIN_ERROR_HTP_METHD_INVALID

Failed: Invalid HTTP method

LOGIN_ERROR_INSECURE_LOGIN

Failed: Login over insecure channel

LOGIN_ERROR_INVALID_GATEWAY

Invalid gateway

LOGIN_ERROR_INVALID_ID_FIELD
LOGIN_ERROR_INVALID_PASSWORD

Invalid password

LOGIN_ERROR_INVALID_USERNAME

Invalid login

LOGIN_ERROR_LOGINS_EXCEEDED

Maximum logins exceeded

LOGIN_ERROR_MUST_USE_API_TOKEN

Failed: API security token required

LOGIN_ERROR_MUTUAL_AUTHENTICATION

Mutual authentication failed

LOGIN_ERROR_NETWORK_INACTIVE

Invalid - community offline

LOGIN_ERROR_NO_HT_ACCESS
LOGIN_ERROR_NO_NETWORK_ACCESS

No community access

LOGIN_ERROR_NO_NETWORK_INFO
LOGIN_ERROR_NO_PORTAL_ACCESS

Invalid profile association

LOGIN_ERROR_NO_SET_COOKIES
LOGIN_ERROR_OFFLINE_DISABLED

Offline disabled

LOGIN_ERROR_OFFLINE_TRIAL_EXP

Offline trial expired

LOGIN_ERROR_ORG_CLOSED

Organization closed

LOGIN_ERROR_ORG_DOMAIN_ONLY

Restricted domain

LOGIN_ERROR_ORG_IN_MAINTENANCE

Organization is in maintenance

989

Standard Objects

API Error Code

Details (If Available)

LOGIN_ERROR_ORG_INACTIVE

Organization is inactive

LOGIN_ERROR_ORG_IS_DOT_ORG

Organization is a DOT

LOGIN_ERROR_ORG_LOCKOUT

Organization locked

LOGIN_ERROR_ORG_SIGNING_UP
LOGIN_ERROR_ORG_SUSPENDED

Organization suspended

LOGIN_ERROR_OUTLOOK_DISABLED

Outlook integration disabled

LOGIN_ERROR_PAGE_REQUIRES_LOGIN
LOGIN_ERROR_PASSWORD_EMPTY
LOGIN_ERROR_PASSWORD_LOCKOUT

Password lockout

LOGIN_ERROR_PORTAL_INACTIVE

Invalid - Portal disabled

LOGIN_ERROR_RATE_EXCEEDED

LOGIN_ERROR_RESTRICTED_DOMAIN

Restricted IP

LOGIN_ERROR_RESTRICTED_TIME

Restricted time

LOGIN_ERROR_SESSION_TIMEOUT
LOGIN_ERROR_SSO_PWD_INVALID

Invalid password

LOGIN_ERROR_SSO_SVC_DOWN

Your company's authentication service is down

LOGIN_ERROR_SSO_URL_INVALID

The Single Sign-On Gateway URL is invalid

LOGIN_ERROR_STORE
LOGIN_ERROR_STORE_DOWN
LOGIN_ERROR_SWITCH_SFDC_INSTANCE
LOGIN_ERROR_SWITCH_SFDC_LOGIN
LOGIN_ERROR_SYNCOFFLINE_DISBLD

Failed: Mobile disabled

LOGIN_ERROR_SYSTEM_DOWN
LOGIN_ERROR_UNKNOWN_ERROR

LOGIN_ERROR_USER_API_ONLY

Failed: API-only user

LOGIN_ERROR_USER_FROZEN

User is frozen

LOGIN_ERROR_USER_INACTIVE

User is inactive

LOGIN_ERROR_USER_NON_MOBILE

Failed: Mobile license required

LOGIN_ERROR_USER_STORE_ACCESS
LOGIN_ERROR_USERNAME_EMPTY

990

Standard Objects

API Error Code

Details (If Available)

LOGIN_ERROR_WIRELESS_DISABLED

Wireless disabled

LOGIN_ERROR_WIRELESS_TRIAL_EXP

Wireless trial expired

LOGIN_LIGHTNING_LOGIN

Lightning Login required

LOGIN_NO_ERROR
LOGIN_OAUTH_API_DISABLED

Failed: OAuth API access disabled

LOGIN_OAUTH_CONSUMER_DELETED

Failed: Consumer Deleted

LOGIN_OAUTH_DS_NOT_EXPECTED

Failed: Activation secret not expected

LOGIN_OAUTH_EXCEED_GET_AT_LMT

Failed: Get Access Token Limit Exceeded

LOGIN_OAUTH_INVALID_CODE_CHALLENGE

Failed: Invalid Code Challenge

LOGIN_OAUTH_INVALID_CODE_VERIFIER

Failed: Invalid Code Verifier

LOGIN_OAUTH_INVALID_DEVICE

Failed: Device Id missing or not registered

LOGIN_OAUTH_INVALID_DS

Failed: Activation secret invalid

LOGIN_OAUTH_INVALID_DSIG

Failed: Signature Invalid

LOGIN_OAUTH_INVALID_IP

Failed: IP Address Not Allowed

LOGIN_OAUTH_INVALID_NONCE

Failed: Invalid Nonce

LOGIN_OAUTH_INVALID_SIG_METHOD

Failed: Invalid Signature Method

LOGIN_OAUTH_INVALID_TIMESTAMP

Failed: Invalid Timestamp

LOGIN_OAUTH_INVALID_TOKEN

Failed: Invalid Token

LOGIN_OAUTH_INVALID_VERIFIER

Failed: Invalid Verifier

LOGIN_OAUTH_INVALID_VERSION

Failed: Version Not Supported

LOGIN_OAUTH_MISSING_DS

Activation secret missing

LOGIN_OAUTH_NO_CALLBACK_URL

Failed: Invalid Callback URL

LOGIN_OAUTH_NO_CONSUMER

Missing Consumer Key Parameter

LOGIN_OAUTH_NO_TOKEN

Missing OAuth Token Parameter

LOGIN_OAUTH_NONCE_REPLAY

Failed: Nonce Replay Detected

LOGIN_OAUTH_PACKAGE_MISSING

Package for this consumer is not installed in your organization

LOGIN_OAUTH_PACKAGE_OLD

Installed package for this consumer is out of date

LOGIN_OAUTH_UNEXPECTED_PARAM

Failed: Unexpected parameter

LOGIN_ORG_TRIAL_EXP

Trial Expired

LOGIN_READONLY_CANNOT_VALIDATE

991

Standard Objects

API Error Code

Details (If Available)

LOGIN_SAML_INVALID_AUDIENCE

Failed: Audience Invalid

LOGIN_SAML_INVALID_CONFIG

Failed: Configuration Error/Perm Disabled

LOGIN_SAML_INVALID_FORMAT

Failed: Assertion Invalid

LOGIN_SAML_INVALID_IN_RES_TO

Failed: InResponseTo Invalid

LOGIN_SAML_INVALID_ISSUER

Failed: Issuer Mismatched

LOGIN_SAML_INVALID_ORG_ID

Failed: Invalid Organization Id

LOGIN_SAML_INVALID_PORTAL_ID

Failed: Invalid Portal Id

LOGIN_SAML_INVALID_RECIPIENT

Failed: Recipient Mismatched

LOGIN_SAML_INVALID_SESSION_LEVEL
LOGIN_SAML_INVALID_SIGNATURE

Failed: Signature Invalid

LOGIN_SAML_INVALID_SITE_URL

Failed: Invalid Site URL

LOGIN_SAML_INVALID_STATUS

Failed: Status Invalid

LOGIN_SAML_INVALID_SUB_CONFIRM

Failed: Subject Confirmation Error

LOGIN_SAML_INVALID_TIMESTAMP

Failed: Assertion Expired

LOGIN_SAML_INVALID_USERNAME

Failed: Username Or SSO Id Invalid

LOGIN_SAML_INVALID_VERSION
LOGIN_SAML_MISMATCH_CERT

Failed: Signature Invalid/Configured Certificate Mismatch

LOGIN_SAML_MISSING_ORG_ID

Failed: Missing Organization Id for Portal login

LOGIN_SAML_MISSING_PORTAL_ID

Failed: Missing Portal Id

LOGIN_SAML_PROVISION_ERROR

Failed: SAML Provision Error

LOGIN_SAML_REPLAY_ATTEMPTED

Failed: Replay Detected

LOGIN_SAML_SITE_INACTIVE

Failed: Specified Site is Inactive

LOGIN_TWOFACTOR_REQ

Two-factor required

Usage
Use LOGIN_STATUS to determine whether your users’ login attempts were successful. For example, you can determine whether a
departed employee attempted to log in successfully or unsuccessfully.

992

Standard Objects

EventRelation

SEE ALSO:
EventLogFile

EventRelation
Represents a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. This object lets you add or
remove invitees from an event and use the API to manage invitees’ responses to invitations. If Shared Activities is enabled, EventRelation
can also represent other objects that are related to an event. EventRelation does not support triggers, workflow, or data validation rules.
EventRelation allows a variable number of relationships and handles deleted events differently, depending on whether Shared Activities
is enabled.
If Shared Activities Is Enabled
• An event can be related to up to 50 contacts or one lead.
• An event can be related to a lead, contact, resource, account, or opportunity.
• An event can be related to a custom object that has the HasActivities attribute set to true.
• If you delete an event, then relations between the event and any specified contacts, leads, and other records are also deleted.
• If you delete the EventRelation record representing a relation then the corresponding relation field may be cleared on the event.
• If you delete the EventRelation record representing the WhoId on an event, then another Who, if any, from the event’s
EventWhoIds field will be promoted to the WhoId.
• If you restore a deleted event, relations between the event and any specified contacts, leads, and records are also restored. The
WhoId, WhatId, and AccountId field values are recalculated using the field values on EventRelation.
If Shared Activities Isn’t Enabled
• An event can be related to only one contact or lead, referenced in the event WhoId field. EventRelations will only be invitees
(contacts, users, and resources).
• An event can also be related to one or more users or resources, represented in the EventWhoIds field on the event.
Whether or not Shared Activities is enabled, an event can be related to one other kind of record, such as an account, an opportunity, or
a custom object.
Note:
• With API versions 26.0 and later, the EventRelation object replaces the EventAttendee object, and the EventAttendee object
is no longer visible. You can still query the EventAttendee object using packages that support API versions 25.0 and earlier, or
by using Apex.
• An EventRelation object can’t be created for a child event.
• EventRelation includes deactivated users.
• In API versions 25.0 and earlier, you can’t use query(), delete(), or update() with events related to more than one
contact.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), queryAll(),
retrieve(), update(), upsert()

993

Standard Objects

EventRelation

Fields
Field

Details

AccountId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Contains the Account ID of the relation. For information on IDs, see ID Field Type.
AccountId is visible when Shared Activities is enabled.

EventId

Type
reference
Properties
Create, Filter, Group, Sort
Description
Contains the ID of the event. This value can’t be changed after it’s been specified.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not
(false). Label is Deleted.

IsInvitee

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the relation is an invitee.
• IsInvitee is visible while Shared Activities is being enabled, after it has been
enabled, and while it is being disabled.
• IsInvitee defaults to true while Shared Activities is being enabled, after
it has been enabled, and while it is being disabled if IsInvitee, IsParent,
and IsWhat are not set. This configuration ensures compatibility when Shared
Activities isn’t enabled and EventRelation represents event invitees only.
• IsInvitee defaults to false when Shared Activities is enabled if
IsParent is set to true.

IsParent

Type
boolean

994

Standard Objects

Field

EventRelation

Details
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
IsParent is visible only when Shared Activities is enabled. When false, indicates
that the relation is an invitee (a contact, lead, or user). When true, indicates that
the relation is a Who or What, as determined by IsWhat field.

IsWhat

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
IsWhat is visible only when Shared Activities is enabled. The value is relevant only
if IsParent is true. When IsWhat is true, the relation specified by
RelationId is a What (an account, opportunity, custom object, etc.). When
IsWhat is false, the relation specified by RelationId is a Who (a contact,

lead, or user).
RelationId

Type
reference
Properties
Create, Filter, Group, Sort
Description
Contains the ID of the person (User, Contact, or Lead) or the resource invited to an
event. When Shared Activities is enabled, RelationId can also contain the ID of
an account, opportunity, or other object related to an event.
This value can’t be changed after it’s been specified.

RespondedDate

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Indicates the most recent date and time when the invitee responded to an invitation
to an event.

Response

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update

995

Standard Objects

Field

EventRelation

Details
Description
Contains optional text that the invitee can enter when responding to an invitation
to an event.

Status

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates the invitee status with one of the following values:
• New: Invitee has received the invitation but hasn’t yet responded. This value is
the default.
• Declined: Invitee has declined the invitation.
• Accepted: Invitee has accepted the invitation.
Note: Uninvited and Maybe aren’t currently supported.

Usage
• Invitee related lists display slightly different content. In Salesforce1, the invitee related list includes invitees only, whereas in the full
site, it also includes the event owner. To reproduce the full site functionality in Salesforce1, use the following API queries.
If you use Shared Activities in your Salesforce org, use this query:
SELECT RelationId FROM EventRelation WHERE isInvitee = true AND eventId='[Event_Id]'

where Event_Id is the child event’s ID.
If you don’t use Shared Activities, use this query:
SELECT RelationId FROM EventRelation WHERE eventId='[Event_Id]'

These queries get the main event’s relations and display them for the given child event. To further filter the results, add a WHERE
clause.
Send email notifications
To send email notifications for a given event, query EventRelation for the event, iterate through the list, examine the status, and send
email notifications to every person who accepted the invitation.
Determine what events a given invitee is attending
To determine all the events that a particular person is attending during a given time period (for example, next week), you can have
a client application query the Event object for a given date range, iterate through the results, and, for each event, query the
EventRelation object to determine whether the particular person (RelationId) has accepted an invitation to that event.
Create an invitee if Shared Activities is enabled (or during the process of enabling it or rolling back)
If the invitee is already a contact or lead, update IsInvitee to true.
If the invitee is not already a contact or lead, create an EventRelation object for the invitee with IsInvitee set to true.

996

Standard Objects

EventRelation

Create an invitee if Shared Activities is not enabled
Create an EventRelation object for the invitee.
Query relations to a contact or a lead
List whoRelations = [SELECT Id, Relation.Name FROM
EventRelation WHERE EventId = '00UD0000005zijD' AND isParent = true AND isWhat =
false];

Query invitee relations
List inviteeRelations = [SELECT Id, Relation.Name FROM
EventRelation WHERE EventId = '00UD0000005zijD' AND isInvitee = true];

Update an invitee relation to a contact or lead invitee relation
EventRelation er = [SELECT Id FROM EventRelation WHERE EventId =
'00UD0000005zijD' AND isInvitee = true and isParent = false LIMIT 1];
er.isParent = true;
update er;

Update a contact or lead relation to a contact or lead invitee relation
EventRelation er = [SELECT Id FROM EventRelation WHERE EventId =
'00UD0000005zijD' AND isParent = true and isInvitee = false LIMIT 1];
er.isInvitee = true;
update er;

Insert a contact or lead relation
EventRelation er = new EventRelation(EventId = '00UD0000005zijH',
RelationId = '003D000000Q8aeV', isParent = true, isInvitee = false);
insert er;

Insert an invitee relation
If isParent, isWhat and IsInvitee are not set, and RelationId is a contact, lead, user, or calendar, IsInvitee
defaults to true. This means if an EventRelation isn’t specifically inserted as a relation to a contact or lead, it’s treated as an Invitee
relation by default.
EventRelation er = new EventRelation(EventId = '00UD0000005zijH',
RelationId = '003D000000Q8adV');
insert er;

Reproduce invitee related list functionality in Salesforce1
Invitee related lists display slightly different content in Salesforce1 and the full site. In Salesforce1, the invitee related list includes
invitees only, whereas in the full site, it also includes the event owner.
If you use Shared Activities in your Salesforce org, use the following query to reproduce the full site functionality in Salesforce1:
SELECT RelationId FROM EventRelation WHERE isInvitee = true AND eventId='[Event_Id]'

where Event_Id is the child event’s ID.
If you don’t use Shared Activities, use this query:
SELECT RelationId FROM EventRelation WHERE eventId='[Event_Id]'

997

Standard Objects

EventTag

These queries get the main event’s relations and display them for the given child event. To further filter the results, add a WHERE
clause.
SEE ALSO:
Event
EventWhoRelation
Object Basics

EventTag
Associates a word or short phrase with an Event.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve()

Fields
Field Name

Details

ItemId

Type
reference
Properties
Create, Filter
Description
ID of the tagged item.

Name

TagDefinitionId

Type
reference
Properties
Filter
Description
ID of the parent TagDefinition object that owns the tag.

998

Standard Objects

EventWhoRelation

Field Name

Details

Type

Usage
EventTag stores the relationship between its parent TagDefinition and the Event being tagged. Tag objects act as metadata, allowing
users to describe and organize their data.
When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting
a TagDefinition sends it to the Recycle Bin, along with any associated tag entries.

EventWhoRelation
Represents the relationship between an event and a lead or contacts. This derived object is a filtered version of the EventRelation on
page 993 object; that is, IsParent is true and IsWhat is false. It doesn’t represent relationships to invitees or to accounts, opportunities,
or other objects. This object is available in API versions 29.0 and later.
EventWhoRelation allows a variable number of relationships: one lead or up to 50 contacts. Available only if you’ve enabled Shared
Activities for your organization.
Note: EventWhoRelation objects aren’t created for child events.

Supported Calls
describeSObjects(), query(), retrieve()

Fields
Field Name

Details

EventId

Type
reference
Properties
Filter, Group, Nillable, Sort

999

Standard Objects

Field Name

ExternalDataSource

Details
Description
Indicates the ID of the event.

RelationId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the contacts or lead related to the event.

Type

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Indicates whether the person related to the event is a contact or lead.

Usage
Apex example that queries relations to a contact or lead
List whoRelations = [SELECT Id, Relation.Name FROM
EventWhoRelation WHERE EventId = '00UD0000005zijD'];

Category

Type
picklist
Properties
Create, Filter, Nillable, Update
Description
Customizable picklist of values used to organize Ideas into logical groupings.
Note: This field is not available if your organization has the multi-select
Categories field enabled.

CommunityId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The zone ID associated with the idea. Once you create an idea, you can’t change the zone
ID associated with that idea.
Note: API version 12 does not support zone ID. If you create an idea in version 12,
your idea is automatically posted to the oldest zone that you have permission to
access.

CreatorFullPhotoUrl

Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the user’s profile photo. This field is available in API version 28.0 and later.

CreatorName

Type
string
Properties
Filter, Group, Nillable, Sort

1105

Standard Objects

Field

Idea

Details
Description
Name of the user who posted the idea or commented on the idea.
This field is available in API version 28.0 and later.

CreatorSmallPhotoUrl

Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the user’s thumbnail photo. This field is available in API version 28.0 and later.

CurrencyIsoCode

IdeaThemeID

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Identifies the idea theme associated with the idea.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

IsHtml

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort

1106

Standard Objects

Field

Idea

Details
Description
Read-only. If this value is true, your organization has the Ideas HTML editor enabled, and
the Idea Body may contain HTML. If this value is false, the HTML editor is disabled and
the Idea Body only contains regular text.

IsMerged

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Read only. Indicates whether the idea has been merged with a parent idea (true) or not
(false). You can’t vote for or add comments to a merged idea.
Note: In API version 27, IsMerged replaces IsLocked. Existing formula fields
that use IsLocked must be edited to use IsMerged.

LastCommentDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time the last comment (child IdeaComment object) was added.

LastCommentId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Read only. The ID of the last comment (child IdeaComment object).

LastReferencedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type
date
Properties
Filter, Nillable, Sort, Update

1107

Standard Objects

Field

Idea

Details
Description
The timestamp for when the current user last viewed this record. If this value is null, this
record might only have been referenced (LastReferencedDate) and not viewed.

NumComments

Type
int
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
The number of comments (child IdeaComment objects) that users have submitted for the
given idea.

ParentIdeaId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID associated with this idea's parent idea. When multiple ideas are merged together,
one idea becomes the parent (master) of the other ideas. The ParentIdeaId is
automatically set when you merge ideas.

RecordTypeId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the record type assigned to this object.

Status

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Customizable picklist of values used to specify the status of an idea.

Title

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The descriptive title of the idea.

1108

Standard Objects

IdeaComment

Field

Details

VoteScore

Type
double
Properties
Filter, Nillable, Sort
Description
The internal score of the Idea, used to sort Ideas on the Popular tab in the application user
interface. The internal algorithm that determines the score gives older votes less weight than
newer votes, simulating exponential decay. The score itself does not display in the application
user interface.
Note: Unlike other fields of type double, you can't use a SOQL aggregate function
with this field.

VoteTotal

Type
double
Properties
Filter, Nillable, Sort
Description
An Idea's total number of points. Each vote a user makes is worth ten points, therefore the
value of this field is ten times the number of votes an idea has received.
Note: Unlike other fields of type double, you can't use a SOQL aggregate function
with this field.

Note: If you are importing Idea data and need to set the value for an audit field, such as CreatedDate, contact Salesforce.
Audit fields are automatically updated during API operations unless you request to set these fields yourself..

Usage
Use this object to track ideas, which are written suggestions on which users can vote and comment.
SEE ALSO:
IdeaComment
Vote

IdeaComment
Represents a comment that a user has submitted in response to an idea.

1109

Standard Objects

IdeaComment

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(),
undelete(), update(), upsert()

Note: When performing a SOSL search on IdeaComment objects, Idea objects are also searched.

Fields
Field

Field Type

CommentBody

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Body of the submitted comment.

CommunityId

CreatorFullPhotoUrl

Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the user’s profile photo. This field is available in API version 28.0 and later.

CreatorName

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name of the user who posted the idea or commented on the idea. This field is available in
API version 28.0 and later.

1110

Standard Objects

IdeaComment

Field

Field Type

CreatorSmallPhotoUrl

Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the user’s thumbnail photo. This field is available in API version 28.0 and later.

IdeaId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the idea on which this comment was made.

IsHtml

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Read-only. If this value is true, your organization has the Ideas HTML editor enabled, and
the CommentBody field may contain HTML. If this value is false, the HTML editor is
disabled and the CommentBody field only contains regular text.

UpVotes

Type
int
Properties
Filter, Group, Nillable, Sort
Description
Total number of up votes for the question.

Note: If you import these records, and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit
fields are automatically updated during API operations unless you request to set these fields yourself.

Usage
Use this object to track comments on ideas, which are users' text responses to ideas.
SEE ALSO:
Idea
Vote

1111

Standard Objects

IdeaReputation

IdeaReputation
Represents a collection of statistics and scores derived from a user’s activity within an Ideas zone or internal organization. This object is
available in API version 28.0 and later.

Supported Calls
query(), retrieve(),

Fields
Field

Details

CommentCount

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of comments a user has created in a zone or the internal organization. This
number excludes comments the user creates on his or her own idea.

CommentsReceivedCount

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of comments a user has received in a zone or the internal organization.

ContextId

Type
reference
Properties
Filter, Group, Namepointing, Nillable, Sort
Description
The ID of the zone or internal organization.

DownVotesGivenCount

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of down votes a user has given in a zone or the internal organization.

1112

Standard Objects

IdeaReputation

Field

Details

DownVotesReceivedCount

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of down votes a user has received in a zone or the internal organization.

IdeaCount

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of ideas a user has created in a zone or the internal organization.

ReputationLevel

Type
string
Properties
Nillable
Description
The reputation level that a user has achieved based on their score in a zone or within an
organization.

Score

Type
double
Properties
Filter, Nillable, Sort
Description
The total score of a user’s activity within a zone or within an organization.

UpVotesGivenCount

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of up votes a user has given in a zone or the internal organization. This number
doesn’t include the default vote the system applies when the user creates the idea.

UpVotesReceivedCount

Type
int
Properties
Filter, Group, Nillable, Sort

1113

Standard Objects

Field

IdeaReputationLevel

Details
Description
The number of up votes a user has received in a zone or the internal organization.

UserId

Type
reference
Properties
Filter, Group, Sort
Description
The user ID associated with the reputation.

Usage
Use to query a user’s reputation within a zone.

IdeaReputationLevel
Represents a reputation level within an Ideas zone or internal organization and is used by the system to calculate reputation. You can
create up to 25 levels per zone or internal organization. This object is available in API version 28.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
Field Name

Details

ContextId

Type
reference
Properties
Create, Filter, Group, Namepointing, Sort, Update
Description
The ID of the zone or internal organization.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update

1114

Standard Objects

Field Name

IdeaTheme

Details
Description
Name of the reputation level. The name must be unique within the zone or
internal organization. Maximum size is 50 characters.

Threshold

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
Minimum number of points for this level. The threshold must be unique within
the zone or internal organization and must be greater than or equal to zero.

Usage
Use to create or edit reputation levels for an Ideas zone or internal organization.

IdeaTheme
Represents an invitation to community members to submit ideas that are focused on a specific topic. This object is available in API
version 26 and later.

Supported Calls
create(), delete(), describeLayout(), query(), retrieve(), search(), undelete(), update(),

Fields
Field Name

Details

Category

Type
string
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Applies only to action links. Denotes whether the action link shows up in the feed item list
of actions or the overflow list of actions. Valid values are:
• Primary

1521

Standard Objects

Field

PlatformAction

Details
• Overflow

ConfirmationMessage

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Applies only to action links. The message to display before the action is invoked. Field is null
if no confirmation is required before invoking the action.

DeviceFormat

Type
string
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies which action icon the PlatformAction query returns. If this field isn’t specified, it
defaults to Phone. Valid values are:
• Aloha
• Desktop
• Phone
• Tablet

ExternalId

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The unique ID for the PlatformAction. If the action doesn’t have an ID, its API name is used.

GroupId

Type
ID
Properties
Filter, Group, Nillable, Sort
Description
The unique ID of a group of action links.

IconContentType

Type
string
Properties
Filter, Group, Nillable, Sort

1522

Standard Objects

Field

PlatformAction

Details
Description
The content type—such as .jpg, .gif, or .png—of the icon for this action. Applies to both
custom and standard icons assigned to actions.

IconHeight

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The height of the icon for this action. Applies only to standard icons.

IconUrl

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The URL of the icon for this action.

IconWidth

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The width of the icon for this action. Applies only to standard icons.

InvocationStatus

Type
string
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The status of the action within the feed item. Applies to action links only. Valid values are:
• Failed
• New
• Pending
• Successful

InvokedByUserId

Type
ID
Properties
Filter, Group, Nillable, Sort

1523

Standard Objects

Field

PlatformAction

Details
Description
The ID of the user who most recently invoked this action within the current feed item. Applies
to action links only.

IsGroupDefault

Type
boolean
Properties
Filter, Group, Sort
Description
Denotes whether this action is the default in an action link group. False for other action types.
Applies to action links only.

IsMassAction

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the action can be performed on multiple records.
This field is available in API version 38.0 and later.

Label

Type
string
Properties
Filter, Group, Sort
Description
The label to display for this action.

PrimaryColor

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The primary color of the icon for this action.

RelatedListRecordId

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Represents the ID of a record in an object’s related list.
This field is available in API version 38.0 and later.

1524

Standard Objects

PlatformAction

Field

Details

RelatedSourceEntity

Type
string
Properties
Filter, Group, Nillable, Sort
Description
When the ActionListContext is RelatedList or RelatedListRecord, this field represents
the API name of the related list to which the action belongs.

Section

Type
string
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The section of the user interface the action resides in. Applicable only to Lightning Experience.
Valid values are:
• ActivityComposer
• CollaborateComposer
• NotesComposer
• Page
• SingleActionLinks
This field is available in API version 35.0 and later.

SourceEntity

Type
string
Properties
Filter, Group, Sort
Description
Required. The object or record with which this action is associated.

Subtype

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The subtype of the action. For quick actions, the subtype is QuickActionType. For
custom buttons, the subtype is WebLinkTypeEnum. For action links, subtypes are Api,
ApiAsync, Download, and Ui. Standard buttons and productivity actions have no
subtype.

Type

Type
string

1525

Standard Objects

Field

PlatformAction

Details
Properties
Filter, Group, Restricted picklist, Sort
Description
The type of the action. Valid values are:
• ActionLink—An indicator on a feed element that targets an API, a web page, or a
file, represented by a button in the Salesforce Chatter feed UI.
• CustomButton—When clicked, opens a URL or a Visualforce page in a window or
executes JavaScript.
• InvocableAction
• ProductivityAction—Productivity actions are predefined by Salesforce and are
attached to a limited set of objects. You can’t edit or delete productivity actions.
• QuickAction—A global or object-specific action.
• StandardButton—A predefined Salesforce button such as New, Edit, and Delete.

Usage
PlatformAction can be described using describeSObject().
You can directly query for PlatformAction. For example, this query returns all fields for actions associated with each of the records of the
listed objects:
SELECT ExternalId, ActionTargetType, ActionTargetUrl, ApiName, Category,
ConfirmationMessage, ExternalId, GroupId, UiTheme, IconUrl, IconContentType,
IconHeight, IconWidth, PrimaryColor, InvocationStatus, InvokedByUserId,
IsGroupDefault, Label, LastModifiedDate, Subtype, SourceEntity, Type
FROM PlatformAction
WHERE SourceEntity IN ('001xx000003DGsH', '001xx000003DHBq', ‘Task’, ‘Global’) AND
ActionListContext = ‘Record’;

Note: To query PlatformAction, provide the ActionListContext and SourceEntity. If you query for
ActionListContext with a value of RelatedList, and don't specify a RelatedSourceEntity, the query returns
the API name of the related list.
This query uses multiple ActionListContext values in its WHERE clause to return all actions in the Lightning Experience user
interface (DeviceFormat = 'Desktop') for the specified object:
SELECT ActionListContext, Label, Type, Subtype, Section, SourceEntity,
RelatedSourceEntity, ActionTarget, ActionTargetType, ApiName, Category,
ConfirmationMessage, DeviceFormat, ExternalId, GroupId, IconContentType,
IconHeight, IconUrl, IconWidth, Id, InvocationStatus, InvokedByUserId,
IsGroupDefault, LastModifiedDate, PrimaryColor
FROM PlatformAction
WHERE ActionListContext IN ('Record','Chatter','RelatedList') AND
SourceEntity = '001xx000003DlvX' AND
DeviceFormat = 'Desktop'

1526

Standard Objects

PresenceUserConfig

PresenceUserConfig
Represents a configuration that determines a presence user’s settings. This object is available in API version 32.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
Field

Details

Capacity

Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The maximum number of work assignments that can be pushed to an agent at a time.

DeveloperName

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores and
alphanumeric characters, and must be unique in your org. It must begin with a letter, not
include spaces, not end with an underscore, and not contain two consecutive underscores.
In managed packages, this field prevents naming conflicts on package installations. With
this field, a developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization.
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

Language

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the presence configuration.

MasterLabel

Type
string

1527

Standard Objects

Field

PresenceUserConfig

Details
Properties
Create, Filter, Group, Sort, Update
Description
The label of the presence configuration.

OptionsIsAutoAcceptEnabled Type

boolean
Properties
Create, Filter, Update
Description
Indicates whether work items that are routed to agents are automatically accepted (true)
or not (false). Available only if OptionsIsDeclineEnabled is set to false.
OptionsIsDeclineEnabled Type

boolean
Properties
Create, Filter, Update
Description
Indicates whether agents can decline work items that are routed to them (true) or not
(false). Available only if OptionsIsAutoAcceptEnabled is set to false.
OptionsIsDeclineReasonEnabled Type

boolean
Properties
Create, Filter, Update
Description
Indicates whether agents can select a reason for declining work requests (true) or not
(false). This can be selected only if decline reasons are enabled.
OptionsIsDisconnectSoundEnabled Type

boolean
Properties
Create, Filter, Update
Description
Indicates whether a sound is played when agents are disconnected from Omni-Channel
(true) or not (false).
OptionsIsRequestSoundEnabled Type

boolean
Properties
Create, Filter, Update

1528

Standard Objects

Field

PresenceUserConfigProfile

Details
Description
Indicates whether a sound plays with incoming work requests (true) or not (false). Set
to true by default.

PresenceStatusOnDeclineId Type

reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the presence status that’s automatically assigned to the agent when the agent
declines a work item. Available only if OptionsIsDeclineEnabled is set to true.
PresenceStatusOnPushTimeoutId Type

reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the presence status that’s automatically assigned to the agent when the agent
doesn’t respond to a work item before push timeout occurs. Available in API version 36.0
and later.

PresenceUserConfigProfile
Represents a configuration that determines the settings that are assigned to presence users who are assigned to a specific profile.
User-level configurations override profile-level configurations. This object is available in API version 32.0 and later.

Supported Calls
create(), delete(), query(), retrieve(), update()

Fields
Field

Details

PresenceUserConfigId

Type
reference
Properties
Create, Filter, Group, Sort
Description
If an individual user is also assigned a presence configuration through the
PresenceUserConfigProfile, this configuration will override that.

1529

Standard Objects

PresenceUserConfigUser

Field

Details

ProfileId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the profile that’s associated with this presence configuration. A profile can be
associated with only one presence configuration.

PresenceUserConfigUser
Represents a configuration that determines the settings that are assigned to a presence user. These user-level configurations override
profile-level configurations. This object is available in API version 32.0 and later.

Supported Calls
create(), delete(), query(), retrieve(), update()

Fields
Field

Details

PresenceUserConfigId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the presence configuration.

UserId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the user who’s associated with this presence configuration. A user can be associated
with only one presence configuration.

Pricebook2
Represents a price book that contains the list of products that your org sells.

1530

Standard Objects

Pricebook2

Note: Price books are represented by Pricebook2 objects. As of API version 8.0, the Pricebook object is no longer available. Requests
containing Pricebook are refused, and responses do not contain the Pricebook object.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), search(), undelete(), update(), upsert()

Fields
Field

Details

Description

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Text description of the price book.

IsActive

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the price book is active (true) or not (false). Inactive price books are
hidden in many areas in the user interface. You can change this field’s value as often as
necessary. Label is Active.

IsArchived

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the price book has been archived (true) or not (false). This field is read
only.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the price book has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

1531

Standard Objects

Pricebook2

Field

Details

IsStandard

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the price book is the standard price book for the org (true) or not
(false). Every org has one standard price book—all other price books are custom price
books.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Name of this object. This field is read-only for the standard price book. Label is
Price Book Name.

Usage
A price book is a list of products that your org sells.
• Each org has one standard price book that defines the standard or generic list price for each product or service that it sells.
• An org can have multiple custom price books to use for specialized purposes, such as for discounts, different channels or markets,
or select accounts or opportunities. While your client application can create, delete, and update custom price books, your client
application can update only the standard price book.
• For some orgs, the standard price book is the only price needed. If you need to set up other price books, you can reference the
standard price book when setting up list prices in custom price books.
Use this object to query standard and custom price books that have been configured for your org. A common use of this object is to
allow your client application to obtain valid Pricebook2 object IDs for use when configuring PricebookEntry records via the API.
Your client application can perform the following tasks on PricebookEntry objects:
• Query
• Create for the standard pricebook or custom pricebooks.
• Update
• Delete
• Change the IsActive field when creating or updating records

PriceBook2, Product2, and PricebookEntry Relationships
In the API:
• Price books are represented by Pricebook2 records (as of version 8.0, the Pricebook object is no longer available).
• Products are represented by Product2 records (as of version 8.0, the Product object is no longer available).

1532

Standard Objects

Pricebook2

• Each price book contains zero or more entries (represented by PricebookEntry records) that specify the products that are associated
with the price book. A price book entry defines the price for which you sell a product at a particular currency.
These objects are defined only for those orgs that have products enabled as a feature. If the org doesn’t have the products feature
enabled, the Pricebook2 object doesn’t appear in the describeGlobal() call, and you can’t access it via the API.
If you delete a Pricebook2 while a line item references PricebookEntry in the price book, the line item is unaffected, but the Pricebook2
is archived and unavailable from the API.
For a visual diagram of the relationships between Pricebook2 and other objects, see Product and Schedule Objects.

Price Book Setup
The process of setting up a price book via the API usually means:
1. Load product data into Product2 records (creating one Product2 record for each product that you want to add).
2. For each Product2 record, create a PricebookEntry that links the Product2 record to the standard Pricebook2. You need to define a
standard price for a product at a given currency (if you have multicurrency enabled), before defining a price for that product in the
same currency in a custom price book.
3. Create a Pricebook2 record to represent a custom price book.
4. For each Pricebook2 record, creating a PricebookEntry for every Product2 that you want to add, specifying unique properties for
each PricebookEntry (such as the UnitPrice and CurrencyIsoCode) as needed.

Code Sample—Java
public void pricebookSample() {
try {
//Create a custom pricebook
Pricebook2 pb = new Pricebook2();
pb.setName("Custom Pricebok");
pb.setIsActive(true);
SaveResult[] saveResults = connection.create(new SObject[]{pb});
pb.setId(saveResults[0].getId());
// Create a new product
Product2 product = new Product2();
product.setIsActive(true);
product.setName("Product");
saveResults = connection.create(new SObject[]{product});
product.setId(saveResults[0].getId());
// Add product to standard pricebook
QueryResult result = connection.query(
"select Id from Pricebook2 where isStandard=true"
);
SObject[] records = result.getRecords();
String stdPbId = records[0].getId();
// Create a pricebook entry for standard pricebook
PricebookEntry pbe = new PricebookEntry();
pbe.setPricebook2Id(stdPbId);
pbe.setProduct2Id(product.getId());
pbe.setIsActive(true);

1533

Standard Objects

Pricebook2History

pbe.setUnitPrice(100.0);
saveResults = connection.create(new SObject[]{pbe});
// Create a pricebook entry for custom pricebook
pbe = new PricebookEntry();
pbe.setPricebook2Id(pb.getId());
pbe.setProduct2Id(product.getId());
pbe.setIsActive(true);
pbe.setUnitPrice(100.0);
saveResults = connection.create(new SObject[]{pbe});
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}

Category

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
A customizable picklist that can be used to group multiple related Quick Text
records together

Channel

Type
picklist
Properties
Create, Defaulted on create, Filter, Nillable, Update
Description
A multi-select picklist that can be used to specify where specific Quick Text
messages should be available, such as in Live Agent or in the Email publisher in
Case Feed.

LastReferencedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this
record.

LastViewedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed this record. If this value is
null, this record might only have been referenced (LastReferencedDate)
and not viewed.

Message

Type
textarea
Properties
Create, Filter (unavailable in API version 25.0 and later), Sort (unavailable in API
version 25.0 and later), Update

1620

Standard Objects

Field Name

QuickTextHistory

Details
Description
The content of the Quick Text record

Name

Type
string
Properties
Create, Filter (unavailable in API version 25.0 and later), Group, Sort (unavailable
in API version 25.0 and later), Update
Description
A descriptive label for the Quick Text record

OwnerId

Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the User who owns the Quick Text record

Usage
Use this object to create and manage the Quick Text messages available to agents in the Live Agent console. You can categorize multiple
QuickText records into groups using the Category field. The Category field can also be a parent to multiple custom dependent Picklist
fields to create a hierarchical structure of categories.

QuickTextHistory
Represents changes to field values on a QuickText object. This object is available in API version 24.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort

1621

Standard Objects

Field Name

QuickTextOwnerSharingRule

Details
Description
The name of the field that was changed

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The old value of the field that was changed

QuickTextId

Type
reference
Properties
Filter, Group, Sort
Description
The ID of the QuickText that was changed

Usage
Use this object to identify changes to a QuickText.

QuickTextOwnerSharingRule
Represents a rule for sharing a QuickText object with users other than the owner.
Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer
support to enable access to this object for your org.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(),
update(), upsert()

1622

Standard Objects

QuickTextOwnerSharingRule

Fields
Field Name

Details

AccessLevel

Type
picklist
Properties
Create, Group, Sort, Update
Description
A value that represents the type of sharing allowed. The possible values are:
• Read
• Edit

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A description of the sharing rule. Maximum size is 1000 characters. This field is
available in API version 29.0 and later.

DeveloperName

Type
string
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must begin with
a letter, not include spaces, not end with an underscore, and not contain two
consecutive underscores. In managed packages, this field prevents naming
conflicts on package installations. With this field, a developer can change the
object’s name in a managed package and the changes are reflected in a
subscriber’s organization.
Note: When creating large sets of data, always specify a unique
DeveloperName for each record. If no DeveloperName is specified,
performance may slow while Salesforce generates one for each record.

GroupID

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the source group. QuickText objects owned by users in the
source group trigger the rule to give access.

1623

Standard Objects

QuickTextShare

Field Name

Details

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Label of the sharing rule as it appears in the user interface. Limited to 80
characters. Corresponds to Label in the user interface.

UserorGroupID

Type
reference
Properties
Create, Filter
Description
The ID representing the target user or group. Target users or groups have access
to the QuickText.

Usage
Use this object to manage the sharing rules for a QuickText object.
SEE ALSO:
Metadata API Developer Guide: SharingRules

QuickTextShare
Represents a sharing entry on a QuickText object. This object is available in API version 24.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the
default settings of such fields.
Field Name

Details

AccessLevel

Type
picklist

1624

Standard Objects

Field Name

QuickTextShare

Details
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Level of access that the User or Group has to the QuickText. The possible values
are:
• Read
• Edit
• All (This value is not valid for create() or update() calls.)
This value must be set to an access level that is higher than the organization’s
default access level for QuickText objects.

ParentId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the parent object, if any

RowCause

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Reason that this sharing entry exists.
You can create a value for this field in API versions 32.0 and later with the correct
organization-wide sharing settings.
Values may include:
• Manual—The User or Group has access because a user with “All” access
manually shared the QuickText with them.
• Owner—The User is the owner of the QuickText or is in a role above the
QuickText owner in the role hierarchy.

UserOrGroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the User or Group that has been given access to the QuickText

1625

Standard Objects

Quote

Usage
This object lets you determine which users and groups can view and edit QuickText records owned by other users.
If you attempt to create a new record that matches an existing record, the create() call updates any modified fields and returns the
existing record.

Quote
The Quote object represents a quote, which is a record showing proposed prices for products and services. Available in API version 18.0
and later.
Quotes can be created from and synced with opportunities, and emailed as PDFs to customers

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), search(), undelete(), update(), upsert()

Fields
Field

Details

AccountId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the account that’s associated with the quote.

AdditionalAddress

Type
address
Properties
Filter, Nillable
Description
Compound form of the additional address. Read-only. See Address Compound
Fields for details on compound address fields.

AdditionalCity

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
City for the quote's additional address. Up to 40 characters allowed.

1626

Standard Objects

Quote

Field

Details

AdditionalCountry

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Country for the quote's additional address. Up to 80 characters allowed.

AdditionalCountryCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ISO country code for the quote’s additional address.

AdditionalLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with AdditionalLongitude to specify the precise geolocation of
an additional address. Acceptable values are numbers between –90 and 90
with up to 15 decimal places.

AdditionalLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with AdditionalLatitude to specify the precise geolocation of
an additional address. Acceptable values are numbers between –180 and 180
with up to 15 decimal places.

AdditionalName

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name associated with the quote's additional address. Limited: 255 characters.

AdditionalPostalCode

Type
string

1627

Standard Objects

Field

Quote

Details
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Postal Code for the quote's additional address.

AdditionalState

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
State for the quote's additional address. Up to 80 characters allowed.

AdditionalStateCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ISO state code for the quote’s additional address.

AdditionalStreet

Type
textarea
Properties
Create, Filter, Nillable, Group, Sort, Update
Description
Street name for the quote's additional address.

BillingAddress

Type
address
Properties
Filter, Nillable
Description
Compound form of the billing address. Read-only. See Address Compound
Fields for details on compound address fields.

BillingCity

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
City for the quote's billing address. Up to 40 characters allowed.

1628

Standard Objects

Quote

Field

Details

BillingCountry

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Country for the quote's billing address. Up to 80 characters allowed.

BillingCountryCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ISO country code for the quote’s billing address.

BillingLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with BillingLongitude to specify the precise geolocation of a
billing address. Acceptable values are numbers between –90 and 90 with up
to 15 decimal places.

BillingLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with BillingLatitude to specify the precise geolocation of a billing
address. Acceptable values are numbers between –180 and 180 with up to 15
decimal places.

BillingName

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Entity that the quote is billed to.

BillingPostalCode

Type
string

1629

Standard Objects

Field

Quote

Details
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Postal Code for the quote's billing address.

BillingState

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
State for the quote's billing address. Up to 80 characters allowed.

BillingStateCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ISO state code for the quote’s billing address.

BillingStreet

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Street name for the quote's billing address.

ContactId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the contact that’s associated with the quote.

ContractId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the contract that’s associated with the quote.

CurrencyIsoCode

Type
picklist

1630

Standard Objects

Field

Quote

Details
Properties
Defaulted on create, Filter, Restricted picklist
Description
Available only for organizations with the multicurrency feature enabled. Contains
the ISO code for any currency allowed by the organization.
If the organization has multicurrency and a Pricebook2Id specified on the
quote, then the currency value of this field must match the currency of the
PricebookEntry objects that are associated with any quote line items it has.
This value is copied from the related Opportunity and can't be changed.

Description

Type
textarea
Properties
Nillable
Description
Text description of the quote. Limit: 32,000 characters.

Discount

Type
percent
Properties
Filter, Nillable, Sort
Description
Difference between the sum of the QuoteLineItem record'sSubtotal and
the sum of the QuoteLineItem record's Discount totals. Expressed as a
percentage.

Type
email
Properties
Filter, Group, Nillable, Sort
Description
The email address of the contact who’s associated with the quote.

ExpirationDate

Type
date
Properties
Create, Filter, Nillable, Update
Description
The date when this quote is no longer valid.

Fax

Type
phone

1631

Standard Objects

Field

Quote

Details
Properties
Create, Filter, Nillable, Update
Description
The fax number for the contact who’s associated with the quote.

GrandTotal

Type
currency
Properties
Filter, Nillable
Description
The total price of the quote plus shipping and taxes.

IsSyncing

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the quote is syncing with an opportunity.

LastReferencedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this
record.

LastViewedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed this record. If this value is
null, this record might only have been referenced (LastReferencedDate)
and not viewed.

LineItemCount

Type
int
Properties
Filter, Nillable
Description
The number of line items on the quote.

1632

Standard Objects

Quote

Field

Details

Name

Type
string
Properties
Create, Filter, idLookup, Update
Description
Required. Name for the quote. Limit: 225 characters.

OpportunityId

Type
reference
Properties
Create, Filter
Description
ID for the opportunity associated with the quote.

Phone

Type
phone
Properties
Create, Filter, Nillable, Update
Description
The phone number of the contact who’s associated with the quote.

Pricebook2Id

Type
reference
Properties
Create, Filter, Nillable, Update
Description
ID of the price book associated with the quote.

QuoteNumber

Type
string
Properties
Defaulted on create, Filter
Description
A system-generated number that identifies the quote.

QuoteToAddress

Type
address
Properties
Filter, Nillable

1633

Standard Objects

Field

Quote

Details
Description
Compound form of the quote to address. Read-only. See Address Compound
Fields for details on compound address fields.

QuoteToCity

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
City for the address to send the quote to for approval, such as a third
party-agency representing a buyer. Up to 40 characters allowed.

QuoteToCountry

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Country for the address to send the quote to for approval. Up to 80 characters
allowed.

QuoteToLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with QuoteToLongitude to specify the precise geolocation of a
quote to address. Acceptable values are numbers between –90 and 90 with up
to 15 decimal places.

QuoteToLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with QuoteToLatitude to specify the precise geolocation of a quote
to address. Acceptable values are numbers between –180 and 180 with up to
15 decimal places.

QuoteToName

Type
string
Properties
Create, Filter, Nillable, Update

1634

Standard Objects

Field

Quote

Details
Description
The name of the entity (such as a person or business) that the quote is sent to
for approval. Limit: 255 characters.

QuoteToPostalCode

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Postal code for the address to send the quote to for approval.

QuoteToState

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
State for the address to send the quote to for approval. Up to 80 characters
allowed.

QuoteToStreet

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Street name for the address to send the quote to for approval.

RecordTypeID

Type
reference
Properties
Create, Filter, Nillable, Update
Description
ID of the record type assigned to the object.

ShippingAddress

Type
address
Properties
Filter, Nillable
Description
Compound form of the shipping address. Read-only. See Address Compound
Fields for details on compound address fields.

1635

Standard Objects

Quote

Field

Details

ShippingCity

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
City for the quote's shipping address. Up to 40 characters allowed.

ShippingCountry

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Country for the quote's shipping address. Up to 80 characters allowed.

ShippingCountryCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ISO country code for the quote’s shipping address.

ShippingHandling

Type
currency
Properties
Create, Filter, Nillable, Update
Description
The total shipping and handling costs for the quote.

ShippingLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with ShippingLongitude to specify the precise geolocation of a
shipping address. Acceptable values are numbers between –90 and 90 with up
to 15 decimal places.

ShippingLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update

1636

Standard Objects

Field

Quote

Details
Description
Used with ShippingLatitude to specify the precise geolocation of an
address. Acceptable values are numbers between –180 and 180 with up to 15
decimal places.

ShippingName

Type
string
Properties
Create, Filter, Nillable, Update
Description
The name of the entity (such as a person or business) that the quote is sent to
for approval.

ShippingPostalCode

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Postal code for the quote's shipping address.

ShippingState

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
State for the quote's shipping address. Up to 80 characters allowed.

ShippingStateCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ISO state code for the quote’s shipping address.

ShippingStreet

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Street name for the quote's shipping address.

1637

Standard Objects

Quote

Field

Details

Status

Type
picklist
Properties
Create, Defaulted on create, Filter, Nillable, Update
Description
The status of the quote. The standard options are:
• —None—
• Draft
• Needs Review
• In Review
• Approved
• Rejected
• Presented
• Accepted
• Denied

Subtotal

Type
currency
Properties
Filter, Nillable
Description
The line item’s sales price multiplied by the quantity and minus the discount.

Tax

Type
currency
Properties
Create, Filter, Nillable, Update
Description
The total taxes for the quote.

TotalPrice

Type
currency
Properties
Filter, Nillable
Description
The total of the quote line items after discounts and before taxes and shipping.

Usage
Use Quote to manage proposed product prices for customers. To update a Quote, your client application needs “Edit” permission.

1638

Standard Objects

QuoteDocument

• Client applications can create, update, delete, and query Attachment records associated with a quote via the API.
• You can sync a quote and its parent Opportunity.
SEE ALSO:
QuoteLineItem
QuoteDocument
Opportunity

QuoteDocument
Represents a quote in document format. Available in API version 18.0 and later.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(),
undelete()

Fields
Field

Details

ContentVersionDocumentId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID for the document’s version.

CurrencyIsoCode

Type
picklist
Properties
Defaulted on create, Filter, Restricted picklist
Description
Available only for organizations with the multicurrency feature enabled.
Contains the ISO code for any currency allowed by the organization. If the
organization has multicurrency and a Pricebook2Id specified on the quote,
then the currency value of this field must match the currency of the
PricebookEntry objects that are associated with any quote line items it has.

Discount

Type
percent
Properties
Filter, Nillable, Sort

1639

Standard Objects

Field

QuoteDocument

Details
Description
The discount for the quote used in the document.

Document

Type
base64
Properties
Create, Nillable
Description
The binary data of the document stored in the QuoteDocument object.

GrandTotal

Type
currency
Properties
Filter, Nillable, Sort
Description
Grand total for the quote used in the document.

Name

Type
string
Properties
Filter, idLookup, Sort
Description
Name of the quote document.

QuoteId

Type
reference
Properties
Create, Filter, GroupSort
Description
ID for the quote used for the document.

Usage
Use the QuoteDocument object to store a document that can be used to present the quote information to the customer.
SEE ALSO:
Quote
QuoteLineItem

1640

Standard Objects

QuoteFeed

QuoteFeed
Represents a single feed item on the quote record detail page. This object is available in API version 39.0 and later.
A quote feed shows changes to a quote record for fields that are tracked in feeds, and posts and comments about the record. It’s a useful
way to stay up-to-date with changes made to quotes in Salesforce.

Supported Calls
delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The content of QuoteFeed. Required when Type is TextPost. Optional when
Type is ContentPost or LinkPost. This field is the message that appears
in the feed.

CommentCount

1641

Standard Objects

Field Name

QuoteFeed

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if an application
migrates posts and comments from another application into a feed, the
InsertedBy value is set to the ID of the logged-in user.

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the feed item Body contains rich text. Set IsRichText
to true if you post a rich text feed item via SOAP API. Otherwise, the post is
rendered as plain text.
Rich text supports the following HTML tags:
•
Tip: Though the
tag isn’t supported, you can use
to create lines.
•
•
•
•
•
•
•
•
•
The tag is accessible only via the API and must reference files in
Salesforce similar to this example:

1642

Standard Objects

Field Name

QuoteFeed

Details
Note: In API version 35.0 and later, the system replaces special characters
in rich text with escaped HTML. In API version 34.0 and prior, all rich text
appears as a plain-text representation.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of FeedLikes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a LinkPost.

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the account record that is tracked in the feed. The feed is displayed on the
detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a ContentPost. This field is
null for all posts except ContentPost.

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the LinkUrl is the
URL and this field is the link name.

1643

Standard Objects

QuoteFeed

Field Name

Details

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of feed item:
• ActivityEvent—indirectly generated event when a user or the API
adds a Task associated with a feed-enabled parent record (excluding email
tasks on cases). Also occurs when a user or the API adds or updates a Task or
Event associated with a case record (excluding email and call logging).
For a recurring Task with CaseFeed disabled, one event is generated for the
series only. For a recurring Task with CaseFeed enabled, events are generated
for the series and each occurrence.
• AdvancedTextPost—created when a user posts a group
announcement.
• AnnouncementPost—Not used.
• ApprovalPost—generated when a user submits an approval.
• BasicTemplateFeedItem—Not used.
• CanvasPost—a post made by a canvas app posted on a feed.
• CollaborationGroupCreated—generated when a user creates a
public group.
• CollaborationGroupUnarchived—Not used.
• ContentPost—a post with an attached file.
• CreatedRecordEvent—generated when a user creates a record from
the publisher.
• DashboardComponentAlert—generated when a dashboard metric
or gauge exceeds a user-defined threshold.
• DashboardComponentSnapshot—created when a user posts a
dashboard snapshot on a feed.
• LinkPost—a post with an attached URL.
• PollPost—a poll posted on a feed.
• ProfileSkillPost—generated when a skill is added to a user’s Chatter
profile.
• QuestionPost—generated when a user posts a question.
• ReplyPost—generated when Chatter Answers posts a reply.
• RypplePost—generated when a user creates a Thanks badge in
Work.com.
• TextPost—a direct text entry on a feed.
• TrackedChange—a change or group of changes to a tracked field.

1644

Standard Objects

Field Name

QuoteLineItem

Details
• UserStatus—automatically generated when a user adds a post.
Deprecated.
The following values appear in the Type picklist for all feed objects but apply
only to CaseFeed:
• CaseCommentPost—generated event when a user adds a case comment
for a case object
• EmailMessageEvent—generated event when an email related to a
case object is sent or received
• CallLogPost—generated event when a user logs a call for a case through
the user interface. CTI calls also generate this event.
• ChangeStatusPost—generated event when a user changes the status
of a case
• AttachArticleEvent—generated event when a user attaches an
article to a case
Note: If you set Type to ContentPost, also specify ContentData
and ContentFileName.

Usage
Use this object to track changes for a quote record.

QuoteLineItem
The QuoteLineItem object represents a quote line item, which is a member of the list of Product2 products associated with a Quote,
along with other information about those line items on that quote. Available in API version 18.0 and later.

Supported Calls
create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),
update(), upsert()

Special Access Rules
The user must have “Edit” permissions on Quote records in order to create or update quote line items on a quote. The user must have
“Edit” permissions on Quote records to delete a quote line item.

1645

Standard Objects

QuoteLineItem

Fields
Field

Details

CurrencyIsoCode

Type
picklist
Properties
Filter, Restricted picklist
Description
Available only for organizations enabled for multiples currencies. Contains the ISO code for
any currency allowed by the organization.
If the organization has multicurrency and a Pricebook2 is specified on the quote (the
Pricebook2Id field is not blank), then the currency value of this field must match the
currency of the PricebookEntry objects for any associated quote line items.
This value is copied from the related Quote and can't be changed.

Description

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Text description of the line item. Limit: 225 characters.

Discount

Type
percent
Properties
Create, Filter, Nillable, Sort
Description
Editable number from 0 to 100.

HasQuantitySchedule

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Read-only. Indicates whether the opportunity line item that the quote line item is synced
with has a quantity schedule.

HasRevenueSchedule

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort

1646

Standard Objects

Field

QuoteLineItem

Details
Description
Read-only. Indicates whether the opportunity line item that the quote line item is synced
with has a revenue schedule. If this object has a revenue schedule, the GrandTotal and
TotalPrice fields can't be updated. In addition, the Quantity field can't be updated
if this object has a quantity schedule. The system ignores any attempt to update this field.
The update isn't rejected but the updated value is ignored.

HasSchedule

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Read-only. Indicates whether the line item uses schedules.

LineNumber

Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
Read-only. Automatically generated number identifying the quote line item. In the form of
QL-XXXXX.

ListPrice

Type
currency
Properties
Filter, Nillable, Sort
Description
Read-only. Corresponds to the UnitPrice on the PricebookEntry that is associated with
this line item, which can be in the standard price book or a custom price book. A client
application can use this information to show whether the unit price (or sales price) of the
line item differs from the price book entry list price.

PricebookEntryId

Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. ID of the associated PricebookEntry. Exists only for orgs with Products enabled. In
API 38.0 and earlier, if Product2Id is populated with PricebookEntryId data,
you receive an error message. In API 39.0 and later, Product2Id is made null, and
PricebookEntryId is populated with the PricebookEntryId data.

1647

Standard Objects

QuoteLineItem

Field

Details

Product2Id

Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the Product2 associated with this QuoteLineItem. In API 38.0 and earlier, if
Product2Id is populated with PricebookEntryId data, you receive an error
message. In API 39.0 and later, Product2Id is made null, and PricebookEntryId
is populated with the PricebookEntryId data.

Quantity

Type
double
Properties
Create, Filter, Sort, Update
Description
The number of units for the line item.

QuoteId

Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. ID of the associated Quote.

ServiceDate

Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date when the product revenue will be recognized and the product quantity will be shipped.

SortOrder

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The value of where the line item is in the sorted order, such as 1, 2, and so on. The SortOrder
value determines the order in which a quote line item displays in the Quote Detail page.
Client applications can use this to match the sort order in Salesforce. This field is only available
in API versions 21.0 and greater.

1648

Standard Objects

QuoteLineItem

Field

Details

Subtotal

Type
currency
Properties
Filter, Nillable, Sort
Description
The line item's Quantity multiplied by the UnitPrice.

TotalPrice

Type
currency
Properties
Filter, Nillable, Sort
Description
Read-only. Calculated by applying the Discount to the Subtotal. This field is nillable,
but you can't set both TotalPrice and UnitPrice to null in the same update. To
insert the TotalPrice for a quote line item via the API (given only a unit price and the
quantity), calculate this field as the unit price multiplied by the quantity. This field is read-only
if the quote line item has a revenue schedule.

UnitPrice

Type
currency
Properties
Create, Filter, Sort, Update
Description
The price per unit for the quote line item.

Usage
A Quote record can have QuoteLineItem records only if the Quote has a Pricebook2. A QuoteLineItem must correspond to a Product2
that is listed in the quote's Pricebook2.
Note: If the multicurrency option has been enabled, the CurrencyIsoCode field is present. It can't be modified, it is always
set to the value of the CurrencyIsoCode of the parent Quote.

Effects on Quotes
Quotes that have associated QuoteLineItem objects are affected in the following ways:
• Creating a QuoteLineItem increments the Quote value by the TotalPrice of the QuoteLineItem.

1649

Standard Objects

RecentlyViewed

• When you create or update a QuoteLineItem, the API verifies that the line item corresponds to a PricebookEntry in the Pricebook2
that is associated with the quote.
SEE ALSO:
Quote
QuoteDocument
Opportunity

RecentlyViewed
Represents records that the current user has recently viewed or referenced (by viewing a related record).

Supported Calls
query(), update()

Special Usage Rules
The RecentlyViewed object does not support the Report, KnowledgeArticle, and Article objects.

Fields
Field

Details

Alias

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The alias on the record.

Type
email
Properties
Filter, Group, Nillable, Sort
Description
The email address on the record.

FirstName

Type
string
Properties
Filter, Group, Nillable, Sort

1650

Standard Objects

Field

RecentlyViewed

Details
Description
The first name on the record. If the recently viewed record is a user, this is the user’s first
name.

Type
ID
Properties
Defaulted on create, Filter, Group, Sort
Description
The ID of the recently viewed record.

IsActive

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the recently viewed record is an active user (true) or not (false). This
field contains a value only if the recently viewed record is a user.

LastName

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The last name on the record.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type
dateTime
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed this record. If this value is null, this
record might only have been referenced (LastReferencedDate) and not viewed.

1651

Standard Objects

RecentlyViewed

Field

Details

Name

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name on the recently viewed record. If the recently viewed record is a user, contact, or
lead, the value is a concatenation of the firstname and lastname field values.

NetworkId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the community that this group is part of. This field is available only if Salesforce
Communities is enabled in your organization.
You can add a NetworkId only when creating a group. You can’t change or add a
NetworkId for an existing group. This field is available in API version 27.0 and later.

Phone

Type
phone
Properties
Filter, Group, Nillable, Sort
Description
The phone number on the record.

ProfileId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
If the recently viewed record is a user, this is the user’s profile ID.

Title

Type
string
Properties
Filter, Group, Nillable, Sort
Description
If the recently viewed record is a user, this is the title of the user; for example CFO or CEO.

Type

Type
picklist

1652

Standard Objects

Field

RecordType

Details
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The sObject type for this recently viewed record. Valid values include any standard or custom
objects that RecentlyViewed supports.

UserRoleId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user role associated with this object.

Usage
This object provides a heterogeneous list of different object types and consists of recently viewed records or records that were recently
referenced (a related record was viewed). A record is considered viewed when the user sees the details associated with it, but not when
the user sees it in a list with other records. Use this object to programmatically construct a list of recently viewed items specific to the
current user, for example, on a custom user interface or for search auto-complete options. You can also retrieve a filtered list of records
by object type (Type). The RecentlyViewed data is periodically truncated down to 200 records per object.
Use this query in your code to retrieve a list of all the records that were recently viewed. The results are ordered from most to least recent.
SELECT Id, Name
FROM RecentlyViewed
WHERE LastViewedDate !=null
ORDER BY LastViewedDate DESC

Use this query to retrieve data that was either viewed or referenced, but only for a limited set of objects.
SELECT Id, Name
FROM RecentlyViewed
WHERE Type IN ('Account', 'Contact', 'Plan__c')
ORDER BY LastViewedDate DESC

This query retrieves a list of all recently viewed contacts with contact-specific fields, such as the contact’s account name, and the custom
website field. Records are ordered from most to least recent.
SELECT Account.Name, Title, Email, Phone, Website__c
FROM Contact
WHERE LastViewedDate != NULL
ORDER BY LastViewedDate DESC

RecordType
Represents a record type.

1653

Standard Objects

RecordType

Supported Calls
create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Fields
Field

Details

BusinessProcessId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Required for Opportunity and Lead record types in API version 17.0 and later. ID of an
associated BusinessProcess.

Description

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A description of this record. Limit: 255 characters.

DeveloperName

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The unique name of the object in the API. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must begin with a letter,
not include spaces, not end with an underscore, and not contain two consecutive underscores.
In managed packages, this field prevents naming conflicts on package installations. With
this field, a developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization. Label is Record Type Name.
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

IsActive

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update

1654

Standard Objects

Field

RecordType

Details
Description
Indicates whether this record is active (true) or not (false). Only active record types can
be applied to records. Label is Active.

IsPersonType

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether this record has been designated as a person account (true) or not
(false). Visible only if the organization has the person account feature enabled.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Label of the record type in the user interface. Limit: 80 characters. Label is Record
Type Label.

NamespacePrefix

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that
creates a managed package has a unique namespace prefix. Limit: 15 characters. You can
refer to a component in a managed package by using the
namespacePrefix__componentName notation.
The namespace prefix can have one of the following values:
• In Developer Edition organizations, the namespace prefix is set to the namespace prefix
of the organization for all objects that support it. There is an exception if an object is in
an installed managed package. In that case, the object has the namespace prefix of the
installed managed package. This field’s value is the namespace prefix of the Developer
Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix
is only set for objects that are part of an installed managed package. There is no
namespace prefix for all other objects.
This field can’t be accessed unless the logged-in user has the “Customize Application”
permission.

1655

Standard Objects

RecordTypeLocalization

Field

Details

SobjectType

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
Object to which this record type applies, including custom objects.

Usage
Use this object to offer different BusinessProcess records and subsets of picklist values to different users based on their Profile. Your client
application can describe or query RecordType records.
The following objects have a RecordTypeId field:
• Account
• Campaign
• CampaignMember
• Case
• Contact
• Contract
• Lead
• Opportunity
• QuickText
• Solution
• Custom objects
Client applications can create or update values in RecordTypeId on these objects, specifying a valid record type ID associated with
these objects.
Note: You can’t create or update the RecordTypeId field on the CampaignMember records. Set the CampaignMember
record type using the CampaignMemberRecordTypeId field on Campaign.
A client application can retrieve the list of valid record type IDs for a given object by querying the RecordType.
SEE ALSO:
Record Type Objects

RecordTypeLocalization
Represents the translated value of a label for a record type when the Translation Workbench is enabled for your organization.

1656

Standard Objects

RecordTypeLocalization

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Fields
Field

Details

Language

Type
string
Properties
Create, Filter, Nillable, Restricted picklist
Description
The language for this translated label.

NamespacePrefix

ParentId

Type
reference
Properties
Create, Filter, Nillable

1657

Standard Objects

Field

Details
Description
The ID of the RecordType associated with the label that is being translated.

Value

Type
string
Properties
Create, Filter, Nillable, Update
Description
The actual translated label for the record type. Label is Translation.

Usage
Use this object to translate the labels of your record types into other supported languages.

Reply
Represents a reply that a user has submitted to a question in an answers community.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), search(), undelete(), update(), upsert()

Fields
Field

Details

Body

Type
textarea
Properties
Create, Update
Description
Body of this reply.

CommunityId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The zone ID associated with the question and its reply. This field is available in API
version 27.0 and later.

1658

Standard Objects

Field

Details

CreatorFullPhotoUrl

Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the user’s profile photo from the feed. Chatter Answers must be enabled to
view this field. This field is available in API version 26.0 and later.

CreatorName

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name of the user who posted the question or reply. Only the first name of internal
users (agents) appears to portal users in the feed. Chatter Answers must be enabled
to view this field. This field is available in API version 26.0 and later

CreatorSmallPhotoUrl

Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the user’s thumbnail photo from the feed. Chatter Answers must be enabled
to view this field. This field is available in API version 26.0 and later.

DownVotes

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total number of down votes for a reply.

Name

Type
string
Properties
Filter, Group, idLookup, Sort
Description
When creating a Reply, the Name field is automatically populated with a truncated,
plain text version of the Reply Body field.

1659

Standard Objects

ReplyReportAbuse

Field

Details

NumReportAbuses

Type
int
Properties
Filter, Group, Nillable, Sort
Description
Represents the number of reported abuses on the reply by users.
This field is available in API version 24.0 and later.

QuestionId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the Question to which this reply was made.

UpVotes

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total number of up votes for a reply.

VoteTotal

Type
double
Properties
Filter, Nillable, Sort
Description
The total number of all votes for a reply, including up and down votes.

Usage
Use this object to track replies to a Question.

ReplyReportAbuse
Represents a user-reported abuse on a Reply in a Chatter Answers community. This object is available in API version 24.0 and later.

Supported Calls
create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

1660

Standard Objects

Report

Fields
Field

Details

Name

Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the Reply from which the user reported abuse.

Reason

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The reason the user reported abuse on the Reply, such as Spam, Hateful, or
Inappropriate.

ReplyId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the Reply from which the user reported abuse.

Usage
Use this object to track user-reported abuse on replies created in a Chatter Answers community.

Report
Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available
in API version 20.0 and later.

Supported Calls
describeSObjects(), query(), retrieve(), search()

1661

Standard Objects

Report

Fields
Field

Details

Description

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The description of the report. Limit: 255 characters.

DeveloperName

Type
string
Properties
Filter, Group, Sort
Description
Required. The unique name of the object in the API. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must begin with a letter,
not include spaces, not end with an underscore, and not contain two consecutive underscores.
In managed packages, this field prevents naming conflicts on package installations. With
this field, a developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization. Label is Report Unique Name.
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

FolderName

Type
string
Properties
Filter, Nillable, Sort
Description
Name of the folder that contains the report. Available in API version 35.0 and later.

Format

Type
picklist
Properties
Defaulted on create, Filter, Group, Sort
Description
Required. Indicates the format of the report. This field is available in API version 39.0 and
later. Can have one of these values:
• Tabular for reports in that format. The label is Tabular.
• Summary for reports in that format. The label is Summary.
• Matrix for reports in that format. The label is Matrix.

1662

Standard Objects

Field

Report

Details
• Multiblock for reports in joined format. The label is Joined.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

LastReferencedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.

LastRunDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
Returns the date the report was last run. Label is Last Run.

LastViewedDate

Name

Type
string
Properties
Filter, Group, Sort
Description
Required. The report label used in the user interface.

NamespacePrefix

Type
string

1663

Standard Objects

Field

Report

Details
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that
creates a managed package has a unique namespace prefix. Limit: 15 characters. You can
refer to a component in a managed package by using the
namespacePrefix__componentName notation.
The namespace prefix can have one of the following values:
• In Developer Edition organizations, the namespace prefix is set to the namespace prefix
of the organization for all objects that support it. There is an exception if an object is in
an installed managed package. In that case, the object has the namespace prefix of the
installed managed package. This field’s value is the namespace prefix of the Developer
Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix
is only set for objects that are part of an installed managed package. There is no
namespace prefix for all other objects.
This field can’t be accessed unless the logged-in user has the “Customize Application”
permission.

OwnerId

Type
reference
Properties
Filter
Description
The ID of the user who currently owns this report.

Supported Query Scopes
Use these scopes to help specify the data your SOQL query returns.
allPrivate
Records saved in all users’ private folders.
Requires the user permission "Manage All Private Reports and Dashboards" and Enhanced Analytics Folder Sharing. If your organziation
was created after the Summer ’13 release, you already have Enhanced Analytics Folder Sharing. Available in API version 36.0 and
later.
created
Records created by the user running the query.
everything
All records except records saved in other users’ private folders.
mine
Records saved in the private folder of the user running the query.

1664

Standard Objects

ReportFeed

organizationOwned
Records saved in Unfiled Public Reports. In Lightning Experience, the Unfiled Public Reports folder is called Public Reports.

Usage
Use the report object to get report metadata. Query, search, or retrieve specific metadata on reports. Report object fields are read-only.

Example: Reports with “Sales” in Their Name
This SOQL query returns reports that contain the name “Sales” and lists their developer names, format, ID, and report name.
SELECT DeveloperName,Format,Id,Name FROM Report WHERE Name LIKE '%Sales%'

Example: Reports in an Inactive User’s Private Folder
This SOQL query returns reports saved in a specific user’s private folder.
SELECT Id FROM Report USING SCOPE allPrivate WHERE OwnerId = ‘005A0000000Bc2deFG’

SEE ALSO:
ReportFeed
ReportTag
Dashboard

ReportFeed
Represents a single feed item in the feed displayed on a report. This object is available in API version 20.0 and later.

Supported Calls
delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

1665

Standard Objects

ReportFeed

Fields
Field

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The content of ReportFeed. Required when Type is TextPost. Optional when Type
is ContentPost or LinkPost. This field is the message that appears in the feed.

CommentCount

ConnectionId

ContentData

Type
base64
Properties
Nillable

1666

Standard Objects

Field

ReportFeed

ContentDescription

Type
textarea
Properties
Nillable, Sort
Description
Available in API version 36.0 and earlier only. The description of the file specified in
ContentData.

ContentFileName

Type
string
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. This field is required if Type is ContentPost.
The name of the file uploaded to the feed. Setting ContentFileName automatically
sets Type to ContentPost.

ContentSize

ContentType

CreatedDate

Type
dateTime
Properties
Defaulted on create, Filter, Sort

1667

Standard Objects

Field

ReportFeed

Details
Description
Date and time when this record was created. This field is a standard system field.
Ordering by CreatedDateDESC sorts the feed by the most recent feed item.

FeedPostId

InsertedById

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Standard system field. Indicates whether the record has been moved to the Recycle Bin
(true) or not (false).

IsRichText

1668

Standard Objects

Field

ReportFeed

LastModifiedDate

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of FeedLikes associated with this feed item.

LinkUrl

Type
url

1669

Standard Objects

Field

ReportFeed

Details
Properties
Nillable, Sort
Description
The URL of a LinkPost.

NetworkScope

Type
reference
Properties
Filter, Group, Sort
Description
ID of the account record that is tracked in the feed. The feed is displayed on the detail page
for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a ContentPost. This field is null for all
posts except ContentPost.

1670

Standard Objects

ReportFeed

Field

Details

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the report record. When the Type is LinkPost, the LinkUrl is the URL
and this field is the link name.

Type

1671

Standard Objects

Field

ReportFeed

Visibility

1672

Standard Objects

ReportTag

Usage
Use this object to retrieve the current contents of the feed fields, such as type of feed or feed ID.
SEE ALSO:
Report

ReportTag
Associates a word or short phrase with a Report. This object is available in API version 20.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve()

Fields
Field Name

Details

ItemId

Type
reference
Properties
Create, Filter
Description
ID of the tagged item.

Name

TagDefinitionId

Type
reference
Properties
Filter
Description
ID of the parent TagDefinition object that owns the tag.

Type

Type
picklist

1673

Standard Objects

Field Name

ReputationLevel

Usage
ReportTag stores the relationship between its parent TagDefinition and the Report being tagged. Tag objects act as metadata, allowing
users to describe and organize their data.
When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting
a TagDefinition sends it to the Recycle Bin, along with any associated tag entries.
SEE ALSO:
Report

ReputationLevel
Represents a reputation level defined for a community. This object is available in API version 32.0 and later.

Supported Calls
describeSObjects(), query(), retrieve()

Special Access Rules
This object is available only if Salesforce Communities is enabled in your organization. Only users with permissions to create or manage
a community can view the ReputationPointsRule records.

Fields
Field Name

Details

Label

Type
string
Properties
Filter, Group, Nillable, Sort

1674

Standard Objects

Field Name

ReputationLevelLocalization

Details
Description
The label for the reputation level.

LevelNumber

Type
int
Properties
Filter, Group, Sort
Description
The rank of the reputation level.

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
The ID of the parent community (network) the reputation level applies to.

Threshold

Type
double
Properties
Filter, Sort
Description
The lower limit of reputation points associated with this reputation level. The
maximum number of reputation points a user can accrue is 999,999,999,999,999.

ReputationLevelLocalization
Represents the translated value of a reputation level. Reputation level localization only applies for reputation levels in communities. This
object is available in API version 35.0 and later.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules
This object is available only if Salesforce Communities is enabled in your organization and reputation is enabled in your community.

1675

Standard Objects

ReputationLevelLocalization

Fields
Field Name

Details

Language

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The language the reputation level is translated into. The picklist contains the
following fully-supported languages:
• Chinese (Simplified): zh_CN
• Chinese (Traditional): zh_TW
• Danish: da
• Dutch: nl_NL
• English: en_US
• Finnish: fi
• French: fr
• German: de
• Italian: it
• Japanese: ja
• Korean: ko
• Norwegian: no
• Portuguese (Brazil): pt_BR
• Russian: ru
• Spanish: es
• Spanish (Mexico): es_MX
• Swedish: sv
• Thai: th

NamespacePrefix

1676

Standard Objects

Field Name

ReputationPointsRule

ParentId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the reputation level this translated value applies to.

Value

Type
string
Properties
Create, Filter, Sort, Update
Description
The translated text for the reputation level. Label is Translation Text.

ReputationPointsRule
Represents the reputation point rules for a community. Each rule specifies an action that community members can earn points from
and the points associated with those actions in a particular community. This object is available in API version 32.0 and later.

Supported Calls
describeSObjects(), query(), retrieve()

1677

Standard Objects

ReputationPointsRule

Fields
Field Name

Details

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
The ID of the parent community (network) that the point rule applies to.

Points

Type
int
Properties
Filter, Group, Sort
Description
The reputation points associated with the member action this rule is for. The
maximum value this field can contain is 999,999.

Type

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The member action associated with this rule, limited to one of these values:
• Write a post
• Write a comment
• Receive a comment
• Like something
• Receive a like
• Share a post
• Someone shares your post
• Mention someone
• Receive a mention
• Ask a question
• Respond to a question
• Receive an answer
• Mark an answer as best
• Your answer is marked as best

1678

Standard Objects

ResourceAbsence

ResourceAbsence
Represents a time period in which a service resource is unavailable to work. This object is available in API version 38.0 and later.

Supported Calls
create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(),update(),upsert()

Special Access Rules
Field Service Lightning must be enabled. To create or update resource absences, you need “Read” access to service resources. To delete
resource absences, you need “Edit” access to service resources.

Fields
Field Name

Details

AbsenceNumber

Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
(Read only) An auto-generated number identifying the absence.

Address

Type
address
Properties
Filter, Nillable
Description
The compound form of the address associated with the absence.

City

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city of the address associated with the absence. Maximum length is 40
characters.

Country

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update

1679

Standard Objects

Field Name

ResourceAbsence

Details
Description
The country of the address associated with the absence. Maximum length is 80
characters.

Description

Type
textarea
Properties
Create, Nillable, Update
Description
The description of the absence.

End

Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time when the absence ends.

GeocodeAccuracy

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The level of accuracy of a location’s geographical coordinates compared with its
physical address. Usually provided by a geocoding service based on the address’s
latitude and longitude coordinates.
Note: This field is available in the API only.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the resource absence was last modified. Its label in the user
interface is Last Modified Date.

LastViewedDate

Type
dateTime
Properties
Filter, Nillable, Sort

1680

Standard Objects

Field Name

ResourceAbsence

Details
Description
The date when the resource absence was last viewed.

Latitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the address
associated with the absence. Acceptable values are numbers between –90 and
90 with up to 15 decimal places.
Note: This field is available in the API only.

Longitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of the address
associated with the absence. Acceptable values are numbers between –180 and
180 with up to 15 decimal places.
Note: This field is available in the API only.

Postal Code

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The postal code of the address associated with the absence. Maximum length is
20 characters.

ResourceId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The absent service resource.

Start

Type
dateTime

1681

Standard Objects

Field Name

ResourceAbsenceFeed

Details
Properties
Create, Filter, Sort, Update
Description
The date and time when the absence begins.

State

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state of the address associated with the absence. Maximum length is 80
characters.

Street

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street number and name of the address associated with the absence.

Type

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The type of absence: Meeting, Training, Medical, or Vacation. The
default value is Vacation. You can add custom values if needed.

Usage
The Absences related list on a service resource detail page lets you define periods of time when the resource is unavailable to work.
Unless you’re using the Field Service Lightning managed packages with the scheduling optimizer, service resources can still be assigned
appointments that conflict with their absences.
Tip: Create a trigger that sends an approval request to a supervisor when a service resource creates an absence.
If you’re not using the Field Service Lightning managed packages, a calendar view isn’t available for individual service resources.

ResourceAbsenceFeed
Represents a single feed item on a resource absence record detail page. This object is available in API version 38.0 and later.

1682

Standard Objects

ResourceAbsenceFeed

A resource absence feed shows changes to tracked fields on a resource absence record. It also shows posts and comments about the
record. It’s a useful way to stay up to date with changes made to resource absences in Salesforce.

Supported Calls
delete(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The message that appears in the feed. Required when Type is TextPost.
Optional when Type is ContentPost orLinkPost.

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of comments associated with this feed item.

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if an application
migrates posts and comments from another application into a feed, the value is
set to the ID of the logged-in user.

1683

Standard Objects

ResourceAbsenceFeed

Field Name

Details

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
true indicates that the body of the feed contains rich text. false indicates
that the post is rendered as plain text.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of feed likes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a link post.

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the resource absence record tracked in the feed. The feed is displayed on
the detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a content post. This field
is null for all posts, except ContentPost.

Title

Type
string
Properties
Group, Nillable, Sort

1684

Standard Objects

Field Name

ResourceAbsenceHistory

Details
Description
The title of the feed item. When the Type is LinkPost, the Link URL is the
URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of feed item.

ResourceAbsenceHistory
Represents the history of changes made to tracked fields on a resource absence. This object is available in API version 38.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed.

1685

Standard Objects

RevenueForecast

Field Name

Details

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The value of the field before it was changed.

ResourceAbsenceId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the resource absence being tracked. The history is displayed on the detail
page for this record.

RevenueForecast
Represents a revenue-based forecast.
Use QuantityForecast for quantity-based forecasts.

Supported Calls
create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules
Customer Portal users can't access this object.

Fields
Field

Details

Closed

Type
currency
Properties
Create, Filter
Description
Read only. A rollup of opportunities or opportunity line items that have
closed in this period.

1686

Standard Objects

RevenueForecast

Field

Details

Commit

Type
currency
Properties
Filter, Nillable
Description
The owner's Commit total.

CommitComment

Type
string
Properties
Filter, Nillable, Update
Description
Read only. The comment entered when the owner edited his or her Commit
total from the Adjusted Total link on the forecast edit page.

CommitOverride

Type
currency
Properties
Filter, Nillable, Update
Description
Read only. The owner's override of their own My Commit total.

CurrencyIsoCode

Type
picklist
Properties
Filter, Restricted picklist, Update
Description
Available only for organizations with the multicurrency feature enabled.
Contains the ISO code for any currency allowed by the organization. You
can update or upsert this field and Quota only.

DefaultRollupCommit

Type
currency
Properties
Filter, Nillable
Description
Read only. The owner's standard Commit rollup, including their own
opportunities and forecast-level overrides from subordinate users in the role
hierarchy.

DefaultRollupUpside

Type
currency

1687

Standard Objects

Field

RevenueForecast

Details
Properties
Filter, Nillable
Description
Read only. The owner's standard Best Case rollup, including their own
opportunities and forecast-level overrides from subordinate users in the role
hierarchy.

InvalidationDate

Type
dateTime
Properties
Filter, Nillable
Description
Read only. If not blank, indicates that the rollup numbers for Forecast Override
fields that represent calculated (summarized) amounts may not be up to
date.

ManagerChoiceCommit

Type
picklist
Properties
Filter, Nillable, Restricted picklist, Update
Description
Read only. The manager's choice regarding the commit amount:
• DefaultRollup: Use the manager's default commit rollup for owner's
forecast, which reflects the manager's opportunity forecast overrides.
• AcceptForecast (default selection): Accept the forecast owner's Adjusted
Total commit amount, which may or may not be an override.
• ManagerManualOverride: Use the manager's manual override.
• OpportunityOnlyRollup: Use the opportunity rollup, including opportunity
forecast overrides, but excluding any forecast-level (Adjusted Total)
overrides.

ManagerChoiceUpside

Type
picklist
Properties
Filter, Nillable, Restricted picklist, Update
Description
Read only. The manager's choice regarding the best case amount:
• DefaultRollup: Use the manager's default best case rollup for owner's
forecast, which reflects the manager's opportunity forecast overrides.
• AcceptForecast (default selection): Accept the forecast owner's Adjusted
Total best case amount, which may or may not be an override.
• ManagerManualOverride: Use the manager's manual override.

1688

Standard Objects

Field

RevenueForecast

Details
• OpportunityOnlyRollup: Use the opportunity rollup, including opportunity
forecast overrides, but excluding any forecast-level (Adjusted Total)
overrides.

ManagerClosed

Type
currency
Properties
Filter, Nillable
Description
Read only. The manager's closed total for the owner's forecast, including
any opportunity or opportunity product overrides made by the manager.

ManagerCommit

Type
currency
Properties
Filter, Nillable
Description
The manager's Commit total.

ManagerCommitOverride

Type
currency
Properties
Filter, Nillable, Update
Description
Read only. The manager's manual override of the forecast owner's Commit
total. Represents an option in the override popup window, which allows
managers to choose how to roll up the forecast numbers of a direct report.

ManagerDefaultRollupCommit

Type
currency
Properties
Filter, Nillable
Description
Read only. The manager's standard Commit rollup for the forecast owner.
Represents an option in the override pop-up window, which allows managers
to choose how to roll up the forecast numbers of a direct report.

ManagerDefaultRollupUpside

Type
currency
Properties
Filter, Nillable

1689

Standard Objects

Field

RevenueForecast

Details
Description
Read only. The manager's standard Best Case rollup for the forecast owner.
Represents an option in the override pop-up window, which allows managers
to choose how to roll up the forecast numbers of a direct report.

ManagerId

Type
reference
Properties
Filter, Nillable
Description
Read only. ID of the direct manager of the user who owns this forecast.

ManagerOpportunityRollupCommit

Type
currency
Properties
Filter, Nillable
Description
The manager's view of the forecast owner's opportunity-level Commit rollup,
ignoring all forecast overrides. Represents an option in the override pop-up
window, which allows managers to choose how to roll up the forecast
numbers of a direct report.

ManagerOpportunityRollupUpside

Type
currency
Properties
Filter, Nillable
Description
The manager's view of the forecast owner's opportunity-level Best Case
rollup, ignoring all forecast overrides. Represents an option in the override
pop-up window, which allows managers to choose how to roll up the
forecast numbers of a direct report.

ManagerPipeline

Type
currency
Properties
Filter, Nillable
Description
The manager's pipeline total for the owner's forecast, including any
opportunity or opportunity product overrides made by the manager.

ManagerTerritoryId

Type
reference

1690

Standard Objects

Field

RevenueForecast

Details
Properties
Filter, Nillable
Description
ID of the manager's UserRole or Territory.

ManagerUpside

Type
currency
Properties
Filter, Nillable
Description
The manager's Best Case total.

ManagerUpsideOverride

Type
currency
Properties
Filter, Nillable, Update
Description
The manager's manual override of the forecast owner's Best Case total.
Represents an option in the override pop-up window, which allows managers
to choose how to roll up the forecast numbers of a direct report.

OpportunityRollupClosed

Type
currency
Properties
Filter, Nillable
Description
The owner's Closed total for his or her opportunities only.

OpportunityRollupCommit

Type
currency
Properties
Filter, Nillable
Description
The owner's Commit total for his or her opportunities only.

OpportunityRollupPipeline

Type
currency
Properties
Filter, Nillable
Description
The owner's Pipeline total for his or her opportunities only.

1691

Standard Objects

RevenueForecast

Field

Details

OpportunityRollupUpside

Type
currency
Properties
Filter, Nillable
Description
Read only. The owner's Best Case total for his or her opportunities only.

OwnerId

Type
reference
Properties
Create, Defaulted on create, Filter
Description
ID of the User who owns this forecast. Required on create.

PeriodId

Type
reference
Properties
Filter, Nillable
Description
The ID of the Period that contains the StartDate.

Pipeline

Type
currency
Properties
Filter, Nillable
Description
The total pipeline rollup from subordinates in the role hierarchy, including
the owner's opportunities.

ProductFamily

Type
picklist
Properties
Create, Filter, Nillable
Description
The value chosen in the Product Family picklist, which can be configured
from the object management settings for products. This field is relevant if
you have chosen Product Families as the Forecast Type in Forecasts Settings.
If you are not forecasting by product family or if the forecast represents
opportunities that are not associated with a product family, then this field
is blank. Otherwise, this field is required on create.

1692

Standard Objects

RevenueForecast

Field

Details

Quota

Type
currency
Properties
Create, Filter, Nillable, Update
Description
The quota amount for the period. You can update or upsert this field and
CurrencyIsoCode, and for Quota only, create. Requires the “Modify
All Data” and “Manage Users” permission. Required on create.

StartDate

Type
date
Properties
Create, Filter, Nillable
Description
The start date of this forecast. The period ID of the period that contains this
date is written to the PeriodId field if it changes. A new Period is created
if none exists. Required on create.

TerritoryId

Type
reference
Properties
Create, Filter, Nillable
Description
ID of the forecast owner's UserRole or Territory. Required on create if Territory
Management is enabled (if this field is available).

Upside

Type
currency
Properties
Filter, Nillable
Description
The owner's Best Case total.

UpsideComment

Type
string
Properties
Filter, Nillable, Update
Description
Read only. The comment entered when the owner edited his or her Best
Case total. Label is Best Case Comment.

1693

Standard Objects

RevenueForecastHistory

Field

Details

UpsideOverride

Type
currency
Properties
Filter, Nillable, Update
Description
Read only. The owner's override of their My Best Case total. Label is Best
Case Override.

Usage
Query this object to support customizable forecasts based on revenue. Requires the “View All Data” permission.
You can also update CurrencyIsoCode and Quota, which means that you can mass update sales users' quotas instead of updating
them one by one in the user interface. Editing Quota requires “Modify All Data” and “Manage Users” permissions.
The rollup fields always reflect opportunity and opportunity product overrides by the forecast owner or one of the forecast owner’s
subordinates in the role hierarchy. In addition, the manager rollup fields include overrides by the forecast owner's direct manager in the
role hierarchy.
Some of the rollup fields ignore forecast-level (Adjusted Total) overrides, but they never ignore opportunity forecast overrides that are
visible to the owner or manager.
SEE ALSO:
QuantityForecast
RevenueForecastHistory
Object Basics

RevenueForecastHistory
Represents historical information about revenue-based forecasts that have been submitted (saved) in the user interface.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
• Requires the “View All Data” permission.
• Customer Portal users can’t access this object.

1694

Standard Objects

RevenueForecastHistory

Fields
Field

Details

Closed

Type
currency
Properties
Filter Nillable
Description
The closed amount of the forecast.

Commit

Type
currency
Properties
Filter, Nillable
Description
The commit amount of the forecast.

CommitComments

Type
string
Properties
Filter, Nillable
Description
Comments about the commit value.

CommitOverridden

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the commit value was overridden (true) or not (false).

CurrencyIsoCode

ForecastOverrideId

Type
reference
Properties
Filter

1695

Standard Objects

Field

RevenueForecastHistory

Details
Description
ID of the related forecast override.

Pipeline

Type
currency
Properties
Filter, Nillable
Description
The pipeline amount of the forecast.

Quota

Type
currency
Properties
Filter, Nillable
Description
The quota amount of the forecast.

Upside

Type
currency
Properties
Filter, Nillable
Description
The best case amount of the forecast.

UpsideComments

Type
string
Properties
Filter, Nillable
Description
Comments about the upside value.

UpsideOverridden

Type
boolean
Properties
Defaulted on create Filter
Description
Indicates whether the upside value was overridden (true) or not (false).

Usage
This is a read-only object specific to customizable forecasting.

1696

Standard Objects

RuleTerritory2Association

When a user submits a revenue-based forecast in the user interface, a new record is created. If the same forecast is ever resubmitted,
additional records are added. The CreatedDate of a record reflects the day on which the forecast was submitted. This object respects
field-level security on the parent object.
SEE ALSO:
QuantityForecastHistory
RevenueForecast
Object Basics

RuleTerritory2Association
Represents a record-assignment rule and its association to an object, such as Account. Available only if Enterprise Territory Management
has been enabled for your organization.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

IsInherited

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates whether the rule is an inherited rule (true) or a local rule (false).
Rule inheritance flows from the parent territory where the rule is created to the
rule’s descendent territories (if any) in the territory model hierarchy. A local rule
is created within a single territory and affects that territory only.

RuleId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the rule.

1697

Standard Objects

SamlSsoConfig

Field Name

Details

Territory2Id

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the territory where the rule was created.

SamlSsoConfig
Represents a SAML Single Sign-On configuration. This object is available in API version 32.0 and later.
Single sign-on is a process that allows network users to access all authorized network resources without having to log in separately to
each resource. Single sign-on allows you to validate usernames and passwords against your corporate user database or other client
application rather than having separate user passwords managed by Salesforce.

Supported Calls
describeSObjects(), query(), retrieve()

Fields
Field Name

Details

AttributeFormat

Type
string
Properties
Filter, Group, Nillable, Sort
Description
For SAML 2.0 only and when identityLocation is set to Attribute.
Possible values include unspecified, emailAddress or persistent.
All legal values can be found in the “Name Identifier Format Identifiers” section
of the Assertions and Protocols SAML 2.0 specification.

AttributeName

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the identity provider’s application. Get this name value from your
identity provider.

1698

Standard Objects

SamlSsoConfig

Field Name

Details

Audience

Type
string
Properties
Filter, Group, Sort
Description
The Issuer, also called the “Entity ID.” The value is a URL that uniquely identifies
the SAML identity provider.

DeveloperName

Type
string
Properties
Filter, Group, Sort
Description
The unique name of the object in the API. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must begin with
a letter, not include spaces, not end with an underscore, and not contain two
consecutive underscores. In managed packages, this field prevents naming
conflicts on package installations. With this field, a developer can change the
object’s name in a managed package, and the changes are reflected in a
subscriber’s organization.

ErrorUrl

Type
string
Properties
Filter, Nillable, Sort
Description
The URL of the page users should be directed to if there’s an error during SAML
login. It must be a publicly accessible page, such as a public site Visualforce page.
The URL can be absolute or relative.

ExecutionUserID

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The user that runs the Apex handler class. The user must have the “Manage Users”
permission. A user is required if you specify a SAML JIT handler class.

IdentityLocation

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort

1699

Standard Objects

Field Name

SamlSsoConfig

Details
Description
The location in the assertion where a user is identified. Valid values are:
• SubjectNameId—The identity is in the statement of the
assertion.
• Attribute—The identity is specified in an ,
located in the of the assertion.

IdentityMapping

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The identifier that the service provider uses for the user during Just-in-Time user
provisioning. Valid values are:
• Username—The user’s Salesforce username.
• FederationId—The federation ID from the user object; the identifier
that’s used by the service provider for the user.
• UserId—The user ID from the user’s Salesforce organization.

Issuer

Type
string
Properties
Filter, idLookup, Group, Sort
Description
Also called the “Entity ID.” The value is a URL that uniquely identifies the SAML
identity provider.

Language

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The language for the organization.

LoginUrl

Type
string
Properties
Filter, Nillable, Sort
Description
For SAML 2.0 only: The URL where Salesforce sends a SAML request to start the
login sequence.

1700

Standard Objects

SamlSsoConfig

Field Name

Details

LogoutUrl

Type
string
Properties
Filter, Nillable, Sort
Description
For SAML 2.0 only: The URL to direct users to where they click the Logout link.
The default is http://www.salesforce.com.

MasterLabel

Type
string
Properties
Filter, Group, Sort
Description
The text that’s used to identify the Visualforce page in the Setup area of Salesforce.

NamespacePrefix

OptionsSpInitBinding

Type
boolean
Properties
Filter
Description
The service provider initiated request binding, either HTTP Redirect (true) or
HTTP POST (false).

1701

Standard Objects

SamlSsoConfig

Field Name

Details

OptionsUserProvisioning

Type
boolean
Properties
Filter
Description
If true, Just-in-Time user provisioning is enabled, which creates users on the
fly the first time that they try to log in. Specify Federation ID for the
identityMapping value to use this feature.

RequestSignatureMethod

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The method that’s used to sign the SAML request. Valid values are:
• RSA-SHA1
• RSA-SHA256

SamlJitHandlerId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The name of an existing Apex class that implements the
Auth.SamlJitHandler interface.

ValidationCert

Type
string
Properties
Filter, Sort
Description
The certificate that’s used to validate the request. Get this certificate value from
your identity provider.

Version

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The SAML version. Valid values are:
• SAML1_1

1702

Standard Objects

Scontrol

Field Name

Details
• SAML2_2

Scontrol
A custom s-control, which is custom content that is hosted by the system but executed by the client application.
Important: Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them.
Existing s-controls are unaffected, and can still be edited. We recommend that you move your s-controls to Visualforce. We continue
to support the Scontrol object.
Represents a custom s-control, which is custom content that the system hosts, but client applications execute. An s-control can contain
any type of content that you can display or run in a Web browser.

Supported Calls
delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()

Special Access Rules
• Your organization must be using Enterprise, Developer, or Unlimited Edition and be enabled for custom s-controls.
• Customer Portal users can’t access this object.

Fields
Field

Details

Binary

Type
base64
Properties
Nillable, Update
Description
Binary content of this custom s-control, such as an ActiveX control or a Java archive. Can be
specified when created, but not when updated. Limit: 5 MB.

BodyLength

Type
int
Properties
Filter, Group, Sort
Description
The length of the custom s-control. Label is Binary Length.

ContentSource

Type
picklist

1703

Standard Objects

Field

Scontrol

Details
Properties
Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the source of the s-control content, either custom HTML, a snippet (s-controls that
are included in other s-controls), or a URL.

Description

Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
Description of the custom s-control.

DeveloperName

Type
string
Properties
Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores and
alphanumeric characters, and must be unique in your org. It must begin with a letter, not
include spaces, not end with an underscore, and not contain two consecutive underscores.
In managed packages, this field prevents naming conflicts on package installations. With
this field, a developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization. Label is S-Control Name.
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

EncodingKey

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort, Update
Description
Picklist of character set encodings, including ISO-08859-1, UTF-8, EUC, JIS, Shift-JIS, Korean
(ks_c_5601-1987), Simplified Chinese (GB2312), and Traditional Chinese (Big5).

Filename

Type
string
Properties
Filter, Group, Nillable, Sort, Update

1704

Standard Objects

Field

Scontrol

Details
Description
An uploaded object to display when the custom s-control is added to a custom link. Can be
a Java applet, an ActiveX control, or any other type of desired content.

HtmlWrapper

Type
textarea
Properties
Update
Description
Required. HTML page that will be delivered when the user views this custom s-control. This
HTML page can be the entire content of the custom s-control, or it can reference the binary.
Limit: 1,048,576 characters. Label is HTML Body.

Name

Type
string
Properties
Filter, Group, Sort, Update
Description
Required. Name of this custom s-control. Label is Label.

NamespacePrefix

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that
creates a managed package has a unique namespace prefix. Limit: 15 characters. You can
refer to a component in a managed package by using the
namespacePrefix__componentName notation.
The namespace prefix can have one of the following values:
• In Developer Edition organizations, the namespace prefix is set to the namespace prefix
of the organization for all objects that support it. There is an exception if an object is in
an installed managed package. In that case, the object has the namespace prefix of the
installed managed package. This field’s value is the namespace prefix of the Developer
Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix
is only set for objects that are part of an installed managed package. There is no
namespace prefix for all other objects.

SupportsCaching

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update

1705

Standard Objects

Field

ScontrolLocalization

Details
Description
Indicates whether the s-control supports caching (true) or not (false).

Usage
Use custom s-controls to manage custom content that extends application functionality. All users can view custom s-controls, but the
“Customize Application” permission is required to create or update custom s-controls.
SEE ALSO:
Object Basics

ScontrolLocalization
The translated value of the field label for an s-control.
Important: Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them.
Existing s-controls are unaffected, and can still be edited.
When the Translation Workbench is enabled for your organization, provides the translation of the field label of an s-control.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Special Access Rules
• Your organization must be using Professional, Enterprise, Developer, or Unlimited Edition and be enabled for the Translation
Workbench.
• To view this object, you must have the “View Setup and Configuration” permission.

Fields
Field

Details

LanguageLocaleKey

Type
picklist
Properties
Create,
Filter,
Nillable, Restricted picklist

1706

Standard Objects

Field

ScontrolLocalization

Details
Description
This field is available in API version 16.0 and earlier. It is the same as the Language
field.

Language

Type
picklist
Properties
Create, Filter, Nillable, Restricted picklist
Description
This field is available in API version 17.0 and later. The combined language and locale
ISO code, which controls the language for labels displayed in an application.
This picklist contains the following fully-supported languages:
• Chinese (Simplified): zh_CN
• Chinese (Traditional): zh_TW
• Danish: da
• Dutch: nl_NL
• English: en_US
• Finnish: fi
• French: fr
• German: de
• Italian: it
• Japanese: ja
• Korean: ko
• Norwegian: no
• Portuguese (Brazil): pt_BR
• Russian: ru
• Spanish: es
• Spanish (Mexico): es_MX
• Swedish: sv
• Thai: th
The following end-user only languages are available.
• Arabic: ar
• Bulgarian: bg
• Croatian: hr
• Czech: cs
• English (UK): en_GB
• Greek: el
• Hebrew: iw

1707

Standard Objects

Field

ScontrolLocalization

Details
• Hungarian: hu
• Indonesian: in
• Polish: pl
• Portuguese (Portugal): pt_PT
• Romanian: ro
• Slovak: sk
• Slovenian: sl
• Turkish: tr
• Ukrainian: uk
• Vietnamese: vi
The following platform languages are available for organizations that use Salesforce
exclusively as a platform.
• Albanian: sq
• Arabic (Algeria): ar_DZ
• Arabic (Bahrain): ar_BH
• Arabic (Egypt): ar_EG
• Arabic (Iraq): ar_IQ
• Arabic (Jordan): ar_JO
• Arabic (Kuwait): ar_KW
• Arabic (Lebanon): ar_LB
• Arabic (Libya): ar_LY
• Arabic (Morocco): ar_MA
• Arabic (Oman): ar_OM
• Arabic (Qatar): ar_QA
• Arabic (Saudi Arabia): ar_SA
• Arabic (Sudan): ar_SD
• Arabic (Syria): ar_SY
• Arabic (Tunisia): ar_TN
• Arabic (United Arab Emirates): ar_AE
• Arabic (Yemen): ar_YE
• Armenian: hy
• Basque: eu
• Bosnian: bs
• Bengali: bn
• Chinese (Simplified—Singapore): zh_SG
• Chinese (Traditional—Hong Kong): zh_HK
• English (Australia): en_AU
• English (Canada): en_CA

1708

Standard Objects

Field

ScontrolLocalization

Details
• English (Hong Kong): en_HK
• English (India): en_IN
• English (Ireland): en_IE
• English (Malaysia): en_MY
• English (Philippines): en_PH
• English (Singapore): en_SG
• English (South Africa): en_ZA
• Estonian: et
• French (Belgium): fr_BE
• French (Canada): fr_CA
• French (Luxembourg): fr_LU
• French (Switzerland): fr_CH
• Georgian: ka
• German (Austria): de_AT
• German (Luxembourg): de_LU
• German (Switzerland): de_CH
• Hindi: hi
• Icelandic: is
• Irish: ga
• Italian (Switzerland): it_CH
• Latvian: lv
• Lithuanian: lt
• Luxembourgish: lb
• Macedonian: mk
• Malay: ms
• Maltese: mt
• Romanian (Moldova): ro_MD
• Montenegrin: sh_ME
• Romansh: rm
• Serbian (Cyrillic): sr
• Serbian (Latin): sh
• Spanish (Argentina): es_AR
• Spanish (Bolivia): es_BO
• Spanish (Chile): es_CL
• Spanish (Colombia): es_CO
• Spanish (Costa Rica): es_CR
• Spanish (Dominican Republic): es_DO
• Spanish (Ecuador): es_EC

1709

Standard Objects

Field

ScontrolLocalization

Details
• Spanish (El Salvador): es_SV
• Spanish (Guatemala): es_GT
• Spanish (Honduras): es_HN
• Spanish (Nicaragua): es_NI
• Spanish (Panama): es_PA
• Spanish (Paraguay): es_PY
• Spanish (Peru): es_PE
• Spanish (Puerto Rico): es_PR
• Spanish (United States): es_US
• Spanish (Uruguay): es_UY
• Spanish (Venezuela): es_VE
• Tagalog: tl
• Tamil: ta
• Urdu: ur
• Welsh: cy
The values in this field are not related to the default locale selection.

NamespacePrefix

ScontrolId

Type
reference
Properties
Create, Filter, Nillable

1710

Standard Objects

Field

SearchPromotionRule

Details
Description
The ID of the Scontrol that is being translated.

Value

Type
string
Properties
Create, Filter, Nillable, Update
Description
The actual translated field label of the s-control. Label is Translation.

Usage
Use this object to translate your s-controls into a supported language. Users with the Translation Workbench enabled can view s-control
translations, but either the “Customize Application” or “Manage Translation” permission is required to create or update s-control
translations.
SEE ALSO:
CategoryNodeLocalization
WebLinkLocalization

SearchPromotionRule
Represents a promoted search term, which is one or more keywords that you associate with a Salesforce Knowledge article. When a
user’s search query includes these keywords, the associated article is returned first in search results. This object is available in API version
31.0 and later.

Supported Calls
create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()

Special Access Rules
A user must have the “Manage Promoted Search Terms” permission.

Fields
Field Name

Details

PromotedEntityId

Type
reference

1711

Standard Objects

Field Name

SecureAgent

Details
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the KnowledgeArticleVersion that the promoted search term is
associated with. The article must be in published status.

Query

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The text of the promoted search term. Maximum length: 100 characters.
You can associate the same promoted search term with multiple articles. If the
user’s search matches the promoted term, all associated articles are promoted
in search results, ordered by relevancy. For best results, create promoted search
terms selectively and limit the number of articles that are promoted per term.

Usage
Use this object to optimize article search results in Salesforce Knowledge.

SecureAgent
Represents a Secure Agent that connects Salesforce to on-premises external data sources like SharePoint 2010 and 2013. This object is
available in API version 32.0 and later.

Supported Calls
describeSObjects(), query(), retrieve()

Fields
Field Name

Details

DeveloperName

1712

Standard Objects

Field Name

SecureAgent

Details
a letter, not include spaces, not end with an underscore, and not contain two
consecutive underscores. In managed packages, this field prevents naming
conflicts on package installations. With this field, a developer can change the
object’s name in a managed package and the changes are reflected in a
subscriber’s organization.
Note: When creating large sets of data, always specify a unique
DeveloperName for each record. If no DeveloperName is specified,
performance may slow while Salesforce generates one for each record.

Language

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The language of agent labels in the user interface.

MasterLabel

Type
string
Properties
Filter, Group, Sort
Description
The user-interface name for the agent.

Priority

Type
int
Properties
Filter, Group, Nillable, Sort
Description
Specifies the order in which this agent is accessed relative to others in a Secure
Agent cluster.
This field is available in API version 35 and later.

ProxyUserId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user profile specific to the agent.

SecureAgentsClusterId

Type
reference

1713

Standard Objects

Field Name

SecureAgentsCluster

Details
Properties
Filter, Group, Nillable, Sort
Description
The ID of a cluster of agents that contains this individual agent. Clusters provide
failover protection if an agent on a particular server becomes inaccessible. To
edit them, use the SecureAgentsCluster object.
This field is available in API version 35 and later.

SecureAgentsCluster
Represents a cluster consisting of several Secure Agents on different servers. Clusters provide failover protection if an agent on a particular
server becomes inaccessible. This object is available in API version 35.0 and later.
Secure Agents connect Salesforce to content in on-premises external data sources, such as SharePoint 2010 and 2013. To edit individual
agents that are part of a cluster, use the SecureAgent object.

Supported Calls
describeLayout(), describeSObjects(), query(), retrieve()

Fields
Field Name

Details

Description

Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
Describes details about the cluster, providing context to other developers.

DeveloperName

1714

Standard Objects

Field Name

SecurityCustomBaseline (Beta)

Details
object’s name in a managed package and the changes are reflected in a
subscriber’s organization.
Note: When creating large sets of data, always specify a unique
DeveloperName for each record. If no DeveloperName is specified,
performance may slow while Salesforce generates one for each record.

Language

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The language of cluster labels in the user interface.

MasterLabel

Type
string
Properties
Filter, Group, Sort
Description
The user-interface name for the cluster.

SecurityCustomBaseline (Beta)
Provides the ability to read, create, and delete user-defined custom security baselines, which define an org’s security standards. This
object is available in API version 39.0 and later.
This release contains a beta version of Custom Baseline, which means it’s a high-quality feature with known limitations. General availability,
with complete documentation and support, is planned for a subsequent release.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules
You must have the “View Health Check” permission to read a custom baseline, and the “Manage Health Check” permission to create,
edit, or delete one.

1715

Standard Objects

SecurityCustomBaseline (Beta)

Fields
Field Name

Details

Baseline

Type
textarea
Properties
Create, Nillable, Update
Description
The definition an org’s security settings standards.

DeveloperName

Language

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the presence status.

MasterLabel

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Label for the category node.

NamespacePrefix

Type
string
Properties
Filter, Group, Nillable, Sort

1716

Standard Objects

SelfServiceUser

Field Name

Details
Description
The namespace prefix associated with the package.

SelfServiceUser
Represents a Contact who has been enabled to use your organization’s Self-Service portal, where he or she can obtain online support.
Note: Starting with Spring ’12, the Self-Service portal isn’t available for new orgs. Existing orgs continue to have access to the
Self-Service portal.

Supported Calls
create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules
Customer Portal users can't access this object.

Fields
Field

Details

ContactId

Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. All Self-Service users must be associated with a Contact. The contact’s email should
match the Self-Service user email. The contact must have a value in the AccountId field
or an error occurs.

Type
email
Properties
Create, Filter, Group, Sort, Update
Description
Required. Make this the same as the email address for the Contact associated with this
SelfServiceUser. Password resets and other system communication will be sent to this email
address.

FirstName

Type
string

1717

Standard Objects

Field

SelfServiceUser

Details
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
First name of the Self-Service user.

IsActive

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the Self-Service user is allowed to log in to the Self-Service portal (true)
or not (false). Note that there is no way to delete a Self-Service user. They can only be
marked as inactive.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

LanguageLocaleKey

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. This is a restricted picklist field. It is the primary language for the user. All on-screen
text in the Self-Service portal is displayed in this language.

LastLoginDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the Self-Service user last logged in.

LastName

Type
string
Properties
Create, Filter, Group, Sort, Update

1718

Standard Objects

Field

SelfServiceUser

Details
Description
Required. Last name of the Self-Service user.

LocaleSidKey

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. This is a restricted picklist field. The value of this field affects the formatting and
parsing of values, especially numeric values, in the Self-Service portal. Values are two-letter
codes that indicate language and sometimes language and country. The codes are based
on ISO standards.

Name

Type
string
Properties
Filter, Group, Sort
Description
Concatenation of FirstName and LastName. Limited to 121 characters.

SuperUser

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this Self-Service user is a super user with additional access on his or her
company's Self-Service portal (true) or not (false).

TimeZoneSidKey

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. This is a restricted picklist field. The time zone of a affects the offset used when
displaying or entering times in the Self-Service portal.

Username

Type
string
Properties
Create, Filter, Group, Sort, Update

1719

Standard Objects

Field

ServiceAppointment

Details
Description
Required. This contains the name that a Self-Service user enters to log into the Self-Service
portal. Value must be unique in your organization. If you try to create or update a user with
a duplicate value, the operation is rejected and an error is returned.

Usage
For security reasons, you can’t query Self-Service user passwords via the API or the user interface. However, the API allows you to set and
reset Self-Service user passwords using the setPassword() and resetPassword() calls.
SelfServiceUser records created from the API don’t cause a notification email to be sent. If you want to notify the user, you must send
them an email after creating the user.
SEE ALSO:
Contact
User

ServiceAppointment
Represents an appointment to complete field service work for a customer. This object is available in API version 38.0 and later.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), search(), undelete(), update(), upsert()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

AccountId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
(Read only) The account associated with the appointment. If the parent record
is a work order or work order line item, this field’s value is inherited from the
parent. Otherwise, it remains blank.

1720

Standard Objects

ServiceAppointment

Field Name

Details

ActualDuration

Type
int
Properties
Create, Filter, Nillable, Sort, Update
Description
The number of minutes that it took the resource to complete the appointment
after arriving at the address. When values are first added to the Actual
Start and Actual End fields, the Actual Duration is automatically
populated to list the difference between the Actual Start and Actual
End. If the Actual Start and Actual End fields are subsequently
updated, the Actual Duration field doesn’t re-update, but you can
manually update it.

ActualEndTime

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The actual date and time the appointment ended.

ActualStartTime

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The actual date and time the appointment started.

Address

Type
address
Properties
Filter
Description
The address where the appointment is taking place. The address is inherited from
the parent record if the parent record lists an address.

AppointmentNumber

Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
An auto-assigned number that identifies the appointment.

1721

Standard Objects

ServiceAppointment

Field Name

Details

ArrivalWindowEndTime

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The end of the window of time in which the technician is scheduled to arrive at
the site. This window is typically larger than the Scheduled Start and End window
to allow time for delays and scheduling changes. You may choose to share the
Arrival Window Start and End with the customer, but keep the Scheduled Start
and End internal-only.

ArrivalWindowStartTime

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The beginning of the window of time in which the technician is scheduled to
arrive at the site. This window is typically larger than the Scheduled Start and
End window to allow time for delays and scheduling changes. You may choose
to share the Arrival Window Start and End with the customer, but keep the
Scheduled Start and End internal-only.

City

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city where the appointment is completed. Maximum length is 40 characters.

ContactId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact associated with the parent record. If needed, you can manually
update the service appointment contact.

Country

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update

1722

Standard Objects

Field Name

ServiceAppointment

Details
Description
The country where the work order is completed. Maximum length is 80 characters.

Description

Type
textarea
Properties
Create, Nillable, Update
Description
The description of the appointment.

DueDate

Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date by which the appointment must be completed. Earliest Start Permitted
and Due Date typically reflect terms in the customer’s service-level agreement.

Duration

Type
double
Properties
Create, Nillable, Filter, Sort, Update
Description
The estimated length of the appointment. If the parent record is work order or
work order line item, the appointment inherits its parent’s duration, but it can
be manually updated. The duration is in minutes or hours based on the value
selected in the Duration Type field.

DurationType

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of the Duration: Minutes or Hours.

EarliestStartTime

Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date after which the appointment must be completed. Earliest Start Permitted
and Due Date typically reflect terms in the customer’s service-level agreement.

1723

Standard Objects

ServiceAppointment

Field Name

Details

GeocodeAccuracy

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The level of accuracy of a location’s geographical coordinates compared with its
physical address. Usually provided by a geocoding service based on the address’s
latitude and longitude coordinates.
Note: This field is available in the API only.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the service appointment was last modified. Its label in the user
interface is Last Modified Date.

LastViewedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the service appointment was last viewed.

Latitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the address where
the service appointments is completed. Acceptable values are numbers between
–90 and 90 with up to 15 decimal places.
Note: This field is available in the API only.

Longitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update

1724

Standard Objects

Field Name

ServiceAppointment

Details
Description
Used with Latitude to specify the precise geolocation of the address where
the service appointment is completed. Acceptable values are numbers between
–180 and 180 with up to 15 decimal places.
Note: This field is available in the API only.

OwnerId

Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the service appointment.

ParentRecordId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The parent record associated with the appointment.

ParentRecordStatusCategory

Type
string
Properties
Group, Nillable, Sort
Description
(Read only) The Status Category of the parent record. If the parent record
is a work order or work order line item, this field is populated; otherwise, it remains
blank.

ParentRecordType

Type
string
Properties
Group, Nillable, Sort
Description
(Read only) The type of parent record: Account, Asset, Opportunity, Work Order,
or Work Order Line Item.

PostalCode

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update

1725

Standard Objects

Field Name

ServiceAppointment

Details
Description
The postal code where the work order is completed. Maximum length is 20
characters.

SchedEndTime

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The time at which the appointment is scheduled to end. If you are using the Field
Service Lightning managed packages with the scheduling optimizer, this field is
populated once the appointment is assigned to a resource. Scheduled End
– Scheduled Start = Estimated Duration.

SchedStartTime

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The time at which the appointment is scheduled to start. If you are using the
Field Service Lightning managed packages with the scheduling optimizer, this
field is populated once the appointment is assigned to a resource.

ServiceTerritoryId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The service territory associated with the appointment. If the parent record is a
work order or work order line item, the appointment inherits its parent’s service
territory.

State

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state where the service appointment is completed. Maximum length is 80
characters.

Status

Type
picklist

1726

Standard Objects

Field Name

ServiceAppointment

Details
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The status of the appointment. The picklist includes the following values, which
can be customized:
• None—Default value.
• Scheduled—Appointment has been assigned to a service resource.
• Dispatched—Assigned service resource has been notified about their
assignment.
• In Progress—Work has begun.
• Completed—Work is complete.
• Cannot Complete—Work could not be completed.
• Canceled—Work is canceled, typically before any work began

StatusCategory

Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The category that each Status value falls into. The Status Category
field has seven values which are identical to the default Status values.
If you create custom Status values, you must indicate which category it
belongs to. For example, if you create a Customer Absent value, you may
decide that it belongs in the Cannot Complete category.
The Status Category field can be useful to reference in custom apps,
triggers, and validation rules. Status categories let you extend and customize the
work life cycle while still maintaining a consistent work classification for tracking,
reporting, and business process management.

Street

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street number and name where the service appointment is completed.

Subject

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update

1727

Standard Objects

Field Name

ServiceAppointmentFeed

Details
Description
A short phrase describing the appointment.

Usage
Service appointments always have a parent record, which can be a work order, work order line item, opportunity, account, or asset. The
type of parent record tells you about the nature of the service appointment:
• Service appointments on work orders and work order line items offer a more detailed view of the work being performed. While work
orders and work order line items let you enter general information about a task, service appointments are where you add the details
about scheduling and ownership.
• Service appointments on assets represent work being performed on the asset.
• Service appointments on accounts represent work being performed for the account.
• Service appointments on opportunities represent work that is related to the opportunity.

ServiceAppointmentFeed
Represents a single feed item on a service appointment record detail page. This object is available in API version 38.0 and later.
A service appointment feed shows changes to tracked fields on a service appointment record. It also shows posts and comments about
the record. It’s a useful way to stay up to date with changes made to service appointments in Salesforce.

Supported Calls
delete(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort

1728

Standard Objects

Field Name

ServiceAppointmentFeed

Details
Description
The message that appears in the feed. Required when Type is TextPost.
Optional when Type is ContentPost orLinkPost.

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of comments associated with this feed item.

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if an application
migrates posts and comments from another application into a feed, the value is
set to the ID of the logged-in user.

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
true indicates that the body of the feed contains rich text. false indicates
that the post is rendered as plain text.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of feed likes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a link post.

1729

Standard Objects

ServiceAppointmentHistory

Field Name

Details

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service appointment record tracked in the feed. The feed is displayed
on the detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a content post. This field
is null for all posts, except ContentPost.

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the Link URL is the
URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of feed item.

ServiceAppointmentHistory
Represents the history of changes made to tracked fields on a service appointment. This object is available in API version 38.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

1730

Standard Objects

ServiceAppointmentOwnerSharingRule

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The value of the field before it was changed.

ServiceAppointmentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service appointment being tracked. The history is displayed on the detail
page for this record.

ServiceAppointmentOwnerSharingRule
Represents the rules for sharing a service appointment with user records other than the owner or anyone above the owner in the role
hierarchy. This object is available in API version 38.0 and later.

1731

Standard Objects

ServiceAppointmentOwnerSharingRule

Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer
support to enable access to this object for your org.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Fields
Field

Details

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A description of the sharing rule. Maximum size is 1000 characters.

DeveloperName

Type
string
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores and
alphanumeric characters, and must be unique in your org. It must begin with a letter, not
include spaces, not end with an underscore, and not contain two consecutive underscores.
In managed packages, this field prevents naming conflicts on package installations. With
this field, a developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization. Corresponds to Rule Name in the user interface.
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

GroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the source group. A service appointment owned by a User in the source
Group triggers the rule to give access.

Name

Type
string

1732

Standard Objects

Field

ServiceAppointmentShare

Details
Properties
Create, Filter, Group, Sort, Update
Description
Label of the sharing rule as it appears in the user interface. Limited to 80 characters.
Corresponds to Label on the user interface.

ServiceAppointmentAccessLevel Type

picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
A value that represents the type of access granted to the target Group, or UserRole. The
possible values are:
• Read
• Edit
• All
UserOrGroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the User or Group being granted access.

ServiceAppointmentShare
Represents a sharing entry on a service appointment. This object is available in API version 38.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules
Field Service Lightning must be enabled.

1733

Standard Objects

ServiceAppointmentShare

Fields
Field Name

Details

AccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Level of access that the user or group has to the service appointment. The possible
values are:
• Read
• Edit
• All (This value isn’t valid for create or update calls.)
Set to an access level that is at least equal to the organization’s default service
appointment access level.

ParentId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The service appointment associated with the sharing entry.

RowCause

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The reason why this sharing entry exists. You can write to this field only when its
value is omitted or set to Manual (default). Valid values include:
• Manual—The user or group has access because a user with “All” access
manually shared the service appointment.
• Owner—The user is the owner of the service appointment.
• Team—The user or group has team access.
• Rule—The user or group has access via a service appointment sharing rule.

UserOrGroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
(Read only) ID of the user or group that has access to the service appointment.

1734

Standard Objects

ServiceChannel

ServiceChannel
Represents a channel of work items that are received from your organization—for example, cases, chats, or leads. This object is available
in API version 32.0 and later.

Supported Calls
create(), query(), retrieve(), update(), upsert()

Fields
Field

Details

CapacityPercentage

CapacityWeight

DeveloperName

Type
string
Properties
Create, Filter, Group, Sort, Update

1735

Standard Objects

Field

ServiceChannelStatus

Details
Description
The unique name of the object in the API. This name can contain only underscores and
alphanumeric characters, and must be unique in your org. It must begin with a letter, not
include spaces, not end with an underscore, and not contain two consecutive underscores.
In managed packages, this field prevents naming conflicts on package installations. With
this field, a developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization.
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

Language

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the service channel.

MasterLabel

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The label of the service channel.

RelatedEntity

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Unique, Update
Description
The type of object that’s associated with this service channel.

ServiceChannelStatus
Represents the status that’s associated with a specific service channel. This object is available in API version 32.0 and later.

Supported Calls
create(), delete(), query(), retrieve(), update()

1736

Standard Objects

ServiceContract

Fields
Field

Details

ServiceChannelId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the service channel.

ServicePresenceStatusId Type

reference
Properties
Create, Filter,Group, Nillable, Sort
Description
The ID of the presence status that’s associated with the service channel that’s specified by
the ServicePresenceChannelId.

ServiceContract
Represents a customer support contract (business agreement). This object is available in API version 18.0 and later.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), search(), undelete(), update(), upsert()

Fields
Field

Details

AccountId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the account associated with the service contract.

ActivationDate

Type
dateTime

1737

Standard Objects

Field

ServiceContract

Details
Properties
Filter, Nillable, Sort
Description
The initial day the service contract went into effect (whereas StartDate may include
a renewal date).

ApprovalStatus

Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Approval status of the service contract.

BillingAddress (beta)

Type
address
Properties
Filter, Nillable
Description
The compound form of the billing address. Read-only. See Address Compound Fields
for details on compound address fields.

BillingCity

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address. Maximum size is 40 characters.

BillingCountry

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address. Maximum size is 40 characters.

BillingCountryCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO country code for the service contract’s billing address.

1738

Standard Objects

ServiceContract

Field

Details

BillingLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with BillingLongitude to specify the precise geolocation of a billing
address. Acceptable values are numbers between –90 and 90 with up to 15 decimal
places.

BillingLongitude

BillingPostalCode

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address. Maximum size is 20 characters.

BillingState

Type
string
Properties
Group, Sort, Filter, Nillable
Description
Details for the billing address. Maximum size is 20 characters.

BillingStateCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO state code for the service contract’s billing address.

BillingStreet

Type
textarea
Properties
Filter, Group, Nillable, Sort

1739

Standard Objects

Field

ServiceContract

Details
Description
Street address for the billing address.

ContactId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Required. ID of the Contact associated with the service contract. Must be a valid ID.

ContractNumber

Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
Unique number automatically assigned to the service contract.

Description

Type
textarea
Properties
Nillable
Description
Description of the service contract.

Discount

Type
percent
Properties
Filter, Nillable, Sort
Description
The last day the service contract is in effect.
Weighted average of all contract line item discounts on the service contract.

EndDate

Type
date
Properties
Filter, Group, Nillable, Sort
Description
The last day the service contract is in effect.

GrandTotal

Type
currency

1740

Standard Objects

Field

ServiceContract

Details
Properties
Filter, Nillable, Sort
Description
Total price of the service contract plus shipping and taxes.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

LastReferencedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

LineItemCount

Type
int
Properties
Filter, Nillable, Group, Sort
Description
Number of ContractLineItem records associated with the service contract.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Name of the service contract.

1741

Standard Objects

ServiceContract

Field

Details

OwnerId

Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who currently owns the service contract.

ParentServiceContractId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The service contract’s parent service contract, if it has one.

Pricebook2Id

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the Pricebook2 associated with the service contract. Must be a valid ID.

RootServiceContractId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
(Read only) The top-level service contract in a service contract hierarchy. Depending
on where a service contract lies in the hierarchy, its root could be the same as its parent.

ShippingAddress (beta)

Type
address
Properties
Filter, Nillable
Description
The compound form of the shipping address. Read-only. See Address Compound Fields
for details on compound address fields.

ShippingCity

Type
string
Properties
Filter, Group, Nillable, Sort

1742

Standard Objects

Field

ServiceContract

Details
Description
Details of the shipping address. Maximum size is 40 characters.

ShippingCountry

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details of the shipping address. Country maximum size is 40 characters.

ShippingCountryCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO country code for the service contract’s shipping address.

ShippingLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with ShippingLongitude to specify the precise geolocation of a shipping
address. Acceptable values are numbers between –90 and 90 with up to 15 decimal
places.

ShippingLongitude

ShippingPostalCode

Type
string
Properties
Create, Filter, Nillable, Update
Description
Details of the shipping address. Postal code maximum size is 20 characters.

1743

Standard Objects

ServiceContract

Field

Details

ShippingState

Type
string
Properties
Create, Filter, Nillable, Update
Description
Details of the shipping address. State maximum size is 20 characters.

ShippingStateCode

Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO state code for the service contract’s shipping address.

ShippingStreet

Type
textarea
Properties
Create, Filter, Nillable, Update
Description
The street address of the shipping address. Maximum of 255 characters.

SpecialTerms

Type
textarea
Properties
Create, Nillable, Update
Description
Any terms specifically agreed to and tracked in the service contract.

StartDate

Type
date
Properties
Create, Filter, Nillable, Update
Description
The first day the service contract is in effect.

Status

Type
picklist
Properties
Filter, Nillable
Description
The status of the service contract, such as Inactive.

1744

Standard Objects

ServiceContract

Field

Details

Subtotal

Type
currency
Properties
Filter, Nillable
Description
Total of the service contract line items (products) before discounts, taxes, and shipping
are applied.

Tax

Type
currency
Properties
Create, Filter, Nillable, Update
Description
Total taxes for the service contract.

Term

Type
int
Properties
Create, Filter, Nillable, Update
Description
Number of months that the service contract is valid.

TotalPrice

Type
currency
Properties
Filter, Nillable
Description
Total of the contract line items (products) after discounts and before taxes and shipping.

Usage
Use this object to query and manage service contracts.
SEE ALSO:
ServiceContractHistory
ServiceContractShare
ServiceContractOwnerSharingRule

1745

Standard Objects

ServiceContractFeed

ServiceContractFeed
Represents a single feed item in the feed displayed on the detail page for a service contract record. This object is available in API version
23.0 and later.
A service contract feed shows recent changes to a service contract for any fields that are tracked in feeds, and comments and posts
about the record. It's a useful way to stay up-to-date with changes to service contracts.

Supported Calls
delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions:
• “Modify All Data”
• “Modify All” on the ServiceContract object
• “Moderate Chatter”
Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The content for the ServiceContractFeed. Required when Type is TextPost.
Optional when Type is ContentPost or LinkPost. This field is the
message that appears in the feed.

CommentCount

1746

Standard Objects

Field Name

ServiceContractFeed

Details
one. In a moderated feed, your comment isn’t counted until it's approved by
an admin or a person with “CanApproveFeedPostAndComment” or
“ModifyAllData” permission.
This has implications for how you retrieve feed comments. In a moderated
feed, rather than retrieving comments by looping through CommentCount,
go through pagination until end of comments is returned.

ConnectionId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
When a PartnerNetworkConnection modifies a record that is tracked, the
CreatedBy field contains the ID of the system administrator. The
ConnectionId contains the ID of the PartnerNetworkConnection. Available
if Salesforce to Salesforce is enabled for your organization.

ContentData

ContentDescription

Type
textarea
Properties
Nillable, Sort
Description
Available in API version 36.0 and earlier only.
The description of the file specified in ContentData.

ContentFileName

Type
string
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. The file uploaded to the feed.
Required if Type is ContentPost. Setting ContentFileName
automatically sets Type to ContentPost.

1747

Standard Objects

ServiceContractFeed

Field Name

Details

ContentSize

Type
int
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded
to the feed. This field is read-only and is automatically determined during insert.

ContentType

Type
string
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. The MIME type of the file uploaded
to the feed. This field is read-only and is automatically determined during insert.

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if a client
application migrates multiple posts and comments from another application
into a feed, InsertedById is set to the ID of the logged-in user.

IsRichText

1748

Standard Objects

Field Name

ServiceContractFeed

Details
•
•
•
•
•
•
The tag is accessible only via the API and must reference files in
Salesforce similar to this example:

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of FeedLikes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a LinkPost.

1749

Standard Objects

ServiceContractFeed

Field Name

Details

NetworkScope

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies whether this feed item is available in the default community, a specific
community, or all communities. This field is available in API version 26.0 and later,
if Salesforce Communities is enabled for your organization.
NetworkScope can have the following values:

• NetworkId—The ID of the community in which the FeedItem is available.
If left empty, the feed item is only available in the default community.
• AllNetworks—The feed item is available in all communities.
Note the following exceptions for NetworkScope:
• Only feed items with a Group or User parent can set a NetworkId or a
null value for NetworkScope.
• For feed items with a record parent, users can set NetworkScope only
to AllNetworks.
• You can’t filter a FeedItem on the NetworkScope field.
ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service contract record that is tracked in the feed. The feed is displayed
on the detail page for this record.

RelatedRecordId

Title

Type
string
Properties
Group, Nillable, Sort

1750

Standard Objects

Field Name

ServiceContractFeed

Details
Description
Title of the ServiceContractFeed. When the Type is LinkPost, the LinkUrl
is the URL and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of ServiceContractFeed:
• ActivityEvent—indirectly generated event when a user or the API
adds a Task associated with a feed-enabled parent record (excluding email
tasks on cases). Also occurs when a user or the API adds or updates a Task or
Event associated with a case record (excluding email and call logging).
For a recurring Task with CaseFeed disabled, one event is generated for the
series only. For a recurring Task with CaseFeed enabled, events are generated
for the series and each occurrence.
• AdvancedTextPost—created when a user posts a group
announcement.
• AnnouncementPost—Not used.
• ApprovalPost—generated when a user submits an approval.
• BasicTemplateFeedItem—Not used.
• CanvasPost—a post made by a canvas app posted on a feed.
• CollaborationGroupCreated—generated when a user creates a
public group.
• CollaborationGroupUnarchived—Not used.
• ContentPost—a post with an attached file.
• CreatedRecordEvent—generated when a user creates a record from
the publisher.
• DashboardComponentAlert—generated when a dashboard metric
or gauge exceeds a user-defined threshold.
• DashboardComponentSnapshot—created when a user posts a
dashboard snapshot on a feed.
• LinkPost—a post with an attached URL.
• PollPost—a poll posted on a feed.
• ProfileSkillPost—generated when a skill is added to a user’s Chatter
profile.
• QuestionPost—generated when a user posts a question.
• ReplyPost—generated when Chatter Answers posts a reply.

1751

Standard Objects

Field Name

ServiceContractFeed

Details
• RypplePost—generated when a user creates a Thanks badge in
Work.com.
• TextPost—a direct text entry on a feed.
• TrackedChange—a change or group of changes to a tracked field.
• UserStatus—automatically generated when a user adds a post.
Deprecated.
The following values appear in the Type picklist for all feed objects but apply
only to CaseFeed:
• AttachArticleEvent—generated event when a user attaches an
article to a case.
• CallLogPost—generated event when a user logs a call for a case through
the user interface. CTI calls also generate this event.
• CaseCommentPost—generated event when a user adds a case comment
for a case object.
• ChangeStatusPost—generated event when a user changes the status
of a case.
• ChatTranscriptPost—generated event when Live Agent transcript
is saved to a case.
• EmailMessageEvent—generated event when an email related to a
case object is sent or received.
• FacebookPost—generated when a Facebook post is created from a
case. Deprecated.
• MilestoneEvent—generated when a case milestone is completed or
reaches violation status.
• SocialPost—generated when a social post is created from a case.

Visibility

1752

Standard Objects

Field Name

ServiceContractHistory

Details
• External users can set Visibility only to AllUsers.
• Visibility can be updated on record posts.
• The Update property is supported only for feed items posted on records.

Usage
Use this object to track changes for a service contract record.
SEE ALSO:
ServiceContract
ServiceContractHistory
ServiceContractOwnerSharingRule
FeedItem

ServiceContractHistory
Represents the history of changes to the values in the fields on a ServiceContract (customer support agreement). This object is available
in API version 18.0 and later.

Supported Calls
create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field

Details

Field

Type
picklist
Properties
Filter, Restricted picklist
Description
The name of the field that was changed.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter

1753

Standard Objects

Field

ServiceContractOwnerSharingRule

Details
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not
(false). Label is Deleted.

NewValue

Type
anyType
Properties
Nillable
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable
Description
The latest value of the field before it was changed.

ServiceContractId

Type
reference
Properties
Filter
Description
Required. ID of the ServiceContract.

Usage
Use this object to identify changes to a service contract.
This object respects field level security on the parent object.
SEE ALSO:
ServiceContract
ServiceContractShare
ServiceContractOwnerSharingRule

ServiceContractOwnerSharingRule
Represents the rules for sharing a ServiceContract (customer service agreement) with users other than the owner. This object is available
in API version 18.0 and later.

1754

Standard Objects

ServiceContractOwnerSharingRule

Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer
support to enable access to this object for your org.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Fields
Field Name

Details

AccessLevel

Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
A value that represents the type of sharing allowed. The possible values are:
• Read
• Edit

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A description of the sharing rule. Maximum size is 1000 characters. This field is available
in API version 29.0 and later.

DeveloperName

Type
string
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must begin with a
letter, not include spaces, not end with an underscore, and not contain two
consecutive underscores. In managed packages, this field prevents naming conflicts
on package installations. With this field, a developer can change the object’s name
in a managed package and the changes are reflected in a subscriber’s organization.
Corresponds to Rule Name in the user interface.
This field is available in API version 24.0 and later.

1755

Standard Objects

Field Name

ServiceContractShare

Details
Note: When creating large sets of data, always specify a unique
DeveloperName for each record. If no DeveloperName is specified,
performance may slow while Salesforce generates one for each record.

GroupId

Type
reference
Properties
Create, Filter, Group, Sort,
Description
The ID representing the source group. Service contracts owned by users in the source
group trigger the rule to give access.

Name

UserorGroupId

Type
reference
Properties
Create, Filter
Description
The ID representing the target user or group. Target users or groups are given access.

Usage
Use this object to manage the sharing rules for a service contract. General sharing and territory management-related sharing use this
object.
SEE ALSO:
ServiceContract
ServiceContractShare
ServiceContractHistory
Metadata API Developer Guide: SharingRules

ServiceContractShare
Represents a sharing entry on a ServiceContract (customer support agreement). This object is available in API version 18.0 and later.

1756

Standard Objects

ServiceContractShare

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the
default settings of such fields.
Field

Details

AccessLevel

Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
Level of access that the User or Group has to the ServiceContract. The possible values
are:
• Read
• Edit
• All (This value is not valid for create or update calls.)
This field must be set to an access level that is higher than the organization’s default
access level for service contracts.

ParentId

Type
reference
Properties
Create, Filter
Description
ID of the parent object, if any.

RowCause

Type
picklist
Properties
Create, Filter, Defaulted on create, Restricted picklist
Description
Reason that this sharing entry exists.
You can create a value for this field in API versions 32.0 and later with the correct
organization-wide sharing settings.
Values may include:
• Manual—The User or Group has access because a user with “All” access manually
shared the ServiceContract with them.
• Owner—The User is the owner of the ServiceContract or is in a role above the
service contract owner in the role hierarchy.

1757

Standard Objects

ServicePresenceStatus

Field

Details

UserOrGroupId

Type
reference
Properties
Create, Filter
Description
ID of the User or Group that has been given access to the ServiceContract.

Usage
This object allows you to determine which users and groups can view and edit ServiceContract records owned by other users.
If you attempt to create a new record that matches an existing record, the create call updates any modified fields and returns the existing
record.
SEE ALSO:
ServiceContract
ServiceContractHistory
ServiceContractOwnerSharingRule

ServicePresenceStatus
Represents a presence status that can be assigned to a service channel. This object is available in API version 32.0 and later.

Supported Calls
create(), delete(), query(), retrieve(), update(), upsert()

Fields
Field

Details

DeveloperName

1758

Standard Objects

Field

ServiceResource

Language

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the presence status.

MasterLabel

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The label of the presence status.

ServiceResource
Represents a service technician or dispatcher in field service. This object is available in API version 38.0 and later.

Supported Calls
create(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(),update(),upsert()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Description

Type
textarea
Properties
Create, Nillable, Update
Description
The description of the resource.

1759

Standard Objects

ServiceResource

Field Name

Details

IsActive

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
When selected, this option means that the resource can be assigned to work
orders. For service tracking purposes, resources can’t be deleted, so deactivating
a resource is the best way to send them into retirement.

IsCapacityBased

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Capacity-based resources are limited to a certain number of hours or
appointments in a specified time period.
Tip: The Capacities related list shows a resource’s capacity.

IsOptimizationCapable

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
When selected, this option means that the service scheduling optimizer can
assign this resource to work orders during the optimization process. Use only if
the Field Service Lightning managed packages are installed. Its label in the user
interface is Include in Scheduling Optimization. Only users with
the “Field Service Scheduling” permission set license can be included in scheduling
optimization.

LastKnownLatitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The latitude of the last known location.

LastKnownLongitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update

1760

Standard Objects

Field Name

ServiceResource

Details
Description
The longitude of the last known location.

LastKnownLocation

Type
location
Properties
Nillable
Description
The service resource’s last known location. You can configure this field to display
data collected from a custom mobile app. This field is not visible in the user
interface, but you can expose it on service resource page layouts or set up field
tracking to be able to view a resource’s location history.

LastKnownLocationDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time of the last known location.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the service resource was last modified. Its label in the user interface
is Last Modified Date.

LastViewedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the service resource was last viewed.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The resource’s name. You’ll likely want this to be the name or title of the associated
user.

1761

Standard Objects

ServiceResourceCapacity

Field Name

Details

OwnerId

Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the service resource.

RelatedRecordId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The associated user.

ResourceType

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates whether a resource is a technician or a dispatcher. Resources who are
dispatchers can’t be capacity-based or included in scheduling optimization. Only
users with the “Field Service Dispatcher” permission set license can be dispatchers.
Note: You can’t add additional resource types.

Usage
View service resources on the Service Resources tab. In addition:
• Service resources that are assigned to a service appointment appear in the Assigned Resources related list on the appointment detail
page. You can assign multiple service resources to an appointment.
• Service resources that belong to a service territory appear in the Service Territory Members related list on the territory detail page.
For tracking purposes, service resources can only be deactivated, not deleted. To deactivate a service resource, deselect Active on their
detail page.
Deactivating a user deactivates the related service resource. You can’t create a service resource that is linked to an inactive user.

ServiceResourceCapacity
Represents the maximum number of scheduled hours or number of service appointments that a capacity-based service resource can
complete within a specific time period. This object is available in API version 38.0 and later.

1762

Standard Objects

ServiceResourceCapacity

Supported Calls
create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),
update(), upsert()

Fields
Field Name

Details

CapacityInHours

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The number of hours that the resource can work per time period.

CapacityInWorkItems

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description

CapacityNumber

Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
(Read only) An auto-generated number identifying the capacity record.

EndDate

Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date the capacity ends; for example, the end date of a contract.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this
record.

1763

Standard Objects

ServiceResourceCapacity

Field Name

Details

LastViewedDate

ServiceResourceId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The associated service resource.

StartDate

Type
date
Properties
Create, Filter, Group, Sort
Description
The date the capacity goes into effect.

TimePeriod

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Days, Hours, or Months. For example, if a resource can work 80 hours per month,
the capacity’s Time Period would be Month and Hours per Time
Period would be 80.

Usage
Service resources who are capacity-based can only work a certain number of hours or complete a certain number of service appointments
within a specified time period. Contractors tend to be capacity-based. To indicate that a service resource is capacity-based, select
Capacity-Based on the service resource detail page, then define their capacity in the Capacities related list:
1. Click New Resource Capacity.
2. Enter a start date and an end date to indicate when the capacity is in effect for the resource. For example, if the capacity represents
a six-month contract, enter the contract’s start and end dates.
3. Specify how much the resource can work:

1764

Standard Objects

ServiceResourceCapacityFeed

• Select the Time Period that the capacity is based on: hours, days, or months. For example, if the resource can work 80 hours
per month, select Month.
• If you want the resource’s capacity to be based on the number of hours worked, fill out Hours per Time Period. For
example, if the resource can work 80 hours per month, enter 80.
• If you want the resource’s capacity to be based on the number of service appointments they are assigned to, fill out Work
Items per Time Period. For example, if the resource can complete 20 appointments per month, enter 20.
Note: If you’re using the Field Service Lightning managed packages and would like to measure capacity both in hours and
in number of work items, enter a value for both. The resource is considered to reach their capacity based on whichever term
is met first—hours or number of work items.
4. Click Save. You can set multiple capacities for a resource as long as their start and end dates do not overlap.
Important: If you aren’t using the Field Service Lightning managed packages, capacity serves more as a suggestion than a
rule. Resources can still be as scheduled beyond their capacity, and you aren’t notified when a resource exceeds their capacity.

ServiceResourceCapacityFeed
Represents a single feed item on a service resource capacity record detail page. This object is available in API version 38.0 and later.
A service resource capacity feed shows changes to tracked fields on a service resource capacity record. It also shows posts and comments
about the record. It’s a useful way to stay up to date with changes made to service resource capacities in Salesforce.

Supported Calls
delete(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The message that appears in the feed. Required when Type is TextPost.
Optional when Type is ContentPost orLinkPost.

1765

Standard Objects

ServiceResourceCapacityFeed

Field Name

Details

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of comments associated with this feed item.

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if an application
migrates posts and comments from another application into a feed, the value is
set to the ID of the logged-in user.

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
true indicates that the body of the feed contains rich text. false indicates
that the post is rendered as plain text.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of feed likes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a link post.

ParentId

Type
reference
Properties
Filter, Group, Sort

1766

Standard Objects

Field Name

ServiceResourceCapacityHistory

Details
Description
ID of the service resource capacity record tracked in the feed. The feed is displayed
on the detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a content post. This field
is null for all posts, except ContentPost.

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the Link URL is the
URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of feed item.

ServiceResourceCapacityHistory
Represents the history of changes made to tracked fields on a service resource capacity record. This object is available in API version 38.0
and later.

Supported Calls
getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
Field Service Lightning must be enabled in your organization, and field tracking for service resource capacity fields must be configured.

1767

Standard Objects

ServiceResourceFeed

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The value of the field before it was changed.

ServiceResourceCapacityId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service resource capacity being tracked. The history is displayed on the
detail page for this record.

ServiceResourceFeed
Represents a single feed item on a service resource record detail page. This object is available in API version 38.0 and later.
A service resource feed shows changes to tracked fields on a service resource record. It also shows posts and comments about the record.
It’s a useful way to stay up to date with changes made to service resources in Salesforce.

Supported Calls
delete(), getDeleted(), getUpdated(), query(), retrieve()

1768

Standard Objects

ServiceResourceFeed

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The message that appears in the feed. Required when Type is TextPost.
Optional when Type is ContentPost orLinkPost.

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of comments associated with this feed item.

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if an application
migrates posts and comments from another application into a feed, the value is
set to the ID of the logged-in user.

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
true indicates that the body of the feed contains rich text. false indicates
that the post is rendered as plain text.

1769

Standard Objects

ServiceResourceFeed

Field Name

Details

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of feed likes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a link post.

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service resource record tracked in the feed. The feed is displayed on the
detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a content post. This field
is null for all posts, except ContentPost.

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the Link URL is the
URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort

1770

Standard Objects

Field Name

ServiceResourceHistory

Details
Description
The type of feed item.

ServiceResourceHistory
Represents the history of changes made to tracked fields on a service resource. This object is available in API version 38.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The value of the field before it was changed.

1771

Standard Objects

ServiceResourceOwnerSharingRule

Field Name

Details

ServiceResourceId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service resource being tracked. The history is displayed on the detail
page for this record.

ServiceResourceOwnerSharingRule
Represents the rules for sharing a service resource with user records other than the owner or anyone above the owner in the role hierarchy.
This object is available in API version 38.0 and later.
Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer
support to enable access to this object for your org.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),
upsert()

Fields
Field

Details

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A description of the sharing rule. Maximum size is 1000 characters.

DeveloperName

1772

Standard Objects

Field

ServiceResourceOwnerSharingRule

Details
this field, a developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization. Corresponds to Rule Name in the user interface.
Note: When creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may slow while
Salesforce generates one for each record.

GroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the source group. A service resource owned by a User in the source
Group triggers the rule to give access.

Name

ServiceResourceAccessLevel Type

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the User or Group being granted access.

1773

Standard Objects

ServiceResourceShare

ServiceResourceShare
Represents a sharing entry on a service resource. This object is available in API version 38.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

AccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Level of access that the user or group has to the service resource. The possible
values are:
• Read
• Edit
• All (This value isn’t valid for create or update calls.)
Set to an access level that is at least equal to the organization’s default service
resource access level.

ParentId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The service resource associated with the sharing entry.

RowCause

1774

Standard Objects

Field Name

ServiceResourceSkill

Details
• Manual—The user or group has access because a user with “All” access
manually shared the service resource.
• Owner—The user is the owner of the service resource.
• Team—The user or group has team access.
• Rule—The user or group has access via a service resource sharing rule.

UserOrGroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
(Read only) ID of the user or group that has access to the service resource.

ServiceResourceSkill
Represents a skill that a service resource possesses. This object is available in API version 38.0 and later.

Supported Calls
create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(),update(),upsert()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

EffectiveEndDate

Type
date
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the skill expires. For example, if a service resource needs to be
re-certified after six months, the end date would be the date their certification
expires.

EffectiveStartDate

Type
date

1775

Standard Objects

Field Name

ServiceResourceSkill

Details
Properties
Create, Filter, Sort, Update
Description
The date when the service resource gains the skill. For example, if the skill
represents a certification, the start date would be the date of certification.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the resource skill was last modified. Its label in the user interface
is Last Modified Date.

LastViewedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the resource skill was last viewed.

ServiceResourceId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The service resource who possesses the skill.

SkillId

Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The skill the service resource possesses.

SkillLevel

Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
The service resource’s skill level. Skill level can range from zero to 99.99.

1776

Standard Objects

ServiceResourceSkillFeed

Field Name

Details

SkillNumber

Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
An auto-generated number identifying the resource skill assignment.

Usage
You can assign skills to all service resources in your org to indicate their certifications and areas of expertise, and specify each resource’s
skill level from 0 to 99.99. For example, you can assign Maria the “Welding” skill, level 50.
If you intend to use the skills feature, determine which skills you want to track and how skill level should be determined. For example,
you may want the skill level to reflect years of experience, certification levels, or license classes.

ServiceResourceSkillFeed
Represents a single feed item on a service resource skill record detail page. This object is available in API version 38.0 and later.
A service resource skill feed shows changes to tracked fields on a service resource skill record. It also shows posts and comments about
the record. It’s a useful way to stay up to date with changes made to service resource skills in Salesforce.

Supported Calls
delete(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort

1777

Standard Objects

Field Name

ServiceResourceSkillFeed

Details
Description
The message that appears in the feed. Required when Type is TextPost.
Optional when Type is ContentPost orLinkPost.

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of comments associated with this feed item.

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if an application
migrates posts and comments from another application into a feed, the value is
set to the ID of the logged-in user.

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
true indicates that the body of the feed contains rich text. false indicates
that the post is rendered as plain text.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of feed likes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a link post.

1778

Standard Objects

ServiceResourceSkillHistory

Field Name

Details

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service resource skill record tracked in the feed. The feed is displayed
on the detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a content post. This field
is null for all posts, except ContentPost.

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the Link URL is the
URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of feed item.

ServiceResourceSkillHistory
Represents the history of changes made to tracked fields on a service resource skill. This object is available in API version 38.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

1779

Standard Objects

ServiceTerritory

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The value of the field before it was changed.

ServiceResourceSkillId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the resource skill being tracked. The history is displayed on the detail page
for this record.

ServiceTerritory
Represents a region in which field service work can be performed. This object is available in API version 38.0 and later.

1780

Standard Objects

ServiceTerritory

Supported Calls
create()delete()
,
describeLayout()
,
describeSObjects()
,
getDeleted()
,
getUpdated()
,
query()
,
retrieve()
,
search()
,
undelete()
,
update()
,
upsert()
,

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Address

Type
address
Properties
Filter
Description
An address to associate with the territory. You may want to list the address of
the territory’s headquarters.

City

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city of the associated address. Maximum length is 40 characters.

Country

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country to associate with the territory. Maximum length is 80 characters.

Description

Type
textarea
Properties
Create, Nillable, Update
Description
The description of the territory.

GeocodeAccuracy

Type
picklist

1781

Standard Objects

Field Name

ServiceTerritory

Details
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The level of accuracy of a location’s geographical coordinates compared with its
physical address. Usually provided by a geocoding service based on the address’s
latitude and longitude coordinates.
Note: This field is available in the API only.

IsActive

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the service territory is meant to be used. If a territory is inactive,
you can’t add members to it or link it to work orders, work order line items, or
service appointments.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the territory was last modified. Its label in the user interface is
Last Modified Date.

LastViewedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the territory was last viewed.

Latitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the address
associated with the territory. Acceptable values are numbers between –90 and
90 with up to 15 decimal places.
Note: This field is available in the API only.

1782

Standard Objects

ServiceTerritory

Field Name

Details

Longitude

Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of the address
associated with the territory. Acceptable values are numbers between –180 and
180 with up to 15 decimal places.
Note: This field is available in the API only.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the territory.

OperatingHoursId

Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The territory’s operating hours, which indicate when service appointments within
the territory can occur. Service resources who are members of a territory
automatically inherit the territory’s operating hours unless different hours are
specified on the resource record.

ParentTerritoryId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The territory’s parent service territory, if it has one. For example, a Northern
California territory can have a State of California territory as
its parent. A service territory hierarchy can contain up to 500 territories.

PostalCode

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update

1783

Standard Objects

Field Name

ServiceTerritory

Details
Description
The postal code of the address associated with the territory. Maximum length is
20 characters.

State

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state of the address associated with the territory. Maximum length is 80
characters.

Street

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street number and name of the address associated with the territory.

TopLevelTerritoryId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
(Read only) The top-level territory in a hierarchy of service territories. Depending
on where a territory lies in the hierarchy, its top-level territory might be the same
as its parent.

Usage
View service territories on the Service Territories tab. You can also view a service resource’s territories on the Service Territories related
list on the resource detail page.
If you want to use service territories, determine which territories you need to create. Depending on how your business works, you may
decide to create territories based on cities, counties, or other factors. If you plan to build out a hierarchy of service territories, create the
highest-level territories first.
Create service territories from the Service Territories tab in Salesforce. After you create a territory, you can add members to it via the
Service Territory Members related list. Service territory members are resources who work within the territory, and associating them with
a territory ensures that they’re assigned to appointments near their home base.
For example, you can create a hierarchy of territories to represent the areas where your team works in California. Include a top-level
territory named California, three child territories named Northern California, Central California, and
Southern California, and a series of third-level territories corresponding to California counties. Assign service resources to each
county territory to indicate who is available to work in that county.

1784

Standard Objects

ServiceTerritoryFeed

ServiceTerritoryFeed
Represents a single feed item on a service territory record detail page. This object is available in API version 38.0 and later.
A service territory feed shows changes to tracked fields on a service territory record. It also shows posts and comments about the record.
It’s a useful way to stay up to date with changes made to service territories in Salesforce.

Supported Calls
delete(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The message that appears in the feed. Required when Type is TextPost.
Optional when Type is ContentPost orLinkPost.

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of comments associated with this feed item.

InsertedById

Type
reference
Properties
Group, Nillable, Sort

1785

Standard Objects

Field Name

ServiceTerritoryFeed

Details
Description
ID of the user who added this object to the feed. For example, if an application
migrates posts and comments from another application into a feed, the value is
set to the ID of the logged-in user.

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
true indicates that the body of the feed contains rich text. false indicates
that the post is rendered as plain text.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of feed likes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a link post.

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service territory record tracked in the feed. The feed is displayed on the
detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a content post. This field
is null for all posts, except ContentPost.

1786

Standard Objects

ServiceTerritoryHistory

Field Name

Details

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the Link URL is the
URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of feed item.

ServiceTerritoryHistory
Represents the history of changes made to tracked fields on a service territory. This object is available in API version 38.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

NewValue

Type
anyType

1787

Standard Objects

Field Name

ServiceTerritoryMember

Details
Properties
Nillable, Sort
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The value of the field before it was changed.

ServiceTerritoryId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service territory being tracked. The history is displayed on the detail
page for this record.

ServiceTerritoryMember
Represents a service resource who is able to be assigned to service appointments in the service territory. This object is available in API
version 38.0 and later.

Supported Calls
create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(),update(),upsert()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Address

Type
address
Properties
Filter

1788

Standard Objects

Field Name

ServiceTerritoryMember

Details
Description
The member’s address. You may want to list the related service resource’s address
in this field.

City

Type
string
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The city of the member’s address. Maximum length is 40 characters.

Country

Type
string
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The country of the member’s address. Maximum length is 80 characters.

EffectiveEndDate

Type
date
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the service resource is no longer a member of the territory. If the
resource will be working in the territory for the foreseeable future, leave this field
blank. This field is mainly useful for indicating when a temporary relocation ends.

EffectiveStartDate

Type
date
Properties
Create, Filter, Sort, Update
Description
The date when the service resource becomes a member of the service territory.

GeocodeAccuracy

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The level of accuracy of a location’s geographical coordinates compared with its
physical address. Usually provided by a geocoding service based on the address’s
latitude and longitude coordinates.

1789

Standard Objects

Field Name

ServiceTerritoryMember

Details
Note: This field is available in the API only.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the territory member was last modified. Its label in the user
interface is Last Modified Date.

LastViewedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the territory member was last viewed.

Latitude

Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the member’s
address. Acceptable values are numbers between –90 and 90 with up to 15
decimal places.
Note: This field is available in the API only.

Longitude

Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of the member’s
address. Acceptable values are numbers between –180 and 180 with up to 15
decimal places.
Note: This field is available in the API only.

MemberNumber

Type
string

1790

Standard Objects

Field Name

ServiceTerritoryMember

Details
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
(Read only) An auto-generated number identifying the service territory member.

OperatingHoursId

Type
reference
Properties
Create, Filter, Group, Sort, Nillable, Update
Description
The operating hours assigned to the service territory member. If no operating
hours are specified, the member is assumed to use their parent service territory’s
operating hours. If a member needs special operating hours, create them in Setup
and select them in the Operating Hours lookup field on the member’s
detail page.

PostalCode

Type
string
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The postal code of the member’s address. Maximum length is 20 characters.

ServiceResourceId

Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The service resource assigned to the service territory.

ServiceTerritoryId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The service territory that the service resource is assigned to.

State

Type
string
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

1791

Standard Objects

Field Name

ServiceTerritoryMember

Details
Description
The state of the member’s address. Maximum length is 80 characters.

Street

Type
textarea
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The street number and name of the member’s address.

TerritoryType

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Primary, Secondary, or Relocation.
• The primary territory is typically the territory where the resource works most
often—for example, near their home base. Service resources can only have
one primary territory.
• Secondary territories are territories where the resource can be assigned to
appointments if needed. Service resources can have multiple secondary
territories.
• Relocation territories represent temporary moves for service resources. If
you’re using the Field Service Lightning managed packages with the
scheduling optimizer, resources with relocation territories are always assigned
to services within their relocation territories during the specified relocation
dates; if they don’t have a relocation territory, the primary territories are
favored over the secondary.
For example, a service resource might have the following territories:
• Primary territory: West Chicago
• Secondary territories:
– East Chicago
– South Chicago
• Relocation territory: Manhattan, for a three-month period

Usage
If you delete a service territory with members, the service resources who were members no longer have any connection to the territory.

1792

Standard Objects

ServiceTerritoryMemberFeed

ServiceTerritoryMemberFeed
Represents a single feed item on a service territory member record detail page. This object is available in API version 38.0 and later.
A service territory member feed shows changes to tracked fields on a service territory member record. It also shows posts and comments
about the record. It’s a useful way to stay up to date with changes made to service territory members in Salesforce.

Supported Calls
delete(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The message that appears in the feed. Required when Type is TextPost.
Optional when Type is ContentPost orLinkPost.

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of comments associated with this feed item.

InsertedById

Type
reference
Properties
Group, Nillable, Sort

1793

Standard Objects

Field Name

ServiceTerritoryMemberFeed

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
true indicates that the body of the feed contains rich text. false indicates
that the post is rendered as plain text.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of feed likes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a link post.

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service territory member record tracked in the feed. The feed is displayed
on the detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a content post. This field
is null for all posts, except ContentPost.

1794

Standard Objects

ServiceTerritoryMemberHistory

Field Name

Details

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the Link URL is the
URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of feed item.

ServiceTerritoryMemberHistory
Represents the history of changes made to tracked fields on a service territory member. This object is available in API version 38.0 and
later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

1795

Standard Objects

SessionPermSetActivation

Field Name

Details

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The value of the field before it was changed.

ServiceTerritoryMemberId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the service territory member being tracked. The history is displayed on the
detail page for this record.

SessionPermSetActivation
The SessionPermSetActivation object represents a permission set assignment activated during an individual user session. When a
SessionPermSetActivation object is inserted into a permission set, an activation event fires, allowing the permission settings to apply to
the user’s specific session. This object is available in API versions 37.0 and later as part of the Session-Based Permission Sets Developer
Preview.
Note: Session-Based Permission Sets is currently available as a Developer Preview.
Important: Managed packages with permission sets that require session activation cannot be installed on customer orgs without
this feature.

Supported Calls
describeCompactLayouts(), describeLayout(), query(), retrieve()

1796

Standard Objects

SessionPermSetActivation

Fields
Field Name

Details

AuthSessionId

Type
reference
Properties
Filter, Group, Sort
Description
The session ID related to this permission set assignment for its duration.

Description

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The session details, such as device used and browser.

PermissionSetId

Type
reference
Properties
Filter, Group, Sort
Description
The permission set ID related to this permission set assignment and user for its
duration.

UserId

Type
reference
Properties
Filter, Group, Sort
Description
The user ID of the user to whom this permission set assignment applies for its
duration.

Usage
Use SessionPermSetActivation to create a permission set available only for a specified session’s duration. For example, create permission
sets that provide access to specific applications only during authenticated sessions.
In the following Apex example, an identified session is activated after session information is submitted via a button. Successful activation
results in a confirmation message displayed to the user.
public class SessionPermSetActivationController {
// id of the session permission set to be activated

1797

Standard Objects

SetupAuditTrail

private final String sessionPermSetId = '0PSxx00000004rJ';
private final String sessionId;
public SessionPermSetActivationController() {
Map sessionManagement = Auth.SessionManagement.getCurrentSession();
sessionId = sessionManagement.get('SessionId');
}
public PageReference activate() {
// activate the permission set
SessionPermSetActivation activation = new SessionPermSetActivation();
activation.AuthSessionId = sessionId;
activation.PermissionSetId = sessionPermSetId;
activation.Description = 'created by SessionPermSetActivationController';
insert activation;
return null;
}
public boolean getActivated() {
Integer alreadyActivated = [SELECT count()
FROM SessionPermSetActivation
WHERE AuthSessionId = :sessionId
And PermissionSetId = :sessionPermSetId
1];
return alreadyActivated > 0;
}
}

LIMIT

Activate Session Permission Set

Session Permission Set is already active.

SetupAuditTrail
Represents changes you or other admins made in your org’s Setup area for at least the last 180 days. This object is available in API version
15.0 and later.
Note: SetupAuditTrail is not a supported standard controller. Using SetupAuditTrail as a standard controller in a Visualforce page
results in an error.

1798

Standard Objects

SetupAuditTrail

Supported Calls
query(), retrieve()

Note: Aggregate queries aren’t supported on this object. For example, SELECT count() FROM SetupAuditTrail
works but SELECT count(Id) FROM SetupAuditTrail fails.

Fields
Field

Details

Action

Type
string
Properties
Filter, Sort
Description
The category of the change made in Setup. For example, a value of PermSetCreate
indicates that an administrator created a permission set. The Display field contains more
specific information.

DelegateUser

Type
string
Properties
Filter, Nillable, Sort
Description
The Login-As user who executed the action in Setup. If a Login-As user didn’t perform the
action, this field is blank. This field is available in API version 35.0 and later.

Display

Type
string
Properties
Nillable, Sort
Description
The full description of changes made in Setup. For example, if the Action field has a value
of PermSetCreate, the Display field has a value like “Created permission set MAD:
with user license Salesforce.”

Section

Type
string
Properties
Nillable, Sort
Description
The section in the Setup menu where the action occurred. For example, Manage Users or
Company Profile.

1799

Standard Objects

SetupEntityAccess

Note: You can use SOQL joins to get the information you need more quickly. For example, running SELECT CreatedBy.Name
FROM SetupAuditTrail LIMIT 10 returns the first and last names of the last 10 people to make changes in Setup.

SetupEntityAccess
Represents the enabled setup entity access settings (such as for Apex classes) for the parent PermissionSet. This object is available in
API version 25.0 and later.
To grant users access to an entity, associate the appropriate SetupEntityAccess record with a PermissionSet that’s assigned to a user.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve()

Fields
Field Name

Details

ParentId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the entity’s parent PermissionSet.

SetupEntityId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the entity for which access is enabled, such as an Apex class or
Visualforce page.

SetupEntityType

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of setup entity for which access is enabled. Valid values are:
• ApexClass for Apex classes
• ApexPage for Visualforce pages
• In API version 28.0 and later, ConnectedApplication for OAuth
connected apps
• In API version 31.0 and later, CustomPermission for custom permissions

1800

Standard Objects

Field Name

SetupEntityAccess

Details
• In API version 28.0 and later, ServiceProvider for service providers
• In API version 28.0 and later, TabSet for apps

Usage
Because SetupEntityAccess is a child of the PermissionSet object, the usage is similar to other PermissionSet child objects like
FieldPermissions and ObjectPermissions.
For example, the following code returns all permission sets that grant access to any setup entities for which access is enabled:
SELECT Id, ParentId, Parent.Name, SetupEntityId
FROM SetupEntityAccess

The following code returns permission sets that grant access only to Apex classes:
SELECT Id, ParentId, Parent.Name, SetupEntityId
FROM SetupEntityAccess
WHERE SetupEntityType='ApexClass'

The following code returns permission sets that grant access to any setup entities, and are not owned by a profile:
SELECT Id, ParentId, Parent.Name, SetupEntityId
FROM SetupEntityAccess
WHERE ParentId
IN (SELECT Id
FROM PermissionSet
WHERE isOwnedByProfile = false)

You may want to return only those permission sets that have access to a specific setup entity. To do this, query the parent object. For
example, this code returns all permission sets that grant access to the helloWorld Apex class:
SELECT Id, Name,
(SELECT Id, Parent.Name, Parent.Profile.Name
FROM SetupEntityAccessItems)
FROM ApexClass
WHERE Name = 'helloWorld'

While it’s possible to return permission sets that have access to a ConnectedApplication, ServiceProvider, or TabSet
by SetupEntityId, it’s not possible to return permission sets that have access to these SetupEntityType fields by any other
AppMenuItem attribute, such as Name or Description. For example, to find out if a user has access to the Recruiting app, you’d
run two queries. First, query to get the AppMenuItem ID:
SELECT Id, Name, Label
FROM AppMenuItem
WHERE Name = 'Recruiting'

Let’s say the previous query returned the AppMenuItem ID 02uD0000000GIiMIAW. Using this ID, you can now run a query to find out if
a user has access to the Recruiting app:
SELECT Id, SetupEntityId, SetupEntityType
FROM SetupEntityAccess
WHERE ParentId
IN

1801

Standard Objects

SignupRequest

(SELECT PermissionSetId
FROM PermissionSetAssignment
WHERE AssigneeId = '005D0000001QOzF')
AND (SetupEntityId = '02uD0000000GIiMIAW')

SEE ALSO:
PermissionSet
FieldPermissions
ObjectPermissions
ApexClass
ApexPage

SignupRequest
Represents a request for a new Trialforce sign-up. This object is available in API version 27.0 and later.
Note: You are limited to 20 sign-ups per day. If you need to make additional sign-ups, log a case in the Partner Community.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), undelete()

Fields
Field Name

Details

AuthCode

Type
string
Properties
Create, Filter, Group, Sort
Description
A one-time authorization code that can be exchanged for an OAuth access token and refresh
token using standard Salesforce APIs. It’s used in conjunction with
ConnectedAppCallbackUrl and ConnectedAppConsumerKey, when the
specified connected app hasn't been configured with an X.509 certificate. This is a read-only
field provided by the system once the sign-up request has been processed. This field is available
in API version 29.0 and later.

Company

Type
string
Properties
Create, Filter, Group, Sort

1802

Standard Objects

Field Name

SignupRequest

Details
Description
The name of the company requesting the trial sign-up.

ConnectedAppCallbackUrl Type

string
Properties
Create, Filter, Group, Sort
Description
When used in conjunction with ConnectedAppConsumerKey, specifies a connected
app that should be approved automatically during the sign-up creation. This field is available
in API version 28.0 and later.
ConnectedAppConsumerKey Type

string
Properties
Create, Filter, Group, Sort
Description
When used in conjunction with ConnectedAppCallbackUrl, specifies a connected
app that should be approved automatically during the sign-up creation. This field is available
in API version 28.0 and later.
Country

Type
string
Properties
Create, Filter, Group, Sort
Description
The two-character, upper-case ISO-3166 country code. You can find a full list of these codes
at a number of sites, such as:
www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html. The language
of the trial organization is auto-determined based on the value of this field.

CreatedOrgId

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The 15–character organization ID of the trial organization created. This is a read-only field
provided by the system once the sign-up request has been processed.

CreatedOrgInstance

Type
string

1803

Standard Objects

Field Name

SignupRequest

Details
Properties
Filter, Group, Nillable, Sort
Description
The server instance of the new trial organization, for example, “na8.” This field is available in
API version 29.0 and later.

Edition

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The Salesforce template that is used to create the trial organization. Possible values are
Partner Group, Professional, Partner Professional, Sales
Professional, Professional TSO, Enterprise, Partner Enterprise,
Service Enterprise, Enterprise TSO, Developer, and Partner
Developer. This field is available in API version 35.0 and later.

ErrorCode

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The error code if the sign-up request isn’t successful. This is a read-only field provided by the
system to be used for support purposes.

FirstName

Type
string
Properties
Create, Filter, Nillable, Sort
Description
The first name of the admin user for the trial sign-up.

LastName

Type
string
Properties
Create, Filter, Group, Sort
Description
The last name of the admin user for the trial sign-up.

PreferredLanguage

Type
picklist

1804

Standard Objects

Field Name

SignupRequest

Details
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The language of the trial organization being created. Specify the language using a language
code listed under Fully Supported Languages in “Supported Languages ” in the Salesforce
Help. For example, use zh_CN for simplified Chinese. The value you select overrides the
language set by locale. If you specify an invalid language, the organization defaults to English.
Likewise, if you specify a language that isn’t supported by the Salesforce edition associated
with your trial template, the trial organization defaults to English. This field is available in API
version 35.0 and later.

ResolvedTemplateId

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Populated during the sign-up request and for internal use by Salesforce. This field is available
in API version 35.0 and later.

ShouldConnectToEnvHub

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
When set to true, the trial organization is connected to the Environment Hub. The sign-up
must take place in the hub master organization or a spoke organization. This field is available
in API version 35.0 and later.

SignupEmail

Type
email
Properties
Create, Filter, Group, Sort
Description
The email address of the admin user for the trial sign-up.

SignupSource

Type
string
Properties
Create, Filter, Group, Nillable, Sort
Description
A user-specified description of the trial sign-up, up to 60 characters in length. This field is
available in API version 36.0 and later.

1805

Standard Objects

SignupRequest

Field Name

Details

Status

Type
picklist
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
The status of the request. Possible values are New, In Progress, Error, or Success.
The default value is New.

Subdomain

Type
string
Properties
Create, Filter, Group, Sort
Description
The subdomain for the new trial organization when it uses a custom My Domain. The maximum
length is 33 characters for Developer Edition (DE) and 40 characters for all other editions
(because a suffix is appended to all DE organizations).

SuppressSignupEmails

Type
boolean
Properties
Filter, Group, Nillable, Sort
Description
When set to true, no sign-up emails are sent when the trial organization is created. This field
is used for the Proxy Signup feature, and is available in API version 29.0 and later.

TemplateId

Type
string
Properties
Create, Filter, Group, Nillable, Sort
Description
The 15–character ID of the Trialforce template that is the basis for the trial sign-up. The template
must be approved by Salesforce. If you don’t specify an edition, a template ID is required.

TrialDays

Type
anyType
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
The duration of the trial sign-up in days. Must be equal to or less than the trial days for the
approved Trialforce template. If not provided, it defaults to the trial duration specified for the
Trialforce template.

1806

Standard Objects

SignupRequest

Field Name

Details

TrialSourceOrgId

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The 15–character organization ID of the Trialforce Source Organization from which the Trialforce
template was created.

Username

Type
string
Properties
Create, Filter, Group, Sort
Description
The username of the admin user for the trial sign-up. It must follow the address convention
specified in RFC822: www.w3.org/Protocols/rfc822/#z10

Usage
The Java class below uses the REST API to create a SignupRequest object. It authenticates to the Trialforce Management Organization
and then posts a request to the SignupRequest object.
Here are the variables you need to specify in this example.
• SERVER — The name of the host server for the Trialforce Management Organization (TMO), for example,
“yourInstance.salesforce.com.”
• USERNAME — The admin username for the TMO.
• PASSWORD — The concatenation of the admin password and the security token for the TMO. To get an email with the security
token, from your personal settings in Salesforce select Reset My Security Token and click Reset Security Token.
• CLIENT_ID — From Setup in Salesforce, enter Apps in the Quick Find box, select Apps, and click New under Connected
Apps. Enter values for the required fields (the Callback URL is required but can initially be set to any valid URL as it's not used), grant
full access for the OAuth scopes in the "Selected OAuth Scopes" selector, and click Save. Then copy the value of “Consumer Key”
and use it for this variable.
• CLIENT_SECRET — On the same page, click Click to reveal. Then copy the value of "Consumer Secret" and use it for this variable.
public class IsvSignupDriver {
private static final String
private static final String
private static final String
private static final String
private static final String

SERVER = server_name:port;
USERNAME = tmo_username;
PASSWORD = tmo_passwordsecurity_token;
CLIENT_ID = consumer_key;
CLIENT_SECRET = consumer_secret;

private static SignupRequestInfo signupRequest = null;
public static String createSignupRequest (SignupRequestInfo sr)
throws JSONException, IOException {
JSONObject createResponse = null;

1807

Standard Objects

SignupRequest

signupRequest = sr;
JSONObject loginResponse = login(SERVER, USERNAME, PASSWORD);
String instanceUrl = loginResponse.getString("instance_url");
String accessToken = loginResponse.getString("access_token");
createResponse = create(instanceUrl, accessToken);
System.out.println("Created SignupRequest object: " + createResponse + "\n");
return createResponse.toString();
}
/* Authenticates to the TMO using the required credentials */
private static JSONObject login(String server, String username, String password)
throws ClientProtocolException, IOException, JSONException {
String authEndPoint = server + "/services/oauth2/token";
HttpClient httpclient = new DefaultHttpClient();
try {
HttpPost post = new HttpPost(authEndPoint);
List params = new ArrayList();
params.add(new BasicNameValuePair("grant_type", "password"));
params.add(new BasicNameValuePair("client_id", CLIENT_ID));
params.add(new BasicNameValuePair("client_secret", CLIENT_SECRET));
params.add(new BasicNameValuePair("username", username));
params.add(new BasicNameValuePair("password", password));
post.setEntity(new UrlEncodedFormEntity(params, Consts.UTF_8));
BasicResponseHandler handler = new BasicResponseHandler();
String response = httpclient.execute(post, handler);
return new JSONObject(response);
} finally {
httpclient.getConnectionManager().shutdown();
}
}
/* Posts a request to the SignupRequest object */
private static JSONObject create(String instanceUrl, String accessToken)
throws ClientProtocolException, IOException, JSONException {
HttpClient httpClient = new DefaultHttpClient();
try {
HttpPost post = new HttpPost(instanceUrl +
"/services/data/v27.0/sobjects/SignupRequest/");
post.setHeader("Authorization", "Bearer " + accessToken);
post.setHeader("Content-Type", "application/json");
JSONObject requestBody = new JSONObject();
requestBody.put("TemplateId", signupRequest.getTemplateID());
requestBody.put("SignupEmail", signupRequest.getEmail());
requestBody.put("username", signupRequest.getUsername());
requestBody.put("Country", "US");
requestBody.put("Company", signupRequest.getCompanyName());
requestBody.put("lastName", signupRequest.getLastName());
StringEntity entity = new StringEntity(requestBody.toString());
post.setEntity(entity);

1808

Standard Objects

Site

BasicResponseHandler handler = new BasicResponseHandler();
String response = httpClient.execute(post, handler);
return new JSONObject(response);
} finally {
httpClient.getConnectionManager().shutdown();
}
}
}

Error Codes
If the sign-up fails, the system generates an error code that can help you identify the cause. This table shows the most important error
codes.
Error Code

Description

C-1007

Duplicate username.

C-1015

Error while establishing the new organization's My Domain settings. Contact Salesforce support for assistance.

C-1016

Error while configuring the OAuth connected app for Proxy Signup. Verify that your connected app has a
valid consumer key, callback URL, and unexpired certificate (if applicable).

C-1018

Invalid subdomain value provided during sign-up.

C-1019

Subdomain in use. Please choose a new subdomain value.

C-9999

Generic “fatal error.” Contact Salesforce support for assistance.

S-1006

Invalild email address (not in a proper email address format).

S-2006

Invalid country code.

T-0001

Template ID not valid (not in the format 0TTxxxxxxxxxxxx).

T-0002

Template not found. Either the template doesn't exist (it may have been deleted), or it doesn't exist at the
appropriate version.

T-0003

Template not approved for use by Salesforce.

Site
Represents a public website that is integrated with an Organization. This object is generally available in API version 16.0 and later.
To access this object, Force.com Sites or Site.com must be enabled for your organization.

Supported Calls
describeSObjects(), query(), retrieve()

1809

Standard Objects

Site

Special Access Rules
• Customer Portal users can’t access this object.
• To view this object, you must have the “View Setup and Configuration” permission.

Fields
Field

Description

AdminId

Type
reference
Properties
Filter, Group, Sort
Description
The site administrator designated as the contact for the site. This user receives
site-related communications from site visitors and from Salesforce.

AnalyticsTrackingCode

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The tracking code associated with your site. This code can be used by services
like Google Analytics to track page request data for your site.

ClickjackProtectionLevel

Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Sets the clickjack protection level. The options are:
• AllowAllFraming—Allow framing by any page (no protection)
• SameOriginOnly—Allow framing by the same origin only
(recommended)
• NoFraming—Don’t allow framing by any page (most protection)
This field is available in API version 30.0 and later.

DailyBandwidthLimit

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The rolling 24-hour daily bandwidth limit for the sites in your organization.

1810

Standard Objects

Site

Field

Description

DailyBandwidthUsed

Type
double
Properties
Filter, Group, Nillable, Sort
Description
The current rolling 24-hour daily bandwidth usage for the sites in your
organization.

DailyRequestTimeLimit

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The rolling 24-hour daily service request time limit for the sites in your
organization. Service request time is calculated as the total server time in minutes
required to generate pages for the site.

DailyRequestTimeUsed

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The current rolling 24-hour daily service request time for the sites in your
organization.

Description

Type
textarea
Properties
Filter, Nillable, Sort
Description
An optional description of the site.

GuestUserId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The site or Salesforce Communities specific user that anonymous, unauthenticated
users run as when interacting with the site.

MasterLabel

Type
string

1811

Standard Objects

Field

Site

Description
Properties
Filter, Group, Sort
Description
The name of the site as it appears in the user interface.

MonthlyPageViewsEntitlement

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of page views allowed for the current calendar month for the sites
in your organization.

Name

Type
string
Properties
Filter, Group, Sort
Description
The name used when referencing the site in the API.

OptionsAllowHomePage

Type
boolean
Properties
Filter
Description
The option to enable the standard page associated with the Home tab
(/home/home.jsp).

OptionsAllowStandardAnswersPages Type

boolean
Properties
Filter
Description
The option to enable standard pages associated with an answers community. If
you want to use default Answers pages (such as AnswersHome), enable these
pages.
OptionsAllowStandardIdeasPages Type

boolean
Properties
Filter

1812

Standard Objects

Field

Site

Description
Description
The option to enable standard pages associated with an Ideas community. If you
want to use default Ideas pages (such as IdeasHome), enable these pages.

OptionsAllowStandardLookups

Type
boolean
Properties
Filter
Description
The option to enable the standard lookup pages. These are the popup windows
associated with lookup fields on Visualforce pages.

OptionsAllowStandardSearch

Type
boolean
Properties
Filter
Description
The option to enable the standard search pages. To allow public users to perform
standard searches, enable these pages.

OptionsEnableFeeds

Type
boolean
Properties
Filter
Description
The option that displays the Syndication Feeds related list, where you can create
and manage syndication feeds for users on your public sites. This field is visible
only if you have the feature enabled for your organization.

OptionsRequireHttps

Type
boolean
Properties
Filter
Description
When true, the site requires secure connections. When false, the site operates
normally via insecure connections instead of redirecting to a secure connection.

SiteType

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort

1813

Standard Objects

Field

Site

Description
Description
Identifies whether the site is a Visualforce (Force.com Sites) or a Site.com site.
SiteType is available in API version 21.0 and later. In API version 26.0 and
later, if Salesforce Communities is enabled for your organization, the site could
also be a Network Visualforce or Network Site.com site.

Status

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The status for the site. For example, Active or In Maintenance.

Subdomain

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The Force.com domain that you registered for your site. For example, if your
Force.com domain is mycompany.force.com, then mycompany is the
subdomain.

TopLevelDomain

Type
url
Properties
Filter, Nillable
Description
The optional branded custom Web address that you registered with a third-party
domain name registrar. The custom Web address acts as an alias to your Force.com
address.
Beginning with API version 21.0, TopLevelDomain is no longer available.
Instead, use the Domain and DomainSite objects.

UrlPathPrefix

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The unique Force.com URL that the public uses to access this site.

1814

Standard Objects

SiteDomain

Usage
Use this read-only object to query or retrieve information on your Force.com site.

SiteDomain
SiteDomain is a read-only object, and a one-to-many replacement for the Site.TopLevelDomain field. This object is available in API version
21.0, and has been deprecated as of API version 26.0. In API version 26.0 and later, use the Domain and DomainSite objects instead.
To access this object, Force.com Sites or Site.com must be enabled for your organization.

Supported Calls
describeSObjects(), query(), retrieve()

Special Access Rules
• Customer Portal users can’t access this object.
• To view this object, you must have the “View Setup and Configuration” permission.

Fields
Field

Description

Domain

Type
url
Properties
Filter, Sort
Description
The branded custom Web address within the global namespace identified by
this domain's type. In the Domain Name System (DNS) global namespace, this
field is the custom Web address that you registered with a third-party domain
name registrar. The custom Web address can be used to access the site of this
domain.

SiteId

Type
reference
Properties
Filter, Group, Sort
Description
The ID of the associated Site.

DomainType

Type
picklist

1815

Standard Objects

SiteHistory

Field

Description
Properties
Filter, Group, Sort, Nillable
Description
The global namespace that this custom Web address belongs to. This value is
set to DNS for custom Web addresses in the global DNS. This field is available in
version 24.0 of the API.

Usage
Use this read-only object to query the custom Web addresses that are associated with each website in your organization.

SiteHistory
Represents the history of changes to the values in the fields of a site. This object is generally available in API version 18.0 and later.
To access this object, Force.com Sites must be enabled for your organization.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
• Customer Portal users can't access this object.
• To view this object, you must have the “View Setup and Configuration” permission.

Fields
Field

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

NewValue

Type
anyType
Properties
Nillable, Sort

1816

Standard Objects

Field

Skill

Details
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The last value of the field before it was changed.

SiteId

Type
reference
Properties
Filter, Group, Sort
Description
The ID of the associated Site.

Skill
Represents a category or group that Live Agent users or field service resources can be assigned to. This object is available in API version
24.0 and later.
Note: For information about Work.com skills on a user’s profile, see the ProfileSkill topic.

Supported Calls
create(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Fields
Field Name

Details

Description

Type
textarea
Properties
Create, Nillable, Update
Description
The description of the skill.

DeveloperName

Type
string

1817

Standard Objects

Field Name

Skill

Details
Properties
Create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must begin with
a letter, not include spaces, not end with an underscore, and not contain two
consecutive underscores. In managed packages, this field prevents naming
conflicts on package installations. With this field, a developer can change the
object’s name in a managed package and the changes are reflected in a
subscriber’s organization.
Note: When creating large sets of data, always specify a unique
DeveloperName for each record. If no DeveloperName is specified,
performance may slow while Salesforce generates one for each record.

Language

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the skill.

LastViewedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed the skill.

MasterLabel

Type
string
Properties
Create, Filter, Group, Sort, Update, idLookup
Description
The name of the skill.

Usage
Live Agent
Use this object to assign Live Agent users to groups based on their abilities. The skills associated with a LiveChatButton determine
which agents receive chat requests that come in through that button.

1818

Standard Objects

SkillProfile

Field Service Lightning
Use this object to track certifications and areas of expertise in your workforce. After you create a skill, you can:
• Assign it to a service resource via the Skills related list on the resource’s detail page. When you assign a skill to a service resource,
you can specify their skill level and the duration of the skill.
• Add it as a required skill via the Skill Requirements related list on any work type, work order, or work order line item. When you
add a required skill to a work record, you can specify the skill level.

SkillProfile
Represents a join between Skill and Profile. This object is available in API version 24.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
Field Name

Details

ProfileId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the profile.

SkillId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the skill.

Usage
Use this object to assign specific skills to specific profiles.

SkillRequirement
Represents a skill that is required to complete a particular task. Skill requirements can be added to work types, work orders, and work
order line items. This object is available in API version 38.0 and later.

1819

Standard Objects

SkillRequirement

Supported Calls
create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),
update(), upsert()

Fields
Field Name

Details

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this
record.

LastViewedDate

RelatedRecordId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The record that the skill is required for. The related record can be a work order,
work order line item, or work type.

SkillId

Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The skill that is required.

SkillLevel

Type
double

1820

Standard Objects

Field Name

SkillRequirementFeed

Details
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
The level of the skill required. Skill levels can range from zero to 99.99. Depending
on your business needs, you may want the skill level to reflect years of experience,
certification levels, or license classes.

SkillNumber

Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
An auto-generated number identifying the skill requirement.

Usage
If a work order or work order line item can only be completed by a service resource with a particular set of skills, add required skills to the
record via the Skill Requirements related list. Required skills help dispatchers assign the record to a service resource with the proper
expertise. You can still assign a work order, work order line item, or related service appointment to a service resource that does not
possess the required skills, so required skills serve more as a suggestion than a rule.
Note: If you’re using the Field Service Lightning managed packages, you can use matching rules to ensure that appointments
are only assigned to service resources who possess the required skills listed on the parent work order.
If many of your work orders require the same skills, we recommend adding required skills to work types to save yourself some time and
keep your processes consistent. When you add a required skill to a work type, work orders and work order line items that use that type
automatically inherit the required skill. For example, if you know that all annual maintenance visits for your Classic Refrigerator product
require a Refrigerator Maintenance skill level of at least 50, you can add that required skill to the Annual Maintenance Visit work type.
When it’s time to create a work order for a customer’s annual fridge maintenance, adding that work type to the work order adds the
required skill as well.

SkillRequirementFeed
Represents a single feed item on a skill requirement record detail page. This object is available in API version 38.0 and later.
A skill requirement feed shows changes to tracked fields on a skill requirement record. It also shows posts and comments about the
record. It’s a useful way to stay up to date with changes made to skill requirements in Salesforce.

Supported Calls
delete(), getDeleted(), getUpdated(), query(), retrieve()

1821

Standard Objects

SkillRequirementFeed

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The message that appears in the feed. Required when Type is TextPost.
Optional when Type is ContentPost orLinkPost.

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of comments associated with this feed item.

InsertedById

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the user who added this object to the feed. For example, if an application
migrates posts and comments from another application into a feed, the value is
set to the ID of the logged-in user.

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
true indicates that the body of the feed contains rich text. false indicates
that the post is rendered as plain text.

1822

Standard Objects

SkillRequirementFeed

Field Name

Details

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of feed likes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of a link post.

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the skill requirement record tracked in the feed. The feed is displayed on
the detail page for this record.

RelatedRecordId

Type
reference
Properties
Group, Nillable, Sort
Description
ID of the ContentVersion object associated with a content post. This field
is null for all posts, except ContentPost.

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the feed item. When the Type is LinkPost, the Link URL is the
URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort

1823

Standard Objects

Field Name

SkillRequirementHistory

Details
Description
The type of feed item.

SkillRequirementHistory
Represents the history of changes made to tracked fields on a skill requirement. This object is available in API version 38.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
Field Service Lightning must be enabled.

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed.

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The value of the field before it was changed.

1824

Standard Objects

SkillUser

Field Name

Details

SkillRequirementId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the skill requirement being tracked. The history is displayed on the detail
page for this record.

SkillUser
Represents a join between Skill and User. This object is available in API version 24.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
Field Name

Details

SkillId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the skill.

UserId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the user.

Usage
Use this object to assign specific skills to specific users.

1825

Standard Objects

SlaProcess

SlaProcess
Represents an entitlement process associated with an Entitlement. This object is available in API version 19.0 and later.
An entitlement process is a timeline that includes all the steps (MilestoneType records) that your support team must complete to resolve
cases. Each process includes the logic necessary to determine how to enforce the correct service level for your customers.

Supported Calls
describeSObjects(), query(), retrieve()

Special Access Rules
Customer Portal users can’t access this object.
All users, even those without the “View Setup and Configuration” user permission, can view entitlement processes via the API.

Fields
Field

Details

BusinessHoursId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Required. ID of the BusinessHours associated with the entitlement. Must be a valid
business hours ID.

Description

Type
textarea
Properties
Filter, Nillable
Description
A description of the entitlement process.

IsActive

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the entitlement process is active (true) or not (false).

IsVersionDefault

Type
boolean

1826

Standard Objects

Field

SlaProcess

Details
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the entitlement process is the default version (true) or not
(false).
This field is available in API version 28.0 and later in organizations that have entitlement
versioning enabled.

Name

Type
string
Properties
Filter, idLookup
Description
The name of the entitlement process.

NameNorm

Type
string
Properties
Filter, Group, Sort
Description
The read-only value for the unique name of the entitlement process or the entitlement
process version. If entitlement versioning is enabled, this value is automatically
generated for each version of an entitlement process in this form: process
name+_v + x, where x is the version number (for example, “gold_support_v2”).
If entitlement versioning isn’t enabled, this value is the same as Name.
This field is available in API version 28.0 and later.

SObjectType

Type
picklist
Properties
Restricted picklist, Filter, Group, Sort
Description
The type of records that the entitlement process can run on. Its values are:
• Case
• Work Order
An entitlement process runs only on records that match its type. For example, a Case
entitlement process that’s applied to an entitlement runs only on cases associated
with the entitlement, not on work orders. As a best practice, therefore, manage
customers’ work orders and cases on separate entitlements.
The field label in the user interface is Entitlement Process Type.

1827

Standard Objects

SlaProcess

Field

Details

StartDateField

Type
picklist
Properties
Filter, Restricted picklist
Description
The criteria for cases to enter the entitlement process. Cases can enter the process
based on:
• The creation date on a case
• A custom date/time field on a case

VersionMaster

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Identifies the sequence of versions to which this entitlement process belongs. This
field’s contents can be any value as long as it is identical among all versions of the
entitlement process.
This field is available in API version 28.0 and later in organizations that have entitlement
versioning enabled.

VersionNotes

Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
The description of the entitlement process version.
This field is available in API version 28.0 and later in organizations that have entitlement
versioning enabled.

VersionNumber

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The version number of the entitlement process. Must be 1 or greater.
This field is available in API version 28.0 and later in organizations that have entitlement
versioning enabled.

1828

Standard Objects

Solution

Usage
Use this object to query entitlement processes on entitlements.
SEE ALSO:
Entitlement
MilestoneType
CaseMilestone

Solution
Represents a detailed description of a customer issue and the resolution of that issue.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), search(), undelete(), update(), upsert()

Fields
Field

Details

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

IsHtml

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the Solution is an HTML solution (true) or not (false).

IsOutOfDate

Type
boolean
Properties
Defaulted on create, Filter

1829

Standard Objects

Field

Solution

Details
Description
Read-only field that indicates whether a solution master has been updated since the translated
version was created (true) or not (false). Note that this field does not appear in the page
layout of master solutions.

IsPublished

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the Solution has been published (true) or not (false). A solution’s
published state does not affect how it can be used, or whether you can query, update, or
delete it. Label is Public.
Note: Prior to Spring ‘14, the label was Visible in Self-Service Portal.

IsPublishedInPublicKb

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the Solution has been published as a Public Solution (true) or not
(false). Label is Visible in Public Knowledge Base.
This field only applies to solutions, not articles in the public knowledge base.

IsReviewed

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the Solution has been reviewed (true) or not (false). This flag can
only be set indirectly via the Status picklist. Each predefined Status value implies an
IsReviewed value. Label is Reviewed.

LastReferencedDate

Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.

1830

Standard Objects

Solution

Field

Details

LastViewedDate

OwnerId

Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the User who owns the Solution.

ParentId

Type
reference
Properties
Create, Defaulted on create, Filter, Update
Description
ID of the master solution, if this is the translation of a master solution.

RecordTypeId

Type
reference
Properties
Create, Filter, Nillable, Update
Description
ID of the RecordType to which the Solution is associated.

SolutionLanguage

Type
picklist
Properties
Create, Filter, Restricted picklist, Update
Description
The language that the solution is written in, such as French or Chinese
(Traditional).

SolutionName

Type
string
Properties
Create, Filter, Group, Sort, Update

1831

Standard Objects

Field

Solution

Details
Description
Required. If a client application creates a new Solution and a value for this field is unspecified,
a hyphen (-), the default value for this field, is used. Limit: 255 characters. Label is Title.

SolutionNote

Type
textarea
Properties
Create, Nillable, Update
Description
The details of the Solution record. Limit: 32,000 characters. Label is Solution Details.
Note: If you have HTML Solutions enabled, any HTML tags used in this field are
verified before the object is created or updated. If invalid HTML is entered, an error is
thrown. Any JavaScript used in this field is removed before the object is created or
updated.

SolutionNumber

Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
An identifying number that is assigned automatically when a solution is created. It can’t be
set directly, and it can’t be modified.

Status

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. The status of the solution. Directly controls the IsReviewed value. To obtain
the status values in the picklist, a client application can query the SolutionStatus.

TimesUsed

Type
int
Properties
Filter, Group, Sort
Description
Number of times this solution has been used. Label is Num Related Case.

1832

Standard Objects

SolutionFeed

Usage
Use this object to manage your organization’s solutions. Client applications can create, update, delete, and query Attachment records
associated with a solution.
SEE ALSO:
CategoryData
CategoryNode

SolutionFeed
Represents a single feed item in the feed displayed on the detail page for a solution record. This object is available in API version 18.0
and later.
A solution feed shows recent changes to a solution record for any fields that are tracked in feeds, and comments and posts about the
record. It is a useful way to stay up-to-date with changes to solutions.

Supported Calls
delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules
You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions:
• “Modify All Data”
• “Modify All” on the Solution object
• “Moderate Chatter”
Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.

Fields
Field Name

Details

Body

Type
textarea
Properties
Nillable, Sort
Description
The content of the SolutionFeed. Required when Type is TextPost. Optional
when Type is ContentPost or LinkPost. This field is the message that
appears in the feed.

1833

Standard Objects

SolutionFeed

Field Name

Details

CommentCount

Type
int
Properties
Filter, Group, Sort
Description
The number of FeedComments associated with this feed item.
Tip: In a feed that supports pre-moderation, CommentCount isn’t updated
until a comment is published. For example, say you comment on a post that
already has one published comment and your comment triggers moderation.
Now there are two comments on the post, but the count says there's only
one. In a moderated feed, your comment isn’t counted until it's approved by
an admin or a person with “CanApproveFeedPostAndComment” or
“ModifyAllData” permission.
This has implications for how you retrieve feed comments. In a moderated
feed, rather than retrieving comments by looping through CommentCount,
go through pagination until end of comments is returned.

ConnectionId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
When a PartnerNetworkConnection modifies a record that is tracked, the
CreatedBy field contains the ID of the system administrator. The
ConnectionId contains the ID of the PartnerNetworkConnection. Available
if Salesforce to Salesforce is enabled for your organization.

ContentData

ContentDescription

Type
textarea
Properties
Nillable, Sort
Description
Available in API version 36.0 and earlier only.

1834

Standard Objects

Field Name

SolutionFeed

Details
The description of the file specified in ContentData.

ContentFileName

ContentSize

Type
int
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded
to the feed. This field is read-only and is automatically determined during insert.

ContentType

Type
string
Properties
Group, Nillable, Sort
Description
Available in API version 36.0 and earlier only. The MIME type of the file uploaded
to the feed. This field is read-only and is automatically determined during insert.

FeedPostId

Type
reference
Properties
Filter. Group, Nillable, Sort
Description
This field was removed in API version 22.0, and is available in earlier versions for
backward compatibility only. Use FeedItem instead.
The ID of the associated FeedPost. A FeedPost represents the following types of
changes in a SolutionFeed: status updates, changes to tracked fields, text posts,
link posts, and content posts.

InsertedById

Type
reference
Properties
Group, Nillable, Sort

1835

Standard Objects

Field Name

SolutionFeed

Details
Description
The ID of the user who added this object to the feed. For example, if a client
application migrates multiple posts and comments from another application
into the feed, InsertedById is set to the ID of the logged-in user.

IsRichText

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the feed item Body contains rich text. Set IsRichText
to true if you post a rich text feed item via SOAP API. Otherwise, the post is
rendered as plain text.
Rich text supports the following HTML tags:
•
Tip: Though the
tag isn’t supported, you can use
to create lines.
•
•
•
•
•
•
•
•
•
The tag is accessible only via the API and must reference files in
Salesforce similar to this example:

Type
dateTime
Properties
Defaulted on create, Filter, Sort
Description
This field is a standard system field.

1836

Standard Objects

Field Name

SolutionFeed

Details
When a feed item is created, LastModifiedDate is the same as
CreatedDate. If a FeedComment is inserted on the feed item, then
LastModifiedDate becomes the CreatedDate for the FeedComment.
Deleting the FeedComment does not change the LastModifiedDate.
Ordering by LastModifiedDate DESC sorts the feed by both the most
recent feed item or comment.

LikeCount

Type
int
Properties
Filter, Group, Sort
Description
The number of FeedLikes associated with this feed item.

LinkUrl

Type
url
Properties
Nillable, Sort
Description
The URL of the LinkPost.

NetworkScope

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies whether this feed item is available in the default community, a specific
community, or all communities. This field is available in API version 26.0 and later,
if Salesforce Communities is enabled for your organization.
NetworkScope can have the following values:

• NetworkId—The ID of the community in which the FeedItem is available.
If left empty, the feed item is only available in the default community.
• AllNetworks—The feed item is available in all communities.
Note the following exceptions for NetworkScope:
• Only feed items with a Group or User parent can set a NetworkId or a
null value for NetworkScope.
• For feed items with a record parent, users can set NetworkScope only
to AllNetworks.
• You can’t filter a FeedItem on the NetworkScope field.

1837

Standard Objects

SolutionFeed

Field Name

Details

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the solution record that is tracked in the feed. The feed is displayed on the
detail page for this record.

RelatedRecordId

Title

Type
string
Properties
Group, Nillable, Sort
Description
The title of the SolutionFeed. When the Type is LinkPost, the LinkUrl
is the URL, and this field is the link name.

Type

Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of SolutionFeed item:
• ActivityEvent—indirectly generated event when a user or the API
adds a Task associated with a feed-enabled parent record (excluding email
tasks on cases). Also occurs when a user or the API adds or updates a Task or
Event associated with a case record (excluding email and call logging).
For a recurring Task with CaseFeed disabled, one event is generated for the
series only. For a recurring Task with CaseFeed enabled, events are generated
for the series and each occurrence.
• AdvancedTextPost—created when a user posts a group
announcement.

1838

Standard Objects

Field Name

SolutionFeed

Details
• AnnouncementPost—Not used.
• ApprovalPost—generated when a user submits an approval.
• BasicTemplateFeedItem—Not used.
• CanvasPost—a post made by a canvas app posted on a feed.
• CollaborationGroupCreated—generated when a user creates a
public group.
• CollaborationGroupUnarchived—Not used.
• ContentPost—a post with an attached file.
• CreatedRecordEvent—generated when a user creates a record from
the publisher.
• DashboardComponentAlert—generated when a dashboard metric
or gauge exceeds a user-defined threshold.
• DashboardComponentSnapshot—created when a user posts a
dashboard snapshot on a feed.
• LinkPost—a post with an attached URL.
• PollPost—a poll posted on a feed.
• ProfileSkillPost—generated when a skill is added to a user’s Chatter
profile.
• QuestionPost—generated when a user posts a question.
• ReplyPost—generated when Chatter Answers posts a reply.
• RypplePost—generated when a user creates a Thanks badge in
Work.com.
• TextPost—a direct text entry on a feed.
• TrackedChange—a change or group of changes to a tracked field.
• UserStatus—automatically generated when a user adds a post.
Deprecated.
The following values appear in the Type picklist for all feed objects but apply
only to CaseFeed:
• AttachArticleEvent—generated event when a user attaches an
article to a case.
• CallLogPost—generated event when a user logs a call for a case through
the user interface. CTI calls also generate this event.
• CaseCommentPost—generated event when a user adds a case comment
for a case object.
• ChangeStatusPost—generated event when a user changes the status
of a case.
• ChatTranscriptPost—generated event when Live Agent transcript
is saved to a case.
• EmailMessageEvent—generated event when an email related to a
case object is sent or received.

1839

Standard Objects

Field Name

SolutionHistory

Details
• FacebookPost—generated when a Facebook post is created from a
case. Deprecated.
• MilestoneEvent—generated when a case milestone is completed or
reaches violation status.
• SocialPost—generated when a social post is created from a case.

Visibility

• AllUsers—The feed item is available to all users who have permission
to see the feed item.
• InternalUsers—The feed item is available to internal users only.
Note the following exceptions for Visibility:
• For record posts, Visibility is set to InternalUsers for all internal
users by default.
• External users can set Visibility only to AllUsers.
• Visibility can be updated on record posts.
• The Update property is supported only for feed items posted on records.

Usage
Use this object to track changes for a solution record.
SEE ALSO:
Solution
EntitySubscription
NewsFeed
UserProfileFeed

SolutionHistory
Represents the history of changes to the values in the fields of a solution.

1840

Standard Objects

SolutionHistory

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed. Label is Custom Field Definition ID.

IsDeleted

Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false).
Label is Deleted.

NewValue

Type
anyType
Properties
Nillable, Sort
Description
The new value of the field that was changed. Limited to 255 characters.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The latest value of the field before it was changed. Limited to 255 characters.

SolutionId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the Solution. Label is Solution ID.

1841

Standard Objects

SolutionStatus

Usage
Use this read-only object to identify changes to a solution.
This object respects field-level security on the parent object.
SEE ALSO:
SolutionStatus

SolutionStatus
Represents the status of a Solution, such as Draft, Reviewed, and so on.

Supported Calls
describeSObjects(), query(), retrieve()

Fields
Field

Details

ApiName

Type
string
Properties
Filter, Group, NillableSort
Description
Uniquely identifies a picklist value so it can be retrieved without using an id or master label.

IsDefault

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this is the default solution status value (true) or not (false) in the
picklist. Only one value can be the default value.

IsReviewed

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this solution status value represents a reviewed Solution (true) or not
(false). Multiple solution status values can represent a reviewed Solution.

1842

Standard Objects

SolutionTag

Field

Details

MasterLabel

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Master label for this solution status value. This display value is the internal label that does
not get translated.

SortOrder

Type
int
Properties
Filter, Group, Nillable, Sort
Description
Number used to sort this value in the solution status picklist. These numbers are not
guaranteed to be sequential, as some previous solution status values might have been
deleted.

Usage
This object represents a value in the solution status picklist. The solution status picklist provides additional information about the status
of a Solution, such as whether a given status value represents a reviewed or unreviewed solution. Your client application can query this
object to retrieve the set of values in the solution status picklist, and then use that information while processing Solution objects to
determine more information about a given solution. For example, the application could test whether a given case has been reviewed
or not based on its Status value and the value of the IsReviewed property in the associated SolutionStatus record.
SEE ALSO:
Solution

SolutionTag
Associates a word or short phrase with a Solution.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve()

1843

Standard Objects

SolutionTag

Fields
Field Name

Details

ItemId

Type
reference
Properties
Create, Filter
Description
ID of the tagged item.

Name

TagDefinitionId

Type
reference
Properties
Filter
Description
ID of the parent TagDefinition object that owns the tag.

Type

Usage
SolutionTag stores the relationship between its parent TagDefinition and the Solution being tagged. Tag objects act as metadata, allowing
users to describe and organize their data.

1844

Standard Objects

SOSDeployment

When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting
a TagDefinition sends it to the Recycle Bin, along with any associated tag entries.

SOSDeployment
Represents the general settings for deploying SOS video call capability in a native mobile application. This object is available in API
version 34.0 and later.

Supported Calls
create(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
Field Name

Details

DeveloperName

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must begin with
a letter, not include spaces, not end with an underscore, and not contain two
consecutive underscores. In managed packages, this field prevents naming
conflicts on package installations. With this field, a developer can change the
object’s name in a managed package and the changes are reflected in a
subscriber’s organization.
Note: When creating large sets of data, always specify a unique
DeveloperName for each record. If no DeveloperName is specified,
performance may slow while Salesforce generates one for each record.

Language

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the deployment.

MasterLabel

Type
string
Properties
Create, Filter, Group, Sort, Update

1845

Standard Objects

Field Name

SOSDeployment

Details
Description
The name of the deployment.

OptionsIsBackwardFacingCameraEnabled Type

boolean
Properties
Create, Filter, Update
Description
Determines whether customers can use the backwards-facing camera on their
mobile devices to talk to SOS agents.
OptionsIsEnabled

Type
boolean
Properties
Create, Filter, Update
Description
Determines whether the deployment is enabled for customers to request new
SOS video calls.

OptionsIsVoiceOnlyMode

Type
boolean
Properties
Create, Filter, Update
Description
Determines whether video functionality is disabled for customers, making it so
customers can only talk to SOS agents using only audio.

QueueId

Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The ID of the queue that’s associated with the SOS deployment.

Usage
Use this object to query and manage SOS deployments.

1846

Standard Objects

SOSSession

SOSSession
This object is automatically created for each SOS session and stores information about the session. This object is available in API versions
34.0 and later.

Supported Calls
create()delete()
,
describeLayout()
,
describeSObjects()
,
getDeleted()
,
getUpdated()
,
query()
,
retrieve()
,
search()
,
undelete()
,
update()
,
upsert()
,

Fields
Field Name

Details

AppVersion

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The version of the customer’s mobile application in which SOS is implemented.

CaseId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the case that’s associated with the SOS session.

ContactId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the contact that’s associated with the SOS session.

DeploymentId

Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the SOS deployment that the SOS session originated from.

EndTime

Type
dateTime

1847

Standard Objects

Field Name

SOSSession

Details
Properties
Create, Filter, Nillable, Sort, Update
Description
The time that the SOS session ended.

IpAddress

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The IP address from which the customer’s SOS call originated.

LastReferencedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time that the session record was last referenced by a user.

LastViewedDate

Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time that the session record was last viewed.

Name

Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
The name of the session.

OpentokSession

Type
encryptedstring
Properties
Create, Nillable, Update
Description
The ID of the OpenTok session that’s associated with the SOS video call.

OwnerId

Type
reference

1848

Standard Objects

Field Name

SOSSession

Details
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the session record’s owner.

SessionDuration

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The amount of time that the SOS session lasted.

SessionRecordingUrl

Type
url
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The URL where the SOS session recording is stored.

SosVersion

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The version of SOS that was used in your organization’s mobile application when
this session occurred.

StartTime

Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The time that the SOS session began.

SystemInfo

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Information about the customer’s mobile device from which the SOS call
originated, such as the device’s operating system.

1849

Standard Objects

SOSSessionActivity

Field Name

Details

WaitDuration

Type
int
Properties
Filter, Group, Nillable, Sort
Description
The amount of time the customer waited before an agent accepted the SOS
session and the call began.

Usage
Use this object to query and manage SOS session records.

SOSSessionActivity
Captures information about specific events that occur during an SOS video call, such as when an SOS call begins or ends. This object is
available in API version 34.0 and later.

Supported Calls
create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()

Fields
Field Name

Details

ActivityTime

Type
dateTime
Properties
Create, Filter, Sort
Description
The time at which the activity occurred.

Name

Type
string
Properties
Autonumber, Defaulted on create, idLookup, Filter, Sort
Description
The name of the activity.

SessionId

Type
reference

1850

Standard Objects

Field Name

SOSSessionHistory

Details
Properties
Create, Filter, Group, Sort
Description
The ID of the SOS session that’s associated with the event.

Type

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The kind of activity that occurred.

Usage
Use this object to query and manage SOS session activities.

SOSSessionHistory
This object is automatically created for each SOS session and stores information about changes made to the session. This object is
available in API versions 34.0 and later.

Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields
Field Name

Details

Field

Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the field that was changed in a session record.

NewValue

Type
anyType
Properties
Nillable, Sort

1851

Standard Objects

Field Name

SOSSessionOwnerSharingRule

Details
Description
The new value of the field that was changed.

OldValue

Type
anyType
Properties
Nillable, Sort
Description
The original value of the field that was changed.

SOSSessionId

Type
reference
Properties
Filter, Group, Sort
Description
ID of the session record that was changed.

Usage
Use this object to identify changes to SOS session records.

SOSSessionOwnerSharingRule
Represents the rules for sharing an SOS session record with users other than the record owner. This object is available in API version 34.0
and later.
Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer
support to enable access to this object for your org.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Fields
Field Name

Details

AccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update

1852

Standard Objects

Field Name

SOSSessionOwnerSharingRule

Details
Description
Determines the level of access users have to session records. Specifies whether
or not users can read, edit, or transfer session records. Corresponds to the
Default Access column in the UI.

Description

Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A description of the sharing rule. Maximum length is 1000 characters.

DeveloperName

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must begin with
a letter, not include spaces, not end with an underscore, and not contain two
consecutive underscores. In managed packages, this field prevents naming
conflicts on package installations. With this field, a developer can change the
object’s name in a managed package and the changes are reflected in a
subscriber’s organization. Corresponds to Rule Name in the UI.
Note: When creating large sets of data, always specify a unique
DeveloperName for each record. If no DeveloperName is specified,
performance may slow while Salesforce generates one for each record.

GroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID that represents the source group. Session records that are owned by users
in the source group trigger the rule to give access.

Name

Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update

1853

Standard Objects

Field Name

SOSSessionShare

Details
Description
Label of the sharing rule as it appears in the user interface. Limited to 80
characters. Corresponds to Label in the UI.

UserOrGroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID that represents the User or Group that you are granting access to.

Usage
Use this object to manage the sharing rules for SOS session records.
SEE ALSO:
Metadata API Developer Guide: SharingRules

SOSSessionShare
Represents a sharing entry on an SOS session. This object is available in API version 34.0 and later.

Supported Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields
The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the
default settings of such fields.
Field Name

Details

AccessLevel

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Level of access that the User or Group has to the SOSSession. The possible values
are:
• Read

1854

Standard Objects

Field Name

SOSSessionShare

Details
• Edit
• All (This value is not valid for create() or update() calls.)
This field must be set to an access level that is higher than the organization’s
default access level for live chat transcripts.

ParentId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the parent object, if any.

RowCause

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Reason that this sharing entry exists.
You can create a value for this field in API versions 32.0 and later with the correct
organization-wide sharing settings.
Values can include:
• Manual—The user or group has access because a user with “All” access
manually shared the SOSSession with them.
• Owner—The user is the owner of the SOSSession or is in a role above the
SOSSession owner in the role hierarchy.

UserOrGroupId

Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the user or group that has been given access to the SOSSession.

Usage
This object lets you determine which users and groups can view and edit SOSSession records that are owned by other users.
If you attempt to create a new record that matches an existing record, the create() call updates any modified fields and returns the
existing record.

1855

Standard Objects

Stamp

Stamp
Represents a User Specialty. This object is available in API version 39.0 and later.
Create User Specialty labels. Specialties can be any term you want, up to 50 characters, including spaces and underscores.

Supported Calls
describeSObjects(), query(), retrieve()

Fields
Field

Description

Type
string
Properties
Filter, Group, Nillable, Sort
Description
Use this field to describe what the user specialty means and how it applies to a
user. You have a 255 character maximum including spaces and underscores.

MasterLabel

Type
string
Properties
Filter, Group, Sort
Description
The User Specialty label that appears under the user’s profile picture. You can
create any label you want as long as it’s within the 50 character maximum,
including spaces and underscores.

ParentId

Type
reference
Properties
Filter, Group, Sort
Description
The id of the org or network.

StampAssignment
Represents assignment of a User Specialty to a user. This object is available in API version 39.0 and later.
Assign a User Specialty to users. This label appears beneath their profile photo.

1856

Standard Objects

StaticResource

Supported Calls
describeSObjects(), query(), retrieve()

Fields
Field

Details

StampId

Type
reference
Properties
Filter, Group, Sort
Description
The unique id generated when creating a user specialty.

SubjectId

Type
reference
Properties
Filter, Group, Sort
Description
The id for the user getting the User Specialty label.

StaticResource
Represents a static resource that can be used in Visualforce markup.

Supported Calls
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(),
update(), upsert()

Fields
Field

Details

Body

Type
base64
Properties
Create, Nillable, Update
Description
Required. Encoded file data.

1857

Standard Objects

StaticResource

Field

Details

BodyLength

Type
int
Properties
Filter, Group, Sort
Description
Size of the file (in bytes).

CacheControl

Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The sharing policy for the static resource when cached. The cache control can have one of
the following values:
• Private specifies that the static resource data cached on the Salesforce server shouldn’t
be shared with other users. The static resource is only stored in cache for the current
user’s session.
• Public specifies that the static resource data cached on the Salesforce server be shared
with other users in your organization for faster load times.

ContentType

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Type of content. Label is Mime Type. Limit: 120 characters.

Description

Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Text description of the static resource. Limit: 255 characters.

Name

Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Name of the static resource.

1858

Standard Objects

StaticResource

Field

Details

NamespacePrefix

Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that
creates a managed package has a unique namespace prefix. Limit: 15 characters. You can
refer to a component in a managed package by using the
namespacePrefix__componentName notation.
The namespace prefix can have one of the following values:
• In Developer Edition organizations, the namespace prefix is set to the namespace prefix
of the organization for all objects that support it. There is an exception if an object is in
an installed managed package. In that case, the object has the namespace prefix of the
installed managed package. This field’s value is the namespace prefix of the Developer
Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix
is only set for objects that are part of an installed managed package. There is no
namespace prefix for all other objects.
This field can’t be accessed unless the logged-in user has the “Customize Application”
permission.

Usage
Use static resources to upload content that you can reference in Visualforce markup, including archives (such as .zip and .jar files), images,
stylesheets, JavaScript, and other files. Using a static resource is preferable to uploading a file to the Documents tab because:
• You can package a collection of related files into a directory hierarchy and upload that hierarchy as a .zip or .jar archive.
• You can reference a static resource in page markup by name using the $Resource global variable instead of hard-coding
document IDs.

1859

Standard Objects

StreamingChannel

Maximum Static Resource Size
You can create or update static resources to a maximum size of 5 MB. An organization can have up to 250 MB of static resources, total.
SEE ALSO:
ApexComponent
ApexPage
Developer Guide: Visualforce Developer Guide

StreamingChannel
Represents a channel that is the basis for notifying listeners of generic Streaming API events. Available from API version 29.0 or later.

Supported Calls
REST: DELETE, GET, PATCH, POST (query requests are specified in the URI)
SOAP: create(), delete(), describe(), describeLayout(), describeSObjects(), getDeleted(),
getUpdated(), query(), retrieve(), undelete(), update()

Special Access Rules
• This object is available only if Streaming API is enabled for your organization.
• Only users with “Create” permission can create this record.
• You can create a permission set and grant users read and create access to all streaming channels in the org. This access isn’t for a
specific channel, like with user sharing.
• You can apply user sharing to StreamingChannel. You can restrict access to receiving or sending events on a channel by sharing
channels with specific users or groups. Channels shared with public read-only or read-write access send events only to clients
subscribed to the channel that also are using a user session associated with the set of shared users or groups. Only users with
read-write access to a shared channel can generate events on the channel, or modify the actual StreamingChannel record.

Dynamic Streaming Channel
Generic Streaming also supports dynamic streaming channel creation, which creates a StreamingChannel when a client first subscribes
to the channel. To enable dynamic streaming channels in your org, from Setup, enter User Interface in the Quick Find box,
then select User Interface and enable Enable Dynamic Streaming Channel Creation.

Fields
Field

Field
Type

Description

string

Description of the StreamingChannel. Limit: 255 characters.
Field Properties: Create, Filter, Group, Nillable, Sort, Update
Label: Description

1860

Standard Objects

TagDefinition

Field

Field
Type

Description

System field: Globally unique string that identifies a StreamingChannel record.
Field Properties: Default on create, Filter, Group, idLookup, Sort

IsDeleted

boolean

System field: Indicates whether the record has been moved to the Recycle Bin (true)
or not (false).
Field Properties: Default on create, Filter, Group, Sort

IsDynamic

boolean

true if the channel gets dynamically created on subscribe if necessary, false

otherwise.
Field Properties: Default on create, Filter, Group, Sort
LastReferencedDate

date

The timestamp for when the current user last viewed a record related to this record.
Field Properties: Filter, Sort

LastViewedDate

date

The timestamp for when the current user last viewed this record. If this value is null, this
record might only have been referenced (LastReferencedDate) and not viewed.
Field Properties: Filter, Sort

Name

string

Required. Descriptive name of the StreamingChannel. Limit: 80 characters, alphanumeric
and “_”, “/” characters only. Must start with “/u/”. This value identifies the channel and
must be unique.
Field Properties: Create, Filter, Group, idLookup, Sort, Update
Label: Streaming Channel Name

OwnerId

reference

The ID of the owner of the StreamingChannel.
Field Properties: Create, Default on create, Filter, Group, Sort, Update
Label: Owner Name

TagDefinition
Defines the attributes of child Tag objects.

Supported Calls
delete(), describeSObjects(), query(), retrieve(), search(), undelete(), update()

1861

Standard Objects

TagDefinition

Fields
Field

Detail

Name

Type
string
Properties
Filter, Nillable, Update
Description
Identifies the tag word or phrase.

Type

Type
picklist
Properties
Filter, Nillable, Restricted picklist
Description
Defines the visibility of a tag. Possible value are:
• Public: The tag can be viewed and manipulated between all users in an organization.
• Personal: The tag can be viewed or manipulated only by a user with a matching
OwnerId.

Usage
When you create a tag for a record, an association is created with to a corresponding TagDefinition:
• If the value in the tag's Name field is new, a new TagDefinition record is automatically created and becomes the parent of the tag.
• If the value in the tag's Name field already exists in a TagDefinition, that TagDefinition automatically becomes the parent of the tag.
Each TagDefinition record has a one-to-many relationship with its child tag records.
The following standard objects represent tags for records:
• AccountTag
• AssetTag
• CampaignTag
• CaseTag
• ContactTag
• ContractTag
• DocumentTag
• EventTag
• LeadTag
• NoteTag
• OpportunityTag
• SolutionTag
• TaskTag

1862

Standard Objects

Task

Custom objects may also be tagged. Tags for custom objects are identified by a suffix of two underscores immediately followed by the
word tag. For example, a custom object named Meeting has a corresponding tag named Meeting__tag in that organization’s
WSDL. Meeting__tag is only valid for Meeting objects.
TagDefinition is useful for mass operations on any tag record. For instance, if you want to rename existing tags, you can search for the
appropriate TagDefinition object, update it, and the child tag's Name values are also changed. The following Java example replaces all
WC tags with the phrase West Coast:
public void tagDefinitionSample() {
String soqlQuery = "SELECT Id, Name FROM TagDefinition " +
"WHERE Name = 'WC'";
QueryResult qResult = null;
try {
qResult = connection.query(soqlQuery);
TagDefinition tagDef = (TagDefinition) qResult.getRecords()[0];
tagDef.setName("West Coast");
connection.update(new SObject[]{tagDef});
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}

Task
Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively
referred to as activities.
Note: Task fields related to calls are exclusive to Salesforce CRM Call Center. Additionally, query(), delete(), and update()
aren’t allowed with tasks related to more than one contact in API versions 23.0 and earlier.

Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),
retrieve(), search(), undelete(), update(), upsert()

Fields
Field

Field Type

AccountId

Type
reference
Properties
Group, Sort, Filter, Nillable
Description
Represents the ID of the related Account. The AccountId is determined as follows.

1863

Standard Objects

Field

Task

Field Type
If the value of WhatId is any of the following objects, then Salesforce uses that object’s
AccountId.
• Account
• Opportunity
• Contract
• Custom object that is a child of Account
If the value of the WhatIdfield is any other object, and the value of the WhoId field is a
Contact object, then Salesforce uses that contact’s AccountId. (If your organization uses
Shared Activities, then Salesforce uses the AccountId of the primary contact.)
Otherwise, Salesforce sets the value of the AccountId field to null.
For information on IDs, see ID Field Type.

ActivityDate

Type
date
Properties
Group, Sort, Create, Filter, Nillable, Update
Description
Represents the due date of the task. This field has a timestamp that is always set to midnight
in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not
attempt to alter it in order to accommodate time zone differences. Label is Due Date.
Note: This field can’t be set or updated for a recurring task (IsRecurrence is
true).

CallDisposition

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit
is 255 characters.
Not subject to field-level security, available for any user in an organization with Salesforce
CRM Call Center.

CallDurationInSeconds

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Duration of the call in seconds.

1864

Standard Objects

Field

Task

Field Type
Not subject to field-level security, available for any user in an organization with Salesforce
CRM Call Center.

CallObject

Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of a call center. Limit is 255 characters.
Not subject to field-level security, available for any user in an organization with Salesforce
CRM Call Center.

CallType

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of call being answered: Inbound, Internal, or Outbound.

ConnectionReceivedId

ConnectionSentId

Description

Type
textarea
Properties
Create, Nillable, Update

1865

Standard Objects

Field

Task

Field Type
Description
Contains a text description of the task.

IsArchived

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the event has been archived.

IsClosed

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the task has been completed (true) or not (false). Is only set indirectly
via the Status picklist. Label is Closed.

IsHighPriority

Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates a high-priority task. This field is derived from the Priority field.

IsRecurrence

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Indicates whether the task is scheduled to repeat itself (true) or only occurs once (false).
This is a read-only field on update, but not on create. If this field value is true, then
RecurrenceStartDateOnly, RecurrenceEndDateOnly, RecurrenceType,
and any recurrence fields associated with the given recurrence type must be populated. See
Recurring Tasks.

IsReminderSet

Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a popup reminder has been set for the task (true) or not (false).

1866

Standard Objects

Task

Field

Field Type

IsVisibleInSelfService

Type
boolean
Properties
Defaulted on create, Filter, Update
Description
Indicates whether a task associated with an object can be viewed in the Customer Portal
(true) or not (false).
If your organization has enabled Communities, tasks marked
IsVisibleInSelfService are visible to any external user in the community, as long
as the user has access to the record the task was created on.
This field is available when Customer Portal or partner portal are enabled OR Communities
is enabled and you have Customer Portal or partner portal licenses.

OwnerId

Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the User who owns the record. Label is Assigned To ID.

Priority

Type
picklist
Properties
Defaulted on create, Group, Sort, Create, Filter, Update
Description
Required. Indicates the importance or urgency of a task, such as high or low.

RecurrenceActivityId

Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Read-only. Not required on create. ID of the main record of the recurring task. Subsequent
occurrences have the same value in this field.

RecurrenceDayOfMonth

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The day of the month in which the task repeats.

1867

Standard Objects

Field

Task

Field Type

RecurrenceDayOfWeekMask Type

int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The day or days of the week on which the task repeats. This field contains a bitmask. The
values are as follows:
• Sunday = 1
• Monday = 2
• Tuesday = 4
• Wednesday = 8
• Thursday = 16
• Friday = 32
• Saturday = 64
Multiple days are represented as the sum of their numerical values. For example, Tuesday
and Thursday = 4 + 16 = 20.
RecurrenceEndDateOnly

Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The last date on which the task repeats. This field has a timestamp that is always set to
midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant;
do not attempt to alter it in order to accommodate time zone differences.

RecurrenceInstance

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The frequency of the recurring task. For example, “2nd” or “3rd.”

RecurrenceInterval

Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The interval between recurring tasks.

1868

Standard Objects

Task

Field

Field Type

RecurrenceMonthOfYear

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The month of the year in which the task repeats.

RecurrenceRegeneratedType Type

picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Represents what triggers a repeating task to repeat. Add this field to a page layout together
with the RecurrenceInterval field, which determines the number of days between
the triggering date (due date or close date) and the due date of the next repeating task in
the series.
Label is Repeat This Task. This field has the following picklist values:
• None: The task doesn’t repeat.
• After due date: The next repeating task will be due the specified number of days after
the current task’s due date.
• After the task is closed: The next repeating task will be due the specified number of
days after the current task is closed.
• (Task closed): This task, now closed, was opened as part of a repeating series.
RecurrenceStartDateOnly Type

date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the recurring task begins. Must be a date and time before
RecurrenceEndDateOnly.
RecurrenceTimeZoneSidKey Type

picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The time zone associated with the recurring task. For example, “UTC-8:00” for Pacific Standard
Time.
RecurrenceType

Type
picklist

1869

Standard Objects

Field

Task

Field Type
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates how often the task repeats. For example, daily, weekly, or every nth month (where
“nth” is defined in RecurrenceInstance).

ReminderDateTime

Status

Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. The current status of the task, such as In Progress or Completed. Each predefined
Status field implies a value for the IsClosed flag. To obtain picklist values, query the
TaskStatus object.
Note: This field can’t be updated for recurring tasks (IsRecurrence is true).

Subject

Type
combobox
Properties
Create, Filter, Nillable, Sort, Update
Description
The subject line of the task, such as “Call” or “Send Quote.” Limit: 255 characters.

TaskSubtype

Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Provides standard subtypes to facilitate creating and searching for specific task subtypes.
This field isn’t updateable.
TaskSubtype values:

1870

Standard Objects

Field

Task

Field Type
• Task
• Email
• Call

TaskWhoIds

Type
JunctionIdList
Properties
Create, Update
Description
A string array of contact or lead IDs related to this task. This JunctionIdList field is
linked to the TaskWhoRelations child relationship. TaskWhoIds is only available
when the shared activities setting is enabled. The first contact or lead ID in the list becomes
the primary WhoId if you don’t specify a primary WhoId.
Warning: Adding a JunctionIdList field name to the fieldsToNull
property deletes all related junction records. This action can’t be undone.

Type

Type
picklist
Properties
Create, Filter, Nillable, Update
Description
The type of task, such as Call or Meeting.

WhatCount

Type
int
Properties
Filter, Group, Nillable, Sort
Description
Available to organizations that have Shared Activities enabled. Count of related TaskRelations
pertaining to WhatId. Count of the WhatId must be 1 or less.

WhatId

WhoCount

Type
int

1871

Standard Objects

Field

Task

Field Type
Properties
Filter, Group, Nillable, Sort
Description
Available to organizations that have Shared Activities enabled. Count of related TaskRelations
pertaining to WhoId.

WhoId

Usage
Recurring Tasks
• Recurring tasks are available in API version 16.0 and later.
• After a task is created, it can’t be changed from recurring to nonrecurring or vice versa.
• When you delete a recurring task series through the API, all open and closed task occurrences in the series are removed. However,
when you delete a recurring task series through the user interface, only open tasks occurrences (IsClosed is false) in the
series are removed.
• If IsRecurrence is true, then RecurrenceStartDateOnly, RecurrenceEndDateOnly, RecurrenceType,
and any properties associated with the given recurrence type (see the following table) must be populated.
• When you change the RecurrenceStartDateOnly field or the recurrence pattern, all open tasks occurrences in the series
are deleted and new open task occurrences are created based on the new recurrence pattern. The recurrence pattern is determined
by the following fields: RecurrenceType, RecurrenceTimeZoneSidKey, RecurrenceInterval,
RecurrenceDayOfWeekMask, RecurrenceDayOfMonth, RecurrenceInstance, and
RecurrenceMonthOfYear.
• When you change the value of RecurrenceEndDateOnly to an earlier date (for example, from January 20th to January 10th),
all open task occurrences in the series with the ActivityDate value greater than the new end date value are deleted. Other
open and closed task occurrences in the series are not affected.
• When you change the value of RecurrenceEndDateOnly to a later date (for example, from January 10th to January 20th),
new task occurrences are created up to the new end date. Existing open and closed tasks in the series are not affected.
The following table describes the usage of recurrence fields. Each recurrence type must have all of its properties set. All unused properties
must be set to null.

1872

Standard Objects

Task

RecurrenceType Value

Properties

Example Pattern

RecursDaily

RecurrenceInterval

Every second day

RecursEveryWeekday

RecurrenceDayOfWeekMask

Every weekday - can’t be Saturday or Sunday

RecursMonthly

RecurrenceDayOfMonth
RecurrenceInterval

Every second month, on the third day of the month

RecursMonthlyNth

RecurrenceInterval RecurrenceInstance Every second month, on the last Friday of the month
RecurrenceDayOfWeekMask

RecursWeekly

RecurrenceInterval
RecurrenceDayOfWeekMask

Every three weeks on Wednesday and Friday

RecursYearly

RecurrenceDayOfMonth
RecurrenceMonthOfYear

Every March on the twenty-sixth day of the month

RecursYearlyNth

RecurrenceDayOfWeekMask
The first Saturday in every October
RecurrenceInstanceRecurrenceMonthOfYear

JunctionIdList
The JunctionIdList field is now implemented in the Event and Task objects. With a single API call, it’s easy to create
many-to-many relationships between the Event or Task object with contacts, leads, or users.
To create a Task with related Contacts without JunctionIdList, you first have to create the task, then use the returned task
ID to create the TaskRelation records. If the TaskRelation save call fails, error handling is your responsibility because the
task has already been committed to the database.
public void createTasksOld(Contact[] contacts) {
Task task = new Task();
task.setSubject("New Task");
SaveResult[] results = null;
try {
results = connection.create(new Task[] {
task
});
if (results[0].isSuccess()) {
TaskRelation[] relations = new TaskRelation[contacts.size()];
for (int i = 0; i < contacts.length; i++) {
relations[i] = new TaskRelation();
relations[i].setTaskId(results[0].getID());
relations[i].setRelationId(contacts[i].getID());
}
results = connection.create(relations);
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}

1873

Standard Objects

TaskFeed

To create a task using JuncionIdList, IDs are pulled from the related contacts and both the task and the TaskRelation
records are created in one API call. If the TaskRelation fails, the task is rolled back because it’s all done in a single API call.
public void createTaskNew(Contact[] contacts) {
String[] contactIds = new String[contacts.size()];
for (int i = 0; i < contacts.size(); i++) {
contactIds[i] = contacts[i].getID();
}
Task task = new Task();
task.setSubject("New Task");
task.setTaskWhoIds(contactIds);
SaveResult[] results = null;
try {
results = connection.create(new Task[] {
task
});
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}

SOAP API Developer Guide

Activate Session Permission Set

Session Permission Set is already active.

Navigation menu

Versions of this User Manual:

Views

Navigation