ExternalDataSrcDescriptor

Contains the metadata information for the external schema of an external data source. Use the metadata to map attributes from an AWS data source, such as Amazon DynamoDB and Amazon Athena, to Salesforce external object fields. Also, use the metadata to customize the data retrieval queries to an AWS data source.

Version 

Introduced in API version 55.0.

This object is available in API version 55.0 and later for Amazon DynamoDB and in API version 56.0 and later for Amazon Athena.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

CustomObjectId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: If set, the ID of the external object associated with the descriptor.

This is a relationship field.

• Relationship name: CustomObject
• Relationship type: relationship
• Refers to: CustomEntityDefinition

Descriptor 

• Type: base64

• Required: No

• Properties: Nillable

• Description: The descriptor document that contains the metadata information.

DescriptorVersion 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: If the external system supports schema versioning for the data source, the optional descriptor document version tracks the external system’s schema version. Several descriptors with different document versions may be active.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name of the child-level setup entity.

ExternalDataSourceId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: Salesforce ID of the external data source that defines the external system.

This is a relationship field.

• Relationship name: ExternalDataSource
• Relationship type: relationship
• Refers to: ExternalDataSource

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 55.0

• Description: The full name of the associated type in Tooling API.

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the descriptor document.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: The manageable state of the descriptor that is contained in a package.

• Possible values:

  • beta — beta — Managed-Beta

  • deleted — deleted — Managed-Proposed-Deleted

  • deprecated — deprecated — Managed-Proposed-Deprecated

  • deprecatedEditable — deprecatedEditable — SecondGen-Installed-Deprecated

  • installed — installed — Managed-Installed

  • installedEditable — installedEditable — SecondGen-Installed-Editable

  • released — released — Managed-Released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Label for the External Data Source Descriptor. In the UI, this field is MasterLabel.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 55.0

• Description: The external data source descriptor’s metadata.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix that is associated with this object.

Subtype 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The subtype of the descriptor.

• Possible values:

  • SchemaTableQualifiers — SchemaTableQualifiers — Used to customize the data retrieval query to the external system.

  • SchemaTableMetadata — SchemaTableMetadata — Used to cache information about the external system.

  • SchemaTableDDL — SchemaTableDDL — Used to store the metadata for the external data source.

SystemVersion 

• Type: int

• Required: No

• Properties: Filter, Group, Sort

• Description: The version that defines the descriptor format and allows compatibility with descriptor formats between Salesforce releases.

Type 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The type of the descriptor.

Possible value:

• Possible values:

  • Schema — Schema