ExternalDocStorageConfig

Represents a collection of fields to configure the external document storage for an object. It includes details such as location, path, and named credentials. For example, OneDrive is defined as an External Document Storage and is associated with the Salesforce Contract object.

Supported Calls

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

Fields

DocumentPath

Type: textarea

Properties: Create, Update

Description: Specifies the path from the root in the external storage where documents are stored.

ExternalDocStorageIdentifier

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: Specifies the ID of the external document storage.

NamedCredentialId

Type: reference

Properties: Create, Filter, Group, Sort, Update

Description: The Named Credential associated with the External Document Storage Configuration. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts.

This field is a relationship field.

Relationship Name: NamedCredential

Relationship Type: Lookup

Refers To: NamedCredential

RecordTypeId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Record Type associated with the Reference Object.

This field is a relationship field.

Relationship Name: RecordType

Relationship Type: Lookup

Refers To: RecordType

StorageDriveType

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

Description: Specifies the external document storage drive. For example, Microsoft OneDrive.

Possible values are MicrosoftOneDrive—Microsoft OneDrive

The default value is MicrosoftOneDrive.

TargetObject

Type: picklist

Properties: Create, Filter, Group, Restricted picklist, Sort, Update

Description: Specifies the object associated with the external document storage. For example, Document Template, Contract, All.

Possible values are All, Contract, or DocumentTemplate—Document Template

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ExternalDocStorageConfigChangeEvent: Change events are available for the object.

ExternalDocStorageConfigFeed: Feed tracking is available for the object.

ExternalDocStorageConfigHistory: History is available for tracked fields of the object.

ExternalDocStorageConfigOwnerSharingRule: Sharing rules are available for the object.

ExternalDocStorageConfigShare: Sharing is available for the object.