Skip Navigation

Newer Version Available

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

ExternalServiceRegistration

Represents the External Service configuration for an org. Available in API version 39.0 and later.

Supported SOAP Calls

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

Supported REST HTTP Methods

GET, PUT, POST, and DELETE

Fields

Field	Details
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The external service description defined when the service is created.
Language	Type string Properties Create, DefaultedOnCreate, Filter, Group, Nillable, RestrictedPicklist, Sort, Update 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` Swedish: `sv` Thai: `th`
ManageableState	Type ManageableState enumerated list 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` `installed` `released` `unmanaged` For more information about states of manageability for components in Salesforce AppExchange packages, see “Planning the Release of Managed Packages” in the Salesforce online help.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description Label for the External Service.
NamedCredential	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reference of the named credential to be used for the service.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace of the package of which the External Service is a part.
Schema	Type textarea Properties Create, Nillable, Update Description The content of the JSON schema in the Interagent format.
SchemaType	Type picklist Properties Create, Filter, Group, Nillable, RestrictedPicklist, Sort, Update Description ID format of the schema. Valid values are `InteragentHyperSchema` and `OpenApi`.
SchemaUrl	Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The schema URL defined when registering a service. The path should begin with “/” and be a relative path.
Status	Type picklist Properties Filter, Group, Nillable, RestrictedPicklist, Sort Description Indicates whether the service registration is finished. Valid values are `complete` and `incomplete`.