ExternalServiceRegistration

Represents the external service configuration for an org.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Version 

Introduced in API version 38.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

CatalogedApiVersionId 

• Type: ID
• Required: No
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 63.0

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The description for the external service, defined when the service is created.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The developer’s internal name for the external data source used 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.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 58.0

• Description: The internal name of the object. White spaces and special characters are escaped for validity. The name must:

• Contain characters, letters, or the underscore (_) character

• Must start with a letter

• Can’t end with an underscore

• Can’t contain two consecutive underscore characters.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Language 

• Type: picklist

• Required: No

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

• Description: The language of the external service configuration.

• 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 Spanish (Mexico) defaults to Spanish for customer-defined translations.

• Swedish: sv

• Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English.

• 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: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Label for the external service.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 58.0

• Description: External Service Registration metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamedCredential 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The name reference of the named credential to be used for the service.

NamedCredentialReferenceId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 52.0

• Description: The name reference of the named credential to be used for the service. References NamedCredential.

• Relationship name: NamedCredentialReference

• Relationship type: relationship

• Refers to: NamedCredential

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the package of which the external service is a part.

ProviderAssetEndpoint 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 57.0

• Description: Location or ID of the latest schema or metadata at an external site. Currently applies only to MuleSoft assets.

RegistrationProvider 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 61.0

• Description: A reference to the registration provider.

• If the registrationProviderType is ExternalConnector, this field contains the external connector name.

• If the registrationProviderType is Heroku, this field contains the HerokuAppLink ID.

• For any other registrationProviderType value, this field is blank and reserved for future use.

RegistrationProviderAssetId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 66.0

• Relationship name: RegistrationProviderAsset

• Relationship type: polymorphic

• Refers to: ApexClass, IntegArtifactConnector, ApiNamedQuery

RegistrationProviderType 

• Type: picklist

• Required: No

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

• Introduced: API version 52.0

• Description: The type of schema provider used to create this external service. Valid values are:

• AgentActionOutputs

• AgentToAgent

• Anypoint

• AnypointPublic

• ApexRest

• AuraEnabled

• CodeExtension

• Commerce

• ContextDef

• Custom

• CustomExternalConnector

• DocumentProcessing

• ExternalConnector

• Heroku

• MuleSoft

• NamedQuery

• SchemaInferred

• Standard

For API version 56.0 and later.

• Possible values:

  • MuleSoft — MuleSoft

  • Custom — Custom

  • SchemaInferred — SchemaInferred

  • Standard — Standard

  • ExternalConnector — ExternalConnector

  • CustomExternalConnector — CustomExternalConnector

  • Heroku — Heroku

  • Anypoint — Anypoint

  • ApexRest — ApexRest

  • AgentActionOutputs — AgentActionOutputs

  • IntegProcd — IntegProcd

  • DocumentProcessing — DocumentProcessing

  • NamedQuery — NamedQuery

  • ModelContextProtocol — ModelContextProtocol

  • AuraEnabled — AuraEnabled

  • ContextDef — ContextDef

  • AgentToAgent — AgentToAgent

  • AnypointPublic — AnypointPublic

  • CodeExtension — CodeExtension

  • Commerce — Commerce

Schema 

• Type: textarea

• Required: No

• Properties: Nillable

• Description: The content of the OpenAPI 2.0 or OpenAPI 3.0 schema in JSON or YAML format.

SchemaAbsoluteUrl 

• Type: url

• Required: No

• Properties: Filter, Nillable, Sort

• Introduced: API version 56.0

• Description: The full, absolute URL to the schema. For API version 56.0 and later, populated when a user selects Absolute URL during registration.

SchemaType 

• Type: picklist

• Required: No

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

• Description: ID format of the schema. For API version 48.0 and later, the valid value is OpenApi.

For API version 47.0 and earlier, the valid values are InteragentHyperSchema and OpenApi.

• Possible values:

  • OpenApi — OpenApi

  • OpenApi3 — OpenApi3

  • InterpretedConnectivity — InterpretedConnectivity

  • JsonSchema — JsonSchema

  • ModelContextProtocol — ModelContextProtocol

  • AgentToAgent — AgentToAgent

SchemaUploadFileExtension 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 56.0

• Description: The file’s extension. For API version 56.0 and later, populated when a user selects Upload from local during registration.

SchemaUploadFileName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 56.0

• Description: The file’s name without the file extension. For API version 56.0 and later, populated when a user selects Upload from local during registration.

SchemaUrl 

• Type: url

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The schema’s URL defined when registering a service. The path must begin with “/” and be a relative path.

ServiceBinding 

• Type: textarea

• Required: No

• Properties: Nillable

• Introduced: API version 54.0

• Description: Maps non-supported media types for this external service registration to supported media types. For API version 53.0 and later.

ServiceDescriptor 

• Type: textarea
• Required: No
• Properties: Nillable
• Introduced: API version 59.0

ServiceName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 63.0

• Description: The name of the cataloged API service that this external service registration belongs to. This field was removed in API version 65.0.

Status 

• Type: picklist

• Required: No

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

• Description: Indicates whether the service registration is finished. Valid values are complete and incomplete.

• Possible values:

  • Incomplete — Incomplete

  • Complete — Complete

SystemVersion 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Identifies the external service registration revision. For valid values, see ExternalServiceRegistation in the Metadata API Developer Guide.