RegisteredExternalService
Parent Type
This type extends the Metadata metadata type and inherits its fullName field.
File Suffix and Directory Location
RegisteredExternalService components have the suffix .registeredExternalService and are stored in the registeredExternalServices folder.
Version
RegisteredExternalService components are available in API version 49.0 and later.
Special Access Rules
This metadata type is available only if the B2B Commerce or D2C Commerce license is enabled.
Fields
Field Name | Description |
---|---|
configUrl |
|
description |
|
documentationUrl |
|
extensionPointName |
|
externalServiceProvider |
|
externalServiceProviderType |
|
iconUri |
|
isApplication |
|
isProtected |
|
masterLabel |
|
Declarative Metadata Sample Definition
The following is an example of a RegisteredExternalService component.
<?xml version="1.0" encoding="UTF-8"?>
<RegisteredExternalService xmlns="http://soap.sforce.com/2006/04/metadata">
<externalServiceProvider>TaxSample</externalServiceProvider>
<externalServiceProviderType>Tax</externalServiceProviderType>
<documentationUrl>http://sample.com/doc</documentationUrl>
<configUrl>http://sample.com/config</configUrl>
<masterLabel>TaxService</masterLabel>
<isProtected>false</isProtected>
</RegisteredExternalService>
The following is an example package.xml that references the previous definition.
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>TaxSample</members>
<name>ApexClass</name>
</types>
<types>
<members>TaxService</members>
<name>RegisteredExternalService</name>
</types>
<version>60.0</version>
</Package>