afv-library/skills/getting-metadata-api-context/data/metadata_api/OmniInteractionAccessConfig.json

91 lines
3.9 KiB
JSON

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"declarative_metadata_sample_definition"
],
"title": "# OmniInteractionAccessConfig - Metadata API",
"description": "## Description\n\nRepresents configuration settings for access to Omnistudio FlexCard caching and data sources.",
"file_information": "## File Information\n\n- **File Suffix**: `.omniInteractionAccessConfig`\n",
"directory_location": "## Directory Location\n\n- **Directory Location**: `OmniInteractionAccessConfig`\n",
"fields_columns": [
"type",
"required",
"description"
],
"fields": {
"configName": {
"type": "string",
"description": "Not used."
},
"isAsyncCardCachingEnabled": {
"type": "boolean",
"required": true,
"description": "If set to true, enables asynchronous FlexCard caching. The default is false."
},
"isCardApexRemoteDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables remote Apex method calls for FlexCards. The default is false."
},
"isCardCacheDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables FlexCard caching. The default is false."
},
"isCardDataTfrmDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables Data Mapper data sources for FlexCards. The default is false."
},
"isCardIntegrationProcDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables Integration Procedure data sources for FlexCards. The default is false."
},
"isCardRestApiDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables REST calls for FlexCards. The default is false."
},
"isCardSoqlDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables SOQL queries for FlexCards. The default is false."
},
"isCardSoslDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables SOSL queries for FlexCards. The default is false."
},
"isCardStreamingApiDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables Streaming API calls for FlexCards. The default is false."
},
"isDataTfrmEncrpFieldsDisabled": {
"type": "boolean",
"required": true,
"description": "If set to true, disables Data Mapper field encryption for FlexCards. The default is false."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "The name of the setting. The value is Profile_ProfileId, User_UserId, or Org_Wide."
},
"setupOwner": {
"type": "string",
"description": "The ID of the profile, user, or org to which the settings apply."
}
},
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of an OmniInteractionAccessConfig component.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OmniInteractionAccessConfig xmlns=\"http://soap.sforce.com/2021/10/metadata\">\n <isAsyncCardCachingEnabled>false</isAsyncCardCachingEnabled>\n <isCardApexRemoteDisabled>false</isCardApexRemoteDisabled>\n <isCardCacheDisabled>false</isCardCacheDisabled>\n <isCardDataTfrmDisabled>false</isCardDataTfrmDisabled>\n <isCardIntegrationProcDisabled>false</isCardIntegrationProcDisabled>\n <isCardRestApiDisabled>false</isCardRestApiDisabled>\n <isCardSoqlDisabled>false</isCardSoqlDisabled>\n <isCardSoslDisabled>false</isCardSoslDisabled>\n <isCardStreamingApiDisabled>false</isCardStreamingApiDisabled>\n <isDataTfrmEncrpFieldsDisabled>false</isDataTfrmEncrpFieldsDisabled>\n <masterLabel>Profile_00eB0000000ijOH</masterLabel>\n <setupOwner>00eB0000000ijOH</setupOwner>\n</OmniInteractionAccessConfig>"
}
]
}