Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ExternalDataSource

Represents an external data source, such as SharePoint®.

Supported Calls

describeSObjects(), query(), retrieve()

Fields

Field Name Details
ApiKey
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The organization-specific client key required by some external data systems.
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 organization. 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.
Endpoint
Type
textarea
Properties
Nillable
Description
The root endpoint URL of the external data source.
Language
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The language of the MasterLabel.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Master label for the external data source. This display value is the internal label that does not get translated.
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.
PrincipalType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Used to track users accessing the external server. Anonymous implies a user identity is not specified for external server access. Named Principal uses one user identity for all users to access the external server.
Repository
Type
string
Properties
Filter, Group, Nillable, Sort
Description
An optional name of the repository in the data source. Not applicable to all data source types.
Type
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
File type of the source document.

Usage

External data sources connect with data sources outside Salesforce, such as SharePoint®. Selected tables in an external data source map to external objects, which function much like custom objects in Salesforce.