{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "CMSConnectSource - Metadata API",
"description": "Represents the connection information for external content management systems that feed content to Experience Builder sites. This type extends the Metadata metadata type and inherits its fullName field.",
"file_information": ".cmsConnectSource",
"directory_location": "cmsConnectSource",
"fields_columns": [
"type",
"description"
],
"fields": {
"cmsConnectAsset": {
"type": "CMSConnectAsset[]",
"description": "Represents CSS or JavaScript defined for the connection. 0–10 for CSS 0–10 for JavaScript"
},
"cmsConnectLanguage": {
"type": "CMSConnectLanguage[]",
"description": "0 to more. Represents language mappings defined for the connection."
},
"cmsConnectPersonalization": {
"type": "CMSConnectPersonalization[]",
"description": "0 or 1. Represents personalization defined for the connection. Only for use when type is AEM."
},
"cmsConnectResourceType": {
"type": "CMSConnectResourceType[]",
"description": "0–5. Represents JSON definitions defined for the connection."
},
"connectionType": {
"type": "CMSSourceConnectionType(enumeration of type string)",
"description": "Type of authentication being used with outside system. Valid values are: Public Authenticated",
"required": true
},
"cssScope": {
"type": "string",
"description": "The class name used to prefix and scope the CSS rules."
},
"developerName": {
"type": "string",
"description": "API name of the CMSConnectSource entity.",
"required": true
},
"languageEnabled": {
"type": "string",
"description": "Valid values are: Y to enable language mapping for connection. N if no language mapping is needed.",
"required": true
},
"masterLabel": {
"type": "string",
"description": "Connection name",
"required": true
},
"namedCredential": {
"type": "string",
"description": "Required when the connectionType is Authenticated. API name of namedCredential. Before deploying namedCredential, it must exist on the destination org.",
"required": true
},
"personalizationEnabled": {
"type": "string",
"description": "Valid values are: Y to enable personalization mapping for connection. Otherwise N.",
"required": true
},
"rootPath": {
"type": "string",
"description": "Root path.",
"required": true
},
"sortOrder": {
"type": "int",
"description": "Defines the load order of the connection when multiple connections defined on page. The load order begins with 1.",
"required": true
},
"status": {
"type": "CMSConnectionStatus(enumeration of type string)",
"description": "Status of connection. Valid values are: ACTIVE INACTIVE",
"required": true
},
"type": {
"type": "CMSConnectionSourceType(enumeration of type string)",
"description": "The identification of the source connection system. Valid values are: AEM Drupal WordPress SDL Sitecore Other",
"required": true
},
"websiteUrl": {
"type": "string",
"description": "Required if connectionType is Public",
"required": true
}
},
"sub_types": {
"CMSConnectAsset": {
"assetPath": {
"type": "string",
"description": "Relative path of the asset."
},
"assetType": {
"type": "string",
"description": "When used in Apex, this value can be sent as an enum, otherwise, this field has a type of string. Allowed values as string CSS Javascript Allowed values as enum CSS Javascript"
},
"sortOrder": {
"type": "int",
"description": "Loading sequence on the page."
}
},
"CMSConnectLanguage": {
"cmsLanguage": {
"type": "string",
"description": "When a language placeholder is in the URL path, this value is used to replace it."
},
"language": {
"type": "string",
"description": "Salesforce supported language. For information see https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm"
}
},
"CMSConnectPersonalization": {
"connectorPage": {
"type": "string",
"description": "The path to the JSP file that you created and installed in AEM."
},
"connectorPageAsset": {
"type": "string",
"description": "The path to your Javascript file. Providing this path allows you to run scripts dynamically."
}
},
"CMSConnectResourceType": {
"cmsConnectResourceDefinition": {
"type": "cmsConnectResourceDefinition[]",
"description": "0–10 allowed per CMSConnectResourceType."
},
"developerName": {
"type": "string",
"description": "API name of CMSConnectResourceType."
},
"masterLabel": {
"type": "string",
"description": "Content type name."
},
"resourceType": {
"type": "string",
"description": "The only allowed value is JSON."
}
},
"CMSConnectResourceDefinition": {
"developerName": {
"type": "string",
"description": "API name of CMSConnectResourceDefinition.",
"required": true
},
"masterLabel": {
"type": "string",
"description": "developerName of Content Item or Content List.",
"required": true
},
"options": {
"type": "int",
"description": "Identifies whether the content from the external source is a single item or a list. 0 for Content List 1 for Content Item",
"required": true
},
"payloadType": {
"type": "string",
"description": "The only valid value is JSON.",
"required": true
},
"resourceIdPath": {
"type": "string",
"description": "Relative path to ID. Required for Content Item."
},
"resourceNamePath": {
"type": "string",
"description": "Relative path to resource name. Required for Content Item."
},
"resourcePath": {
"type": "string",
"description": "JSON resource path.",
"required": true
},
"rootNodePath": {
"type": "string",
"description": "Only for Content List and collection. Defines the initial starting path for a collection or list."
}
}
},
"wsdl_segment": "```xml\n\n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a CMSConnectSource definition.",
"code": "\n\n \n etc/designs/capricorn/app-prefixed.min.css\n CSS\n 1\n \n \n etc/designs/capricorn/w3data.js\n Javascript\n 1\n \n \n en\n en_US\n \n \n fr\n fr\n \n \n content/salesforceConnector.js\n content/js/capricorn/assets.js\n \n \n \n Details\n Details\n 0\n JSON\n ID\n title\n rest/v1.1/sites/cmstry.wordpress.com/posts/{component}\n \n \n List\n List\n 1\n JSON\n rest/v1.1/sites/cmstry.blog.wordpress.com/posts?number={itemsPerPage}&page={pageNumber}\n \n Posts\n Posts\n JSON\n \n Public\n capricorn\n Capricorn\n Y\n Capricorn\n Y\n content/capricorn/{language}\n 11\n ACTIVE\n AEM\n https://public-api.wordpress.com\n"
}
]
}