ExternalServiceRegistration

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

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

Supported SOAP Calls

create(), delete(), query(), retrieve(),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` 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.
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` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
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 name 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 OpenAPI 2.0 format.
SchemaAbsoluteUrl	Type url Properties Create, Filter, Nillable, Sort, Update 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 Properties Create, Filter, Group, Nillable, RestrictedPicklist, Sort, Update 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`. Note
SchemaUploadFileExtension	Type string Properties Create, Filter, Group, Nillable, Sort, Update 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 Properties Create, Filter, Group, Nillable, Sort, Update 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 Properties Create, Filter, Group, Nillable, Sort, Update Description The schema URL defined when registering a service. The path must 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`.
SystemVersion	Type integer Properties Create, Filter, Group, Nillable, Sort, Update Description Identifies the external service registration revision. Valid values are `1` for the deprecated external service revision for API version 48.0 and earlier and `2` for the enhanced external service revision available in API version 48.0 and later. The default is `2`.

Tooling API

ExternalServiceRegistration

Supported SOAP Calls

Supported REST HTTP Methods

Fields