DataConnectorIngestApi

Represents the connection information specific to Ingestion API.

This type extends Metadata and inherits its fields.

DataConnectorIngestApi components have the suffix .dataConnectorIngestApi and are stored in the dataConnectorIngestApis folder.

Introduced in API version 54.0.

You must have the CustomizeApplication user permissions to access the DataConnectorIngestApi type.

• Type: string
• Required: No

• Type: boolean
• Required: No
• Description: Indicates whether this component is protected (true) or unprotected (false). Protected components in a managed package can’t be referenced by subscriber org customizations.

• Type: string

• Required: Yes

• Description: Required.

  UI label of the Ingestion API Connector.

• Type: string

• Required: Yes

• Description: Required.

  Name of the Ingestion API Connector.

The following is an example of a DataConnectorIngestApi component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DataConnectorIngestApi xmlns="http://soap.sforce.com/2006/04/metadata">
3    <sourceName>CONNECTOR NAME</sourceName>
4    <masterLabel>CONNECTOR NAME</masterLabel>
5</DataConnectorIngestApi>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<DataConnectorIngestApi xmlns="http://soap.sforce.com/2006/04/metadata">
3    <sourceName>MyConnector</sourceName>
4    <masterLabel>MyConnector</masterLabel>
5</DataConnectorIngestApi>

This metadata type doesn’t support 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.