| Description |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The description for the external service, defined when
the service is created.
|
| DeveloperName |
- Type
- string
- Properties
- Create, 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.
|
| 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
- Filter, Group, Nillable, Sort
- Description
- The name reference of the named credential to be used
for the service.
|
| NamedCredentialReferenceId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The name reference of the named credential to be used
for the service. References
NamedCredential. Available in
API version 52.0 and later.
- Relationship Name
- NamedCredentialReference
- Relationship Type
- Lookup
- Refers To
- NamedCredential
|
| NamespacePrefix |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The namespace of the package of which the external
service is a part.
|
| ProviderAssetEndpoint |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Location or ID of the latest schema or metadata at an
external site. Currently applies only to MuleSoft
assets. Available in API version 57.0 and later.
|
| RegistrationProvider |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- 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.
|
| RegistrationProviderAsset |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- A polymorphic foreign key field that contains the name
of the asset related to the external service registration.
- For an external service registration created for
a named query, this field contains the named query
API name.
- For an external service registration created for
an Apex class that has methods exposed as REST
resources or methods that are aura-enabled, this
field contains the Apex class name.
Available in API version 66.0 and later.
|
| RegistrationProviderType |
- Type
- string
- Properties
- Filter, Group, Nillable,
Restricted
picklist,
Sort
- Description
- The type of schema provider used to create this external
service. Valid values are:
- AgentActionOutputs
- AgentToAgent
- Anypoint
- AnypointPublic
- ApexRest
- AuraEnabled
- CodeExtension
- ContextDef
- Custom
- CustomExternalConnector
- DocumentProcessing
- ExternalConnector
- Heroku
- MuleSoft
- NamedQuery
- SchemaInferred
- Standard
For API version 56.0 and later.
|
| Schema |
- Type
- textarea
- Properties
- Create, Nillable, Update
- Description
- The content of the OpenAPI 2.0 or OpenAPI 3.0 schema in
JSON or YAML 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.
|
| 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's URL defined when registering a service. The
path must begin with “/” and be a relative path.
|
| ServiceBinding |
- Type
- string
- Properties
- Nillable
- Description
- Maps non-supported media types for this external service
registration to supported media types. For API version
53.0 and later.
|
| ServiceName |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The name of the cataloged API service that this external
service registration belongs to. Available in API
version 63.0 and later. This field was removed in API
version 65.0.
|
| 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.
For valid values, see ExternalServiceRegistation in the Metadata
API Developer Guide.
|
j