IntegrationProviderDef
Parent Type
File Suffix and Directory Location
IntegrationProviderDef components have the suffix .integrationProviderDefinition and are stored in the .integrationProviderDefinition folder.
Version
IntegrationProviderDef components are available in API version 57.0 and later.
Special Access Rules
Access to the IntegrationProviderDef type requires the AccessToServiceProcess permission.
Fields
Field Name | Description |
---|---|
active |
|
apexClass |
|
description |
|
developerName |
|
externalServiceOperationName |
|
externalServiceRegistration |
|
fileBasedApexClass |
|
inputDataProcessor |
|
integrationProviderAttributes |
|
outputDataProcessor |
|
providerLabel |
|
type |
|
IntegrationProviderAttr
A custom attribute that stores data associated with an Integration Definition.
Field Name | Description |
---|---|
dataType |
|
dateTimeValue |
|
dateValue |
|
description |
|
developerName |
|
doubleValue |
|
integerValue |
|
label |
|
percentageValue |
|
required |
|
stringValue |
|
trueOrFalseValue |
|
Declarative Metadata Sample Definition
The following is an example of an IntegrationProviderDef component.
<?xml version="1.0" encoding="UTF-8"?>
<IntegrationProviderDef xmlns="http://soap.sforce.com/2006/04/metadata">
<developerName>EmailUpdate</developerName>
<providerLabel>EmailUpdate</providerLabel>
<type>Apex</type>
<apexClass>SendEmailUpdate</apexClass>
<integrationProviderAttributes>
<developerName>EmailAddress</developerName>
<label>EmailAddress</label>
<dataType>String</dataType>
<stringValue>person@example.com</stringValue>
<required>true</required>
</integrationProviderAttributes>
</IntegrationProviderDef>
The following is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>IntegrationProviderDef</name>
</types>
<version>57.0</version>
</Package>
Wildcard Support in the Manifest File
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.