afv-library/skills/platform-metadata-api-context-get/data/metadata_api/DataConnectorIngestApi.json

41 lines
1.5 KiB
JSON

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"declarative_metadata_sample_definition"
],
"title": "DataConnectorIngestApi - Metadata API",
"description": "Represents the connection information specific to Ingestion API.",
"file_information": ".dataConnectorIngestApi",
"directory_location": "dataConnectorIngestApis",
"fields_columns": [
"type",
"required",
"description"
],
"fields": {
"masterLabel": {
"type": "string",
"required": true,
"description": "UI label of the Ingestion API Connector."
},
"sourceName": {
"type": "string",
"required": true,
"description": "Name of the Ingestion API Connector."
}
},
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a DataConnectorIngestApi component.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<DataConnectorIngestApi xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <sourceName>CONNECTOR NAME</sourceName>\n <masterLabel>CONNECTOR NAME</masterLabel>\n</DataConnectorIngestApi>"
},
{
"description": "The following is an example package.xml that references the previous definition.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<DataConnectorIngestApi xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <sourceName>MyConnector</sourceName>\n <masterLabel>MyConnector</masterLabel>\n</DataConnectorIngestApi>"
}
]
}