Platform Metadata Api Context Get

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountingFieldMapping - Metadata API",
  "description": "Represents the accounting field mappings to organize your data and bring it to ledger entry records.",
  "file_information": ".accountingFieldMapping",
  "directory_location": "accountingFieldMappings",
  "fields_columns": [
    "type",
    "required",
    "description",
    "reserved_for_internal_use"
  ],
  "fields": {
    "accountingModelConfig": {
      "type": "string",
      "required": true,
      "description": "Record ID of the AccountingModelConfig record that the Field Mapping is associated with."
    },
    "isForAllocationType": {
      "type": "boolean",
      "reserved_for_internal_use": true
    },
    "isForPaymentType": {
      "type": "boolean",
      "reserved_for_internal_use": true
    },
    "isForTransactionType": {
      "type": "boolean",
      "reserved_for_internal_use": true
    },
    "isProtected": {
      "type": "boolean",
      "description": "Indicates whether this component is protected (true) or not protected (false).Default value is false."
    },
    "mappingBehavior": {
      "type": "MappingBehaviorType (enumeration of type string)",
      "required": true,
      "description": "Specifies how the target’s field data is mapped from the source field only when the journal entry is created. When set to CurrentValue, Subledger reverses and replaces journal entries whose value differs from the value in sourceField.Valid values are: CurrentValue PointInTime"
    },
    "masterLabel": {
      "type": "string",
      "required": true,
      "description": "A user-friendly name for AccountingFieldMapping, which is defined when the AccountingFieldMapping is created."
    },
    "sourceField": {
      "type": "string",
      "description": "The API name of the field on the source object that is mapped to the target field."
    },
    "targetField": {
      "type": "string",
      "required": true,
      "description": "The API name of the field on the Transaction Journal record for this mapping."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"AccountingFieldMapping\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"accountingModelConfig\" type=\"xsd:string\"/>\n        <xsd:element name=\"isForAllocationType\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isForPaymentType\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isForTransactionType\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isProtected\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"mappingBehavior\" type=\"tns:MappingBehaviorType\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"sourceField\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"targetField\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"MappingBehaviorType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"PointInTime\"/>\n    <xsd:enumeration value=\"CurrentValue\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an AccountingFieldMapping component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountingFieldMapping xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<accountingModelConfig>ModelConfigOne</accountingModelConfig>\n\t<fullName>FieldMappingOne</fullName>\n\t<masterLabel>FieldMappingOne</masterLabel>\n\t<isForAllocationType>true</isForAllocationType>\n\t<isForPaymentType>true</isForPaymentType>\n\t<isForTransactionType>true</isForTransactionType>\n\t<mappingBehavior>PointInTime</mappingBehavior>\n\t<sourceField>TransactionJournal.MappingTargetOne__c</sourceField>\n\t<targetField>MappingTargetOne__c</targetField>\n\t<isProtected>false</isProtected>\n</AccountingFieldMapping>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountingModelConfig - Metadata API",
  "description": "Represents the mapping of the financial data model to a logical data model and configuration for the generation of Transaction Journal records.",
  "file_information": ".accountingModelConfig",
  "directory_location": "accountingModelConfigs",
  "fields_columns": [
    "type",
    "required",
    "description",
    "reserved_for_internal_use"
  ],
  "fields": {
    "accountingType": {
      "type": "AccountingType (enumeration of type string)",
      "required": true,
      "description": "Determines whether the accounting set generates revenue or expense type transaction journal records.Valid values are: Expense Revenue"
    },
    "defaultAccrualAccountCode": {
      "type": "string",
      "description": "The code for your accounting system's default accrual account."
    },
    "defaultWriteOffAccountCode": {
      "type": "string",
      "description": "Represents the name of your account for written off payments."
    },
    "earliestCreatedDate": {
      "type": "dateTime",
      "required": true,
      "description": "The date used to filter source records for processing. The Accounting Subledger only considers records created on or after this date."
    },
    "expectedCashFlowGrouping": {
      "type": "ExpectedCashFlowGrouping (enumeration of type string)",
      "description": "Determines whether Accounting Subledger groups transaction journal records by fund account or by a combination of fund account and due date. Note: Changing this setting doesn't impact existing records; it only affects records created or reversed afterward. Valid values are: GroupByFundAccount GroupByFundAndDueDate"
    },
    "financeBook": {
      "type": "string",
      "reserved_for_internal_use": true
    },
    "internalMappingDetails": {
      "type": "string",
      "required": true,
      "description": "Represents the structure of your financial data in JSON format."
    },
    "isActive": {
      "type": "boolean",
      "required": true,
      "description": "Indicates whether only records that are true are processed when the Subledger Job runs."
    },
    "isGroupedByFundAccount": {
      "type": "boolean",
      "reserved_for_internal_use": true
    },
    "isUsed": {
      "type": "boolean",
      "required": true,
      "description": "Indicates whether the Accounting Model has been used or activated at least once (true) or not (false). Note: If the value is set to true, you can’t select another object for the object model or change the number of objects associated with that Accounting Model."
    },
    "jobFilterCriteria": {
      "type": "string",
      "reserved_for_internal_use": true
    },
    "masterLabel": {
      "type": "string",
      "required": true,
      "description": "A user-friendly name for AccountingModelConfig, which is defined when the AccountingModelConfig is created."
    },
    "paidCashFlowGrouping": {
      "type": "PaidCashFlowGrouping (enumeration of type string)",
      "description": "Determines the level of detail for generated transaction journal records.Valid values are: GroupByFundAccount—Accounting Subledger splits all transaction journal records into fund accounts. Secondary records are created for payment type records but not for transaction type records. GroupBySummary—Accounting Subledger only splits credits for revenue and debits for expenses by fund accounts."
    },
    "recordTypeFilter": {
      "type": "string",
      "description": "Specify the record type IDs from the primary object to be processed. This field is case-sensitive. Note: If no record type is specified in the filter, all records are processed."
    },
    "runOrder": {
      "type": "int",
      "description": "Determines the load order sequence of the multiple Accounting Model. The lower number runs first. For example, load order 1 runs before load order 2."
    }
  },
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an AccountingModelConfig component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountingModelConfig\n\txmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<fullName>ModelConfigOne</fullName>\n\t<masterLabel>ModelConfigOne</masterLabel>\n\t<defaultAccrualAccountCode>abc</defaultAccrualAccountCode>\n\t<defaultWriteOffAccountCode>abc</defaultWriteOffAccountCode>\n\t<isUsed>false</isUsed>\n\t<isActive>false</isActive>\n\t<runOrder>123</runOrder>\n\t<recordTypeFilter>abcabc</recordTypeFilter>\n\t<earliestCreatedDate>2021-12-01T00:00:00.000Z</earliestCreatedDate>\n\t<internalMappingDetails>abcabc</internalMappingDetails>\n\t<accountingType>Revenue</accountingType>\n\t<expectedCashFlowGrouping>GroupByFundAccount</expectedCashFlowGrouping>\n\t<paidCashFlowGrouping>GroupBySummary</paidCashFlowGrouping>\n</AccountingModelConfig>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountingSettings - Metadata API",
  "description": "Represents the settings for the Accounting Subledger feature.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description",
    "reserved_for_internal_use"
  ],
  "fields": {
    "enableAccountingSubledger": {
      "type": "boolean",
      "description": "Indicates whether Transaction Journal creation is enabled for the organization (true) or not (false)."
    },
    "enableAslDataCloud": {
      "type": "boolean",
      "description": "Requires Data Cloud and Accounting Subledger access. Indicates whether Data Cloud Runtime for Accounting Subledger feature is enabled for the organization (true) or not (false). This field is available in API version 66.0 and later."
    },
    "enableFinancePeriod": {
      "type": "boolean",
      "reserved_for_internal_use": true
    },
    "enablePaymentMethodAdjust": {
      "type": "boolean",
      "description": "Indicates whether changes to the Payment Method generate adjustments on Transaction Journal records (true) or not (false)."
    },
    "enableScheduledJob": {
      "type": "boolean",
      "reserved_for_internal_use": true
    },
    "enableSkipReversalLogicEnabled": {
      "type": "boolean",
      "description": "Indicates whether Skip Reversal Logic is enabled (true) or not (false)."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"AccountingSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"enableAccountingSubledger\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAslDataCloud\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableFinancePeriod\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePaymentMethodAdjust\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableScheduledJob\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableSkipReversalLogic\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an AccountingSettings component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountingSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<enableAccountingSubledger>true</enableAccountingSubledger>\n\t<enableAslDataCloud>true</enableAslDataCloud>\n\t<enablePaymentMethodAdjust>true</enablePaymentMethodAdjust>\n\t<enableSkipReversalLogicEnabled>false</enableSkipReversalLogicEnabled>\n</AccountingSettings>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountInsightsSettings - Metadata API",
  "description": "Represents an org’s Einstein Account Insights settings. This setting controls features that help your reps maintain their relationships with their customers.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "enableAccountInsights": {
      "type": "boolean",
      "description": "Indicates whether Einstein Account Insights is enabled (true) or not (false). The default value is false."
    }
  },
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of the AccountInsights.settings file:",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountInsightsSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<enableAccountInsights>true</enableAccountInsights>\n</AccountInsightsSettings>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountIntelligenceSettings - Metadata API",
  "description": "Represents an org’s Account Intelligence settings. These settings control features that make it easy for sales reps to create accounts, see relevant news articles, and add logos to account records. This type extends the Metadata metadata type and inherits its fullName field.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "enableAccountLogos": {
      "type": "boolean",
      "description": "Indicates whether your sales reps can see available company logos (true) or not (false). The logos are for US-based companies only. The default value is false. enableAutomatedAccountFields must be true to use this setting."
    },
    "enableAutomatedAccountFields": {
      "type": "boolean",
      "description": "Indicates whether Automated Account Fields is enabled (true) or not (false). The default value is false."
    },
    "enableNewsStories": {
      "type": "boolean",
      "description": "Indicates whether News is enabled (true) or not (false). The default value is false. enableAutomatedAccountFields must be true to use this setting."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"AccountIntelligenceSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"enableAccountLogos\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAutomatedAccountFields\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableNewsStories\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of the AccountIntelligence.settings file:",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountIntelligenceSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<enableAccountLogos>true</enableAccountLogos>\n\t<enableAutomatedAccountFields>true</enableAutomatedAccountFields>\n\t<enableNewsStories>true</enableNewsStories>\n</AccountIntelligenceSettings>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountPlanObjMeasCalcDef - Metadata API",
  "description": "Represents the metadata associated with an account plan objective measure calculation definition. An account plan objective measure calculation definition contains a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure.",
  "file_information": ".accountPlanObjMeasCalcDef",
  "directory_location": "accountPlanObjMeasCalcDefs",
  "fields_columns": [
    "type",
    "description",
    "required"
  ],
  "fields": {
    "conditions": {
      "type": "AccountPlanObjMeasCalcCond",
      "description": "The field and value combinations for filtering records to include in the calculation definition."
    },
    "description": {
      "type": "string",
      "description": "A summary of the calculation definition that’s visible to users when they select the definition for an account plan objective measure."
    },
    "developerName": {
      "type": "string",
      "required": true,
      "description": "The unique name of the object in the API. The name: must be 40 characters or fewer must begin with a letter can contain only underscores and alphanumeric characters can’t include spaces can’t end with an underscore can’t contain 2 consecutive underscores"
    },
    "masterLabel": {
      "type": "string",
      "required": true,
      "description": "Label for this calculation definition. This display value is the internal label that doesn't get translated."
    },
    "rollupType": {
      "type": "string",
      "required": true,
      "description": "The method for calculating the account plan objective measure’s current value from records that match the calculation definition and any optional conditions. Possible values are: Count Max Min Sum In Setup, this field’s label is Calculation Type."
    },
    "status": {
      "type": "string",
      "required": true,
      "description": "Specifies the status of the calculation definition. Possible values are: Active Draft Inactive Only active calculation definitions are available for users to select when they specify an account plan objective measure."
    },
    "targetField": {
      "type": "string",
      "description": "The field on TargetObject to use for calculating the account plan objective measure’s current value. Rollup fields on the Campaign, Case, Contact, or Opportunity object are supported. In Setup, this field’s label is Rollup Field."
    },
    "targetObject": {
      "type": "string",
      "required": true,
      "description": "The object to use for calculating the account plan objective measure’s current value. Possible values are: Campaign Case Contact Opportunity"
    }
  },
  "sub_types": {
    "AccountPlanObjMeasCalcCond": {
      "fieldName": {
        "type": "string",
        "required": true,
        "description": "A field on the calculation definition’s TargetObject that you want to filter by. Fields on the Campaign, Case, Contact, or Opportunity objects are supported."
      },
      "operation": {
        "type": "string",
        "required": true,
        "description": "The logical operator for matching records with the specified field value. Possible values are: Contains Equals GreaterOrEqual GreaterThan LessOrEqual LessThan NotContain NotEqual StartsWith"
      },
      "value": {
        "type": "string",
        "required": true,
        "description": "The value to match for the specified field."
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"AccountPlanObjMeasCalcCond\">\n  <xsd:sequence>\n    <xsd:element name=\"fieldName\" type=\"xsd:string\"/>\n    <xsd:element name=\"operation\" type=\"xsd:string\"/>\n    <xsd:element name=\"value\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"AccountPlanObjMeasCalcDef\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"conditions\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:AccountPlanObjMeasCalcCond\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"developerName\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"rollupType\" type=\"xsd:string\"/>\n        <xsd:element name=\"status\" type=\"xsd:string\"/>\n        <xsd:element name=\"targetField\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"targetObject\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an AccountPlanObjMeasCalcDef component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountPlanObjMeasCalcDef xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<conditions>\n\t\t<fieldName>StageName</fieldName>\n\t\t<operation>Equals</operation>\n\t\t<value>ClosedWon</value>\n\t</conditions>\n\t<description>Define sales revenue goals. Current Value will be \n\t\tauto-calculated as the sum of your selected Opportunities \n\t\tAmount with 'Closed Won' Stage.\n\t</description>\n\t<developerName>Opportunity_Revenue_Targets</developerName>\n\t<masterLabel>Opportunity Revenue Targets</masterLabel>\n\t<rollupType>Sum</rollupType>\n\t<status>Active</status>\n\t<targetField>Amount</targetField>\n\t<targetObject>Opportunity</targetObject>\n</AccountPlanObjMeasCalcDef>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountPlanSettings - Metadata API",
  "description": "Represents an org’s account plan settings. These settings control features that make it easy for sales reps to set objectives with actionable metrics and to store account research and analysis.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "enableAccountPlan": {
      "type": "boolean",
      "description": "Indicates whether Account Plans is enabled (true) or not (false). The default value is false."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"AccountPlanSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"enableAccountPlan\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an AccountPlanSettings component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountPlanSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<enableAccountPlan>true</enableAccountPlan>\n</AccountPlanSettings>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountRelationshipShareRule - Metadata API",
  "description": "The rule that determines which object records are shared, how they’re shared, the account relationship type that shares the records, and the level of access granted to the records.",
  "file_information": ".accountRelationshipShareRule",
  "directory_location": "accountRelationshipShareRules",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "accessLevel": {
      "type": "string",
      "description": "Type of access granted by the share rule. Valid values are: Read Edit"
    },
    "accountToCriteriaField": {
      "type": "string",
      "description": "Criteria that must be met for the data to be shared. Valid values include any custom or standard lookup to Account or User on top-level objects. To get the full list for your org, do a Describe on the ARSR entity."
    },
    "description": {
      "type": "string",
      "description": "A meaningful explanation of the sharing rule."
    },
    "entityType": {
      "type": "string",
      "description": "The type of data shared by this share rule. Valid values are: Account Campaign Case Contact Custom Object Lead Opportunity Order Quote API names of top-level custom objects in the org can also be used, for example, CustomObject__c."
    },
    "masterLabel": {
      "type": "string",
      "description": "The label assigned to the sharing rule to identify it."
    },
    "staticFormulaCriteria": {
      "type": "string",
      "description": "A way to further filter what data gets shared. This string must be a deterministic formula, and spanning isn’t allowed."
    },
    "type": {
      "type": "string",
      "description": "Match the type of an account relationship for data to be shared according to the accountToCriteriaField and the staticFormulaCriteria fields."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"AccountRelationshipShareRule\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"accessLevel\" type=\"xsd:string\"/>\n        <xsd:element name=\"accountToCriteriaField\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"entityType\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"staticFormulaCriteria\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"type\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an AccountRelationshipShareRule component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountRelationshipShareRule xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <accessLevel>Edit</accessLevel>\n    <accountToCriteriaField>Account.OwnerId</accountToCriteriaField>\n    <description>TestDescription</description>\n    <entityType>Account</entityType>\n    <masterLabel>TestName</masterLabel>\n    <staticFormulaCriteria>YearStarted = &quot;1980&quot;</staticFormulaCriteria>\n    <type>Dealer</type>\n</AccountRelationshipShareRule>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "AccountSettings - Metadata API",
  "description": "Represents an org’s account settings for account teams, account owner report, and the View Hierarchy link.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "enableAccountDiscovery": {
      "type": "boolean",
      "description": "When true, sets up Einstein Account Management dashboards and installs the related CRM Analytics and Customer Insights apps. The dashboards give users access to account health analytics including metrics on open pipeline, risk, and engagement scores. Einstein Account Management is part of Revenue Intelligence, which is available for an additional cost. Available in API version 57.0 and later."
    },
    "enableAccountHistoryTracking": {
      "type": "boolean",
      "description": "Indicates whether history tracking is enabled for accounts (true) or not (false). The default value is false. If history tracking is disabled, the History related list is removed from account page layouts. However, history data is still available for reporting up to the date and time when tracking was disabled. Available in API version 47.0 and later."
    },
    "enableAccountInsightsInMobile": {
      "type": "boolean",
      "description": "Deprecated in API version 59.0 and later because the feature is no longer available. Indicates whether users can see Einstein Account Insights on their mobile device (true) or not (false). Insights appear in the Einstein Insights component, which is on account records and the Home page. To use this feature, users must have the Einstein Account Insights permission. Available in API version 47.0 to 58.0."
    },
    "enableAccountOwnerReport": {
      "type": "boolean",
      "description": "Indicates whether the Account Owner Report can (true) or can’t (false) be run by all users."
    },
    "enableAccountTeams": {
      "type": "boolean",
      "description": "Indicates whether account teams are enabled (true) or not (false). The Metadata API can’t be used to disable account teams."
    },
    "enableContactHistoryTracking": {
      "type": "boolean",
      "description": "Indicates whether history tracking is enabled for contacts (true) or not (false). Available in API version 46.0 and later."
    },
    "enableRelateContactToMultipleAccounts": {
      "type": "boolean",
      "description": "Indicates whether users can relate a contact to multiple accounts (true) or only one account (false). The default value is false. If this feature (Contacts to Multiple Accounts) is disabled, secondary contact–account relationships created while the feature was enabled are deleted. Available in API version 47.0 and later. Avoid using the Metadata API to enable this feature. Use the Account Settings page in Setup to enable Contacts to Multiple Accounts."
    },
    "enableReportsToOnPersonAccount": {
      "type": "boolean",
      "description": "Indicates whether the Reports To field on Person Account, which corresponds to the PersonReportsToId field on the Account object, is enabled. The field allows users to associate person accounts and contacts with other person accounts or contacts that they report to. Available in API version 62.0 and later."
    },
    "showViewHierarchyLink": {
      "type": "boolean",
      "description": "Indicates whether the default View Hierarchy link on all business account detail pages is visible (true) or hidden (false)."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"AccountSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"enableAccountDiscovery\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAccountHistoryTracking\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAccountInsightsInMobile\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAccountOwnerReport\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAccountTeams\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableContactHistoryTracking\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableRelateContactToMultipleAccounts\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableReportsToOnPersonAccount\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"showViewHierarchyLink\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of the Account.settings file:",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AccountSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<enableAccountDiscovery>true</enableAccountDiscovery>\n\t<enableAccountHistoryTracking>true</enableAccountHistoryTracking>\n\t<enableAccountInsightsInMobile>false</enableAccountInsightsInMobile>\n\t<enableAccountOwnerReport>true</enableAccountOwnerReport>\n\t<enableAccountTeams>true</enableAccountTeams>\n\t<enableContactHistoryTracking>true</enableContactHistoryTracking>\n\t<enableRelateContactToMultipleAccounts>true</enableRelateContactToMultipleAccounts>\n\t<enableReportsToOnPersonAccount>true</enableReportsToOnPersonAccount>\n\t<showViewHierarchyLink>true</showViewHierarchyLink>\n</AccountSettings>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "ActionableListDefinition - Metadata API",
  "description": "Represents the data source definition details associated with an actionable list.",
  "file_information": ".actionableListDefinition",
  "directory_location": "actionableListDefinitions",
  "fields_columns": [
    "type",
    "description",
    "required"
  ],
  "fields": {
    "actionableListDatasetColumns": {
      "type": "ActionableListDatasetColumn[]",
      "description": "The object that stores columns in a dataset associated with an actionable list."
    },
    "actionableListMemberStatuses": {
      "type": "ActionableListMemberStatus[]",
      "description": "The object that stores the status and the corresponding status icon details of an individual actionable list member."
    },
    "batchCalcJobDefinition": {
      "type": "string",
      "description": "The batch calculation job definition that's associated with the creation of an actionable list. This field is a relationship field."
    },
    "datasetName": {
      "type": "string",
      "description": "The name of the dataset that is associated with the actionable list."
    },
    "edgeMart": {
      "type": "string",
      "description": "The edgemart dataset that's associated with the actionable list. Available in API version 58.0 and later."
    },
    "isActive": {
      "type": "boolean",
      "description": "Indicates whether the actionable list definition is active (true) or not (false). The default value is false."
    },
    "masterLabel": {
      "type": "string",
      "required": true,
      "description": "The master label of the actionable list definition."
    },
    "objectName": {
      "type": "string",
      "required": true,
      "description": "The object for which the actionable list is created.Possible values are organized by the API version in which they were introduced. Values are available in all versions after introduction unless noted otherwise. Possible values are: API version 60.0 and later: PersonLifeEventAPI version 60.0 and later with Insurance Managed Package: Claim InsurancePolicy Quote API version 59.0 and later with Health Cloud: CareFacilityBed CareRequest CareRequestItem CareServiceVisit CareServiceVisitPlan ClinicalServiceRequest API version 59.0 and later with Loyalty Cloud: LoyaltyProgramMember API version 59.0 and later: Case API version 58.0 and later with Automotive Cloud: Vehicle API version 58.0 and later: Asset Lead Opportunity API version 57.0 and later: Account Contact"
    }
  },
  "sub_types": {
    "ActionableListDatasetColumn": {
      "dataDomain": {
        "type": "DatasetColumnDataType (enumeration of type string)",
        "description": "The data domain that is mapped to the data type of the dataset column. Possible values are: Dates Dimensions Measures"
      },
      "dataType": {
        "type": "DatatableDataType (enumeration of type string)",
        "description": "The data type of the dataset column in the actionable list. Available in API version 58.0 and later. Possible values are: Boolean Currency Date DateTime Email Location Number Percent Phone Text Url"
      },
      "displayOrder": {
        "type": "int",
        "description": "The order in which the actionable list dataset columns are displayed. Available in API version 58.0 and later."
      },
      "isDefault": {
        "type": "boolean",
        "description": "Indicates whether the dataset column is added to the actionable list by default (true) or not (false). The default value is false."
      },
      "isGroupedByListDefObj": {
        "type": "boolean",
        "description": "Indicates whether the dataset column is grouped by the object defined in the actionable list definition (true) or not (false). Available in API version 59.0 and later."
      },
      "IsTypeAheadSearchEnabled": {
        "type": "boolean",
        "description": "Indicates whether the type-ahead search for filters is enabled (true) or not (false). Available in API version 60.0 and later."
      },
      "objectName": {
        "type": "string",
        "description": "The name of the object that's associated with the dataset column. Possible values are: API version 60.0 and later: PersonLifeEventAPI version 60.0 and later with Insurance Managed Package: Claim InsurancePolicy Quote API version 59.0 and later with Health Cloud: CareFacilityBed CareRequest CareRequestItem CareServiceVisit CareServiceVisitPlan ClinicalServiceRequest API version 59.0 and later with Loyalty Cloud: LoyaltyProgramMember API version 59.0 and later: Case API version 58.0 and later with Automotive Cloud: Vehicle API version 58.0 and later: Asset Lead Opportunity API version 57.0 and later: Account Contact"
      },
      "sourceColumnApiName": {
        "type": "string",
        "description": "The API name of the column in the source dataset."
      },
      "sourceFieldName": {
        "type": "string",
        "description": "The name of the field in the object for which the actionable list dataset is created."
      }
    },
    "ActionableListMemberStatus": {
      "iconName": {
        "type": "string",
        "description": "The name of the icon that's mapped to the status."
      },
      "status": {
        "type": "string",
        "description": "The status of the actionable list member."
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"ActionableListDatasetColumn\">\n  <xsd:sequence>\n    <xsd:element name=\"dataDomain\" minOccurs=\"0\" type=\"tns:DatasetColumnDataType\"/>\n    <xsd:element name=\"dataType\" minOccurs=\"0\" type=\"tns:DatatableDataType\"/>\n    <xsd:element name=\"displayOrder\" minOccurs=\"0\" type=\"xsd:int\"/>\n    <xsd:element name=\"isDefault\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"isGroupedByListDefObj\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"isTypeAheadSearchEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"objectName\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"sourceColumnApiName\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"sourceFieldName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ActionableListDefinition\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"actionableListDatasetColumns\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionableListDatasetColumn\"/>\n        <xsd:element name=\"actionableListMemberStatuses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionableListMemberStatus\"/>\n        <xsd:element name=\"batchCalcJobDefinition\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"datasetName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"edgeMart\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"isActive\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isProtected\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"objectName\" type=\"xsd:string\"/>\n        <xsd:element name=\"sourceObjectFieldName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"sourceObjectName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"sourceType\" minOccurs=\"0\" type=\"tns:ActionableListSourceType\"/>\n        <xsd:element name=\"type\" minOccurs=\"0\" type=\"tns:ActionableListType\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"ActionableListMemberStatus\">\n  <xsd:sequence>\n    <xsd:element name=\"iconName\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"status\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"ActionableListSourceType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"CrmAnalytics\"/>\n    <xsd:enumeration value=\"DataCloudPlatform\"/>\n    <xsd:enumeration value=\"Crm\"/>\n    <xsd:enumeration value=\"SalesforceObjects\"/>\n    <xsd:enumeration value=\"DataCloudDMO\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"ActionableListType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"RetailStoreList\"/>\n    <xsd:enumeration value=\"HealthcareProviderList\"/>\n    <xsd:enumeration value=\"GeneralList\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"DatasetColumnDataType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Dimensions\"/>\n    <xsd:enumeration value=\"Dates\"/>\n    <xsd:enumeration value=\"Measures\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"DatatableDataType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Boolean\"/>\n    <xsd:enumeration value=\"Currency\"/>\n    <xsd:enumeration value=\"Date\"/>\n    <xsd:enumeration value=\"DateTime\"/>\n    <xsd:enumeration value=\"Email\"/>\n    <xsd:enumeration value=\"Location\"/>\n    <xsd:enumeration value=\"Number\"/>\n    <xsd:enumeration value=\"Percent\"/>\n    <xsd:enumeration value=\"Phone\"/>\n    <xsd:enumeration value=\"Text\"/>\n    <xsd:enumeration value=\"Url\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of a ActionableListDefinition component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ActionableListDefinition\n\txmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<actionableListDatasetColumns>\n\t\t<isDefault>true</isDefault>\n\t\t<sourceFieldName>NewColumn1</sourceFieldName>\n\t</actionableListDatasetColumns>\n\t<actionableListDatasetColumns>\n\t\t<sourceColumnApiName>ApiName</sourceColumnApiName>\n\t\t<dataDomain>Dimensions</dataDomain>\n\t\t<isDefault>false</isDefault>\n\t\t<sourceFieldName>NewColumn2</sourceFieldName>\n\t\t<objectName>Account</objectName>\n\t\t<displayOrder>1</displayOrder>\n\t\t<dataType>Text</dataType>\n\t</actionableListDatasetColumns>\n\t<actionableListMemberStatuses>\n\t\t<iconName>NewMember1</iconName>\n\t\t<status>Active</status>\n\t</actionableListMemberStatuses>\n\t<isActive>true</isActive>\n\t<masterLabel>NewMember2</masterLabel>\n\t<objectName>Account</objectName>\n\t<isProtected>true</isProtected>\n\t<batchCalcJobDefinition>Test1</batchCalcJobDefinition>\n\t<datasetName>AccountDef</datasetName>\n</ActionableListDefinition>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "ActionLinkGroupTemplate - Metadata API",
  "description": "Represents the action link group template. Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an action link group and action links within the group are mutually exclusive.",
  "file_information": ".actionLinkGroupTemplate",
  "directory_location": "actionLinkGroupTemplates",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "actionLinkTemplates": {
      "type": "ActionLinkTemplate[]",
      "description": "Action link templates that are associated with the action link group template."
    },
    "category": {
      "type": "PlatformActionGroupCategory (enumeration of type string)",
      "description": "The location of the action link group within the feed element. Values are: Primary—The action link group is displayed in the body of the feed element. Overflow—The action link group is displayed in the overflow menu of the feed element.",
      "required": true
    },
    "executionsAllowed": {
      "type": "ActionLinkExecutionsAllowed (enumeration of type string)",
      "description": "The number of times an action link can be executed. Values are: Once—An action link can be executed only once across all users. OncePerUser—An action link can be executed only once for each user. Unlimited—An action link can be executed an unlimited number of times by each user. If the action link’s actionType is Api or ApiAsync, you can’t use this value.",
      "required": true
    },
    "hoursUntilExpiration": {
      "type": "int",
      "description": "The number of hours from when the action link group is created until it's removed from associated feed elements and can no longer be executed. The maximum value is 8,760.",
      "required": true
    },
    "isPublished": {
      "type": "boolean",
      "description": "If true, the action link group template is published. Action link group templates shouldn’t be published until at least one action link template is associated with it.",
      "required": true
    },
    "name": {
      "type": "string",
      "description": "The name of the action link group template to use in code.",
      "required": true
    }
  },
  "sub_types": {
    "ActionLinkTemplate": {
      "actionUrl": {
        "type": "string",
        "description": "The action link URL. For example, a Ui action link URL is a Web page. A Download action link URL is a link to the file to download. Ui and Download action link URLs are provided to clients. An Api or ApiAsync action link URL is a REST resource. Api and ApiAsync action link URLs aren’t provided to clients. Links to Salesforce can be relative. All other links must be absolute and start with https://.",
        "required": true
      },
      "headers": {
        "type": "string",
        "description": "Template for the HTTP headers sent when corresponding action links are invoked. This field can be used only for Api and ApiAsync action links. This field can contain context variables and binding variables in the form {!Bindings.key}."
      },
      "isConfirmationRequired": {
        "type": "boolean",
        "description": "If true, a confirmation dialog appears before the action is executed.",
        "required": true
      },
      "isGroupDefault": {
        "type": "boolean",
        "description": "If true, action links derived from this template are the default or primary action in their action groups. There can be only one default action per action group.",
        "required": true
      },
      "label": {
        "type": "string",
        "description": "A custom label to display on the action link button. If none of the LabelKey values make sense for an action link, use a custom label. Set the LabelKey field to None and enter a label name in the Label field."
      },
      "labelKey": {
        "type": "string",
        "description": "Key for the set of labels to display for these action link states: new, pending, success, failed. For example, the Approve set contains these labels: Approve, Pending, Approved, Failed. For a complete list of keys and labels, see Action Link Labels in the Connect REST API Developer Guide.",
        "required": true
      },
      "linkType": {
        "type": "ActionLinkType (enumeration of type string)",
        "description": "The type of action link. One of these values: Api—The action link calls a synchronous API at the action URL. Salesforce sets the status to SuccessfulStatus or FailedStatus based on the HTTP status code returned by your server. ApiAsync—The action link calls an asynchronous API at the action URL. The action remains in a PendingStatus state until a third party makes a request to /connect/action-links/actionLinkId to set the status to SuccessfulStatus or FailedStatus when the asynchronous operation is complete. Download—The action link downloads a file from the action URL. Ui—The action link takes the user to a web page at the action URL.",
        "required": true
      },
      "method": {
        "type": "ActionLinkHttpMethod (enumeration of type string)",
        "description": "HTTP method for the action URL. One of these values: HttpDelete—Returns HTTP 204 on success. Response body or output class is empty. HttpGet—Returns HTTP 200 on success. HttpHead—Returns HTTP 200 on success. Response body or output class is empty. HttpPatch—Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty. HttpPost—Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success. HttpPut—Return HTTP 200 on success or HTTP 204 if the response body or output class is empty. Ui and Download action links must use HttpGet.",
        "required": true
      },
      "position": {
        "type": "int",
        "description": "An integer specifying the position of the action link template relative to other action links in the group. 0 is the first position.",
        "required": true
      },
      "requestBody": {
        "type": "string",
        "description": "Template for the HTTP request body sent when corresponding action links are invoked. This field can be used only for Api and ApiAsync action links. This field can contain context variables and binding variables in the form {!Bindings.key}."
      },
      "userAlias": {
        "type": "string",
        "description": "If you selected CustomUser or CustomExcludedUser for UserVisibility, this field is the alias for the custom user. Use the alias in a template binding to specify the custom user when an action link group is created using the template."
      },
      "userVisibility": {
        "type": "ActionLinkUserVisibility (enumeration of type string)",
        "description": "Who can see the action link. This value is set per action link, not per action link group. Values are: Creator—Only the creator of the action link can see the action link. Everyone—Everyone can see the action link. EveryoneButCreator—Everyone but the creator of the action link can see the action link. Manager—Only the manager of the creator of the action link can see the action link. CustomUser—Only the custom user can see the action link. CustomExcludedUser—Everyone but the custom user can see the action link.",
        "required": true
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:simpleType name=\"ActionLinkExecutionsAllowed\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Once\"/>\n    <xsd:enumeration value=\"OncePerUser\"/>\n    <xsd:enumeration value=\"Unlimited\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"ActionLinkGroupTemplate\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"actionLinkTemplates\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionLinkTemplate\"/>\n        <xsd:element name=\"category\" type=\"tns:PlatformActionGroupCategory\"/>\n        <xsd:element name=\"executionsAllowed\" type=\"tns:ActionLinkExecutionsAllowed\"/>\n        <xsd:element name=\"hoursUntilExpiration\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"isPublished\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"name\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"ActionLinkHttpMethod\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"HttpDelete\"/>\n    <xsd:enumeration value=\"HttpHead\"/>\n    <xsd:enumeration value=\"HttpGet\"/>\n    <xsd:enumeration value=\"HttpPatch\"/>\n    <xsd:enumeration value=\"HttpPost\"/>\n    <xsd:enumeration value=\"HttpPut\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"ActionLinkTemplate\">\n  <xsd:sequence>\n    <xsd:element name=\"actionUrl\" type=\"xsd:string\"/>\n    <xsd:element name=\"headers\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"isConfirmationRequired\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"isGroupDefault\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"labelKey\" type=\"xsd:string\"/>\n    <xsd:element name=\"linkType\" type=\"tns:ActionLinkType\"/>\n    <xsd:element name=\"method\" type=\"tns:ActionLinkHttpMethod\"/>\n    <xsd:element name=\"position\" type=\"xsd:int\"/>\n    <xsd:element name=\"requestBody\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"userAlias\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"userVisibility\" type=\"tns:ActionLinkUserVisibility\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"ActionLinkType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"API\"/>\n    <xsd:enumeration value=\"APIAsync\"/>\n    <xsd:enumeration value=\"Download\"/>\n    <xsd:enumeration value=\"UI\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"ActionLinkUserVisibility\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Creator\"/>\n    <xsd:enumeration value=\"Everyone\"/>\n    <xsd:enumeration value=\"EveryoneButCreator\"/>\n    <xsd:enumeration value=\"Manager\"/>\n    <xsd:enumeration value=\"CustomUser\"/>\n    <xsd:enumeration value=\"CustomExcludedUser\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"PlatformActionGroupCategory\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Primary\"/>\n    <xsd:enumeration value=\"Overflow\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an ActionLinkGroupTemplate component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ActionLinkGroupTemplate xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n   <actionLinkTemplates>\n      <actionUrl>/services/data/{!Bindings.word}/chatter/feed-elements</actionUrl>\n      <headers>Content-Type:{!Bindings.word3}</headers>\n      <isConfirmationRequired>true</isConfirmationRequired>\n      <isGroupDefault>true</isGroupDefault>\n      <labelKey>Add</labelKey>\n      <linkType>API</linkType>\n      <method>httpPost</method>\n      <position>0</position>\n      <requestBody>{\"body\":{\"messageSegments\":[{\"type\": \"Text\",\n      \"text\": \"{!Bindings.word1}\"}]},\"subjectId\": \"{!Bindings.word2}\",\n      \"feedElementType\": \"feedItem\"}</requestBody>\n      <userAlias>customExcludedUser</userAlias>\n      <userVisibility>CustomExcludedUser</userVisibility>\n   </actionLinkTemplates>\n   <category>Primary</category>\n   <executionsAllowed>OncePerUser</executionsAllowed>\n   <hoursUntilExpiration>10</hoursUntilExpiration>\n   <isPublished>true</isPublished>\n   <name>MyPackage</name>\n</ActionLinkGroupTemplate>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "ActionOverride - Metadata API",
  "description": "Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "actionName": {
      "type": "string",
      "description": "The possible values are the same as the actions you can override: accept clone delete edit list new tab view",
      "required": true
    },
    "comment": {
      "type": "string",
      "description": "Any comments you want associated with the override."
    },
    "content": {
      "type": "string",
      "description": "Set this field if type is set to flexipage, lightningcomponent, scontrol, or visualforce. It refers to the name of the Lightning page, Lightning component, s-control, or Visualforce page to use as the override. To reference installed components, use this format: Component_namespace__Component_name."
    },
    "formFactor": {
      "type": "FormFactor (enumeration of type string)",
      "description": "The size of the page being overridden. If the type field is set to flexipage, set this field to Large to override the View action with a Lightning page in Lightning Experience. The Large value represents the Lightning Experience desktop environment and is valid only for the flexipage and lightningcomponent types. The Small value represents the Salesforce mobile app on a phone or tablet. The Medium value is reserved for future use. The null value (which is the same as specifying no value) represents Salesforce Classic. This field is available in API version 37.0 and later and is part of the feature for creating and editing record pages in Lightning Experience. Lightning component overrides return different FormFactor values depending on the API version used. In API version 41.0 and earlier, Lightning component overrides return only the null value (no value), representing the Salesforce Classic environment. In API version 42.0, if you specify different Lightning component overrides for Lightning Experience and mobile, one component is selected randomly for both overrides and its FormFactor value is returned. If there’s a conflict between Lightning components, and a Visualforce page override is also specified for Salesforce Classic, the Visualforce page takes precedence. In API version 43.0 and later, a Lightning component override for Lightning Experience returns the Large value and a Lightning component override for mobile returns the Small value, as expected."
    },
    "skipRecordTypeSelect": {
      "type": "boolean",
      "description": "Set this field to true if you prefer that any new records created by this action override aren’t forwarded to the record type selection page. This field is only valid if the actionName is a “create” type (like new), and type is set to visualforce. This field is available in API version 21.0 and later."
    },
    "type": {
      "type": "ActionOverrideType (enumeration of type string)",
      "description": "Represents the type of action override. Valid values are described in ActionOverrideType.",
      "required": true
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"ActionOverride\">\n  <xsd:sequence>\n    <xsd:element name=\"actionName\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"comment\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"content\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"formFactor\" minOccurs=\"0\" type=\"tns:FormFactor\"/>\n    <xsd:element name=\"skipRecordTypeSelect\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"type\" minOccurs=\"0\" type=\"tns:ActionOverrideType\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"ActionOverrideType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Default\"/>\n    <xsd:enumeration value=\"Standard\"/>\n    <xsd:enumeration value=\"Scontrol\"/>\n    <xsd:enumeration value=\"Visualforce\"/>\n    <xsd:enumeration value=\"Flexipage\"/>\n    <xsd:enumeration value=\"LightningComponent\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"AppActionOverride\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:ActionOverride\">\n      <xsd:sequence>\n        <xsd:element name=\"pageOrSobjectType\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"CustomApplication\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"actionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:AppActionOverride\"/>\n        <xsd:element name=\"brand\" minOccurs=\"0\" type=\"tns:AppBrand\"/>\n        <xsd:element name=\"consoleConfig\" minOccurs=\"0\" type=\"tns:ServiceCloudConsoleConfig\"/>\n        <xsd:element name=\"defaultLandingTab\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"formFactors\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FormFactor\"/>\n        <xsd:element name=\"isNavAutoTempTabsDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isNavPersonalizationDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isNavTabPersistenceDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isOmniPinnedViewEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isServiceCloudConsole\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"logo\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"navType\" minOccurs=\"0\" type=\"tns:NavType\"/>\n        <xsd:element name=\"preferences\" minOccurs=\"0\" type=\"tns:AppPreferences\"/>\n        <xsd:element name=\"profileActionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:AppProfileActionOverride\"/>\n        <xsd:element name=\"setupExperience\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"subscriberTabs\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n        <xsd:element name=\"tabs\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n        <xsd:element name=\"uiBundle\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"uiType\" minOccurs=\"0\" type=\"tns:UiType\"/>\n        <xsd:element name=\"utilityBar\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"workspaceConfig\" minOccurs=\"0\" type=\"tns:AppWorkspaceConfig\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"CustomObject\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"actionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionOverride\"/>\n        <xsd:element name=\"allowInChatterGroups\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"articleTypeChannelDisplay\" minOccurs=\"0\" type=\"tns:ArticleTypeChannelDisplay\"/>\n        <xsd:element name=\"businessProcesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BusinessProcess\"/>\n        <xsd:element name=\"compactLayoutAssignment\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"compactLayouts\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CompactLayout\"/>\n        <xsd:element name=\"customHelp\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"customHelpPage\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"customSettingsType\" minOccurs=\"0\" type=\"tns:CustomSettingsType\"/>\n        <xsd:element name=\"deploymentStatus\" minOccurs=\"0\" type=\"tns:DeploymentStatus\"/>\n        <xsd:element name=\"deprecated\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"enableActivities\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableBulkApi\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableDataTranslation\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableDivisions\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableEnhancedLookup\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableFeeds\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableLicensing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePublishStatusTracking\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableReports\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableSearch\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableSharing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableStreamingApi\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enrichments\" minOccurs=\"0\" type=\"tns:MetadataEnrichments\"/>\n        <xsd:element name=\"eventType\" minOccurs=\"0\" type=\"tns:PlatformEventType\"/>\n        <xsd:element name=\"externalDataSource\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"externalName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"externalRepository\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"externalSharingModel\" minOccurs=\"0\" type=\"tns:SharingModel\"/>\n        <xsd:element name=\"fieldSets\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FieldSet\"/>\n        <xsd:element name=\"fields\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CustomField\"/>\n        <xsd:element name=\"gender\" minOccurs=\"0\" type=\"tns:Gender\"/>\n        <xsd:element name=\"historyRetentionPolicy\" minOccurs=\"0\" type=\"tns:HistoryRetentionPolicy\"/>\n        <xsd:element name=\"household\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"indexes\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Index\"/>\n        <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"listViews\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ListView\"/>\n        <xsd:element name=\"mktDataLakeAttributes\" minOccurs=\"0\" type=\"tns:MktDataLakeAttributes\"/>\n        <xsd:element name=\"mktDataModelAttributes\" minOccurs=\"0\" type=\"tns:MktDataModelAttributes\"/>\n        <xsd:element name=\"nameField\" minOccurs=\"0\" type=\"tns:CustomField\"/>\n        <xsd:element name=\"pluralLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"profileSearchLayouts\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileSearchLayouts\"/>\n        <xsd:element name=\"publishBehavior\" minOccurs=\"0\" type=\"tns:PlatformEventPublishBehavior\"/>\n        <xsd:element name=\"recordTypeTrackFeedHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"recordTypeTrackHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"recordTypes\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RecordType\"/>\n        <xsd:element name=\"searchLayouts\" minOccurs=\"0\" type=\"tns:SearchLayouts\"/>\n        <xsd:element name=\"sharingModel\" minOccurs=\"0\" type=\"tns:SharingModel\"/>\n        <xsd:element name=\"sharingReasons\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SharingReason\"/>\n        <xsd:element name=\"sharingRecalculations\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SharingRecalculation\"/>\n        <xsd:element name=\"startsWith\" minOccurs=\"0\" type=\"tns:StartsWith\"/>\n        <xsd:element name=\"validationRules\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ValidationRule\"/>\n        <xsd:element name=\"visibility\" minOccurs=\"0\" type=\"tns:SetupObjectVisibility\"/>\n        <xsd:element name=\"webLinks\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:WebLink\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"CustomTab\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"actionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionOverride\"/>\n        <xsd:element name=\"auraComponent\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"customObject\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"flexiPage\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"frameHeight\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"hasSidebar\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"icon\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"lwcComponent\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"motif\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"page\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"scontrol\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"splashPageLink\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"url\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"urlEncodingKey\" minOccurs=\"0\" type=\"tns:Encoding\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"FormFactor\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Small\"/>\n    <xsd:enumeration value=\"Medium\"/>\n    <xsd:enumeration value=\"Large\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "A Visualforce page override for Salesforce Classic:",
      "code": "<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <actionOverrides>\n        <actionName>edit</actionName>\n        <type>visualforce</type>\n        <content>myEditVFPage</content>\n        <comment>This edit action is a lot safer.</comment>\n     </actionOverrides>\n</CustomObject"
    },
    {
      "description": "A Lightning component override for Lightning Experience:",
      "code": "<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <actionOverrides>\n        <actionName>edit</actionName>\n        <type>lightningcomponent</type>\n        <content>myEditLightningComponent</content>\n        <formFactor>Large</formFactor>\n        <comment>This edit action is a lot safer.</comment>\n     </actionOverrides>\n</CustomObject>"
    },
    {
      "description": "A Lightning component override for the Salesforce mobile app:",
      "code": "<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <actionOverrides>\n        <actionName>edit</actionName>\n        <type>lightningcomponent</type>\n        <content>myEditLightningComponent</content>\n        <formFactor>Small</formFactor>\n        <comment>This edit action is a lot safer.</comment>\n     </actionOverrides>\n</CustomObject>"
    },
    {
      "description": "When overrides are included in a managed package, the overrides are represented as default retrieve()",
      "code": "<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <actionOverrides>\n        <actionName>edit</actionName>\n        <type>default</type>\n     </actionOverrides>\n</CustomObject>"
    },
    {
      "description": "If you subscribe to a managed package with default overrides, you can replace the default override behavior by editing the XML. For example, to replace the Visualforce page override with the Salesforce standard page for Salesforce Classic, use:",
      "code": "<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <actionOverrides>\n        <actionName>edit</actionName>\n        <type>standard</type>\n     </actionOverrides>\n</CustomObject>"
    },
    {
      "description": "To set a Lightning page action override on the View standard button in Lightning Experience, use:",
      "code": "<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <actionOverrides>\n        <actionName>View</actionName>\n        <content>myLightningPage</content>\n        <formFactor>Large</formFactor>\n        <type>flexipage</type>\n    </actionOverrides>\n</CustomObject>"
    }
  ]
}

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "ActionPlanTemplate - Metadata API",
  "description": "Represents the instance of an action plan template.",
  "file_information": ".apt",
  "directory_location": "actionPlanTemplates",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "actionPlanTemplateItem": {
      "type": "ActionPlanTemplateItem",
      "description": "The instance of an item on an action plan template version."
    },
    "actionPlanTemplateItemDependencies": {
      "type": "ActionPlanTemplateItemDependency[]",
      "description": "Defines the dependencies between action plan template items. Available in API version 59.0 and later."
    },
    "actionPlanType": {
      "type": "ActionPlanTemplateType (enumeration of type string)",
      "description": "Type of the action plan template. Valid values are: Industries Retail ITSM—Available in API version 65.0 and later. PrvdEngmtCompliance KAM Available in API version 63.0 and later."
    },
    "category": {
      "type": "string",
      "description": "Category for this action plan template. Available in API version 64.0 and later."
    },
    "description": {
      "type": "string",
      "description": "The description of the action plan template."
    },
    "estimatedCompletionDays": {
      "type": "int",
      "description": "Estimated number of days required to complete the action plan. Available in API version 64.0 and later."
    },
    "fileBasedTemplatePath": {
      "type": "string",
      "description": "File path for a file-based action plan template. Available in API version 64.0 and later."
    },
    "isAdHocItemCreationEnabled": {
      "type": "boolean",
      "description": "Indicates whether ad hoc item creation is enabled for this action plan template (true) or not (false). Available in API version 59.0 and later.",
      "required": true
    },
    "name": {
      "type": "string",
      "description": "The name of the action plan template.",
      "required": true
    },
    "ParentTemplateId": {
      "type": "reference",
      "description": "The ID of the parent Action Plan Template record. This field is a relationship field to the ParentTemplate and refers to ActionPlanTemplate. Available in API version 66.0 and later."
    },
    "sourceType": {
      "type": "string",
      "description": "Source type of the action plan template. Available in API version 64.0 and later."
    },
    "status": {
      "type": "string",
      "description": "Status of the action plan template. Available in API version 64.0 and later."
    },
    "subcategory": {
      "type": "string",
      "description": "Subcategory for this action plan template. Available in API version 64.0 and later."
    },
    "targetEntityType": {
      "type": "string",
      "description": "The parent object this action plan template relates to. Supported parent objects are Account, BusinessMilestone, Campaign, Case, Claim, Contact, Contract, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PersonLifeEvent, and Visit and custom objects with activities enabled.",
      "required": true
    },
    "uniqueName": {
      "type": "string",
      "description": "The unique identifier for this action plan template record.",
      "required": true
    }
  },
  "sub_types": {
    "ActionPlanTemplateItem": {
      "actionPlanTemplateItemValue": {
        "type": "ActionPlanTemplateItemValue",
        "description": "The value associated with the action plan template item."
      },
      "displayOrder": {
        "type": "int",
        "description": "The order in which this item is displayed within the action plan template version."
      },
      "isRequired": {
        "type": "boolean",
        "description": "Indicates whether the task created from this template item is required."
      },
      "itemEntityType": {
        "type": "string",
        "description": "The name of the field on the action plan template item that this value is for. Available in API version 48.0 and later.",
        "required": true
      },
      "name": {
        "type": "string",
        "description": "The name of the action plan template item.",
        "required": true
      },
      "uniqueName": {
        "type": "string",
        "description": "The unique identifier for this action plan template item record.",
        "required": true
      }
    },
    "ActionPlanTemplateItemDependency": {
      "creationType": {
        "type": "string",
        "description": "Defines how the dependent item is created in the action plan.",
        "required": true
      },
      "name": {
        "type": "string",
        "description": "Name of the dependency relationship.",
        "required": true
      },
      "previousTemplateItem": {
        "type": "ActionPlanTemplateItem",
        "description": "Reference to the prerequisite template item that must be completed before the dependent item begins.",
        "required": true
      },
      "templateItem": {
        "type": "ActionPlanTemplateItem",
        "description": "Reference to the dependent template item that relies on the completion of the previous item.",
        "required": true
      }
    },
    "ActionPlanTemplateItemValue": {
      "itemEntityType": {
        "type": "string",
        "description": "The name of the field on the action plan template item that this value is for. Available in API version 48.0 and later.",
        "required": true
      },
      "name": {
        "type": "string",
        "description": "The name of the action plan template item value.",
        "required": true
      },
      "valueFormula": {
        "type": "string",
        "description": "The formula for this action plan template item."
      },
      "valueLiteral": {
        "type": "string",
        "description": "The value for this action plan template item."
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"ActionPlanTemplate\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"actionPlanTemplateItem\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionPlanTemplateItem\"/>\n        <xsd:element name=\"actionPlanTemplateItemDependencies\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionPlanTemplateItemDependency\"/>\n        <xsd:element name=\"actionPlanType\" minOccurs=\"0\" type=\"tns:ActionPlanTemplateType\"/>\n        <xsd:element name=\"category\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"estimatedCompletionDays\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"fileBasedTemplatePath\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"isAdHocItemCreationEnabled\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"name\" type=\"xsd:string\"/>\n        <xsd:element name=\"sourceType\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"status\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"subcategory\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"targetEntityType\" type=\"xsd:string\"/>\n        <xsd:element name=\"uniqueName\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"ActionPlanTemplateItem\">\n  <xsd:sequence>\n    <xsd:element name=\"actionPlanTemplateItemValue\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionPlanTemplateItemValue\"/>\n    <xsd:element name=\"displayOrder\" minOccurs=\"0\" type=\"xsd:int\"/>\n    <xsd:element name=\"isRequired\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"itemEntityType\" type=\"xsd:string\"/>\n    <xsd:element name=\"name\" type=\"xsd:string\"/>\n    <xsd:element name=\"uniqueName\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ActionPlanTemplateItemDependency\">\n  <xsd:sequence>\n    <xsd:element name=\"creationType\" type=\"xsd:string\"/>\n    <xsd:element name=\"name\" type=\"xsd:string\"/>\n    <xsd:element name=\"previousTemplateItem\" type=\"tns:ActionPlanTemplateItem\"/>\n    <xsd:element name=\"templateItem\" type=\"tns:ActionPlanTemplateItem\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ActionPlanTemplateItemValue\">\n  <xsd:sequence>\n    <xsd:element name=\"itemEntityType\" type=\"xsd:string\"/>\n    <xsd:element name=\"name\" type=\"xsd:string\"/>\n    <xsd:element name=\"valueFormula\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"valueLiteral\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"ActionPlanTemplateType\">\n  <xsd:restriction base=\"xsd:string\"/>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an ActionPlanTemplate component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ActionPlanTemplate xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <actionPlanTemplateItem>\n        <actionPlanTemplateItemValue>\n            <name>Subject</name>\n            <valueLiteral>APT 01 Account Packaging APTI 01</valueLiteral>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <actionPlanTemplateItemValue>\n            <name>Priority</name>\n            <valueLiteral>Normal</valueLiteral>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <actionPlanTemplateItemValue>\n            <name>ActivityDate</name>\n            <valueFormula>StartDate + 10</valueFormula>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <displayOrder>1</displayOrder>\n        <isRequired>true</isRequired>\n        <itemEntityType>Task</itemEntityType>\n        <name>APT 01 Account Packaging APTI 01</name>\n        <uniqueName>APT_01_Account_Packaging_APTI_01_2827f387_9dbc_11e9_920a_e95716848ddd</uniqueName>\n    </actionPlanTemplateItem>\n    <actionPlanTemplateItem>\n        <actionPlanTemplateItemValue>\n            <name>Subject</name>\n            <valueLiteral>APT 01 Account Packaging APTI 02</valueLiteral>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <actionPlanTemplateItemValue>\n            <name>Priority</name>\n            <valueLiteral>Normal</valueLiteral>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <actionPlanTemplateItemValue>\n            <name>ActivityDate</name>\n            <valueFormula>StartDate + 10</valueFormula>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <displayOrder>1</displayOrder>\n        <isRequired>true</isRequired>\n        <itemEntityType>Task</itemEntityType>\n        <name>APT 01 Account Packaging APTI 02</name>\n        <uniqueName>APT_01_Account_Packaging_APTI_02_3430da7b_9dbc_11e9_920a_b5d3292906c3</uniqueName>\n    </actionPlanTemplateItem>\n    <actionPlanTemplateItem>\n        <actionPlanTemplateItemValue>\n            <name>Subject</name>\n            <valueLiteral>APT 01 Account Packaging APTI 03</valueLiteral>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <actionPlanTemplateItemValue>\n            <name>Priority</name>\n            <valueLiteral>Normal</valueLiteral>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <actionPlanTemplateItemValue>\n            <name>ActivityDate</name>\n            <valueFormula>StartDate + 10</valueFormula>\n            <itemEntityType>Task</itemEntityType>\n        </actionPlanTemplateItemValue>\n        <displayOrder>1</displayOrder>\n        <isRequired>true</isRequired>\n        <itemEntityType>Task</itemEntityType>\n        <name>APT 01 Account Packaging APTI 03</name>\n        <uniqueName>APT_01_Account_Packaging_APTI_03_2d0363d9_9dbc_11e9_920a_219a003f176d</uniqueName>\n    </actionPlanTemplateItem>\n    <actionPlanTemplateItemDependencies>\n        <name>APT Task Dependency</name>\n        <creationType>OnPreviousItemCompleted</creationType>\n        <previousTemplateItem>\n            <actionPlanTemplateItemValue>\n                <name>Subject</name>\n                    <valueLiteral>APT 01 Account Packaging APTI 01</valueLiteral>\n                    <itemEntityType>Task</itemEntityType>\n                </actionPlanTemplateItemValue>\n                <actionPlanTemplateItemValue>\n                    <name>Priority</name>\n                    <valueLiteral>Normal</valueLiteral>\n                    <itemEntityType>Task</itemEntityType>\n                </actionPlanTemplateItemValue>\n                <actionPlanTemplateItemValue>\n                    <name>ActivityDate</name>\n                    <valueFormula>StartDate + 10</valueFormula>\n                    <itemEntityType>Task</itemEntityType>\n            </actionPlanTemplateItemValue>\n            <displayOrder>1</displayOrder>\n            <isRequired>true</isRequired>\n            <itemEntityType>Task</itemEntityType>\n            <name>APT 01 Account Packaging APTI 01</name>\n            <uniqueName>APT_01_Account_Packaging_APTI_01_2827f387_9dbc_11e9_920a_e95716848ddd</uniqueName>\n        </previousTemplateItem>\n        <templateItem>\n            <actionPlanTemplateItemValue>\n            <name>Subject</name>\n            <valueLiteral>APT 01 Account Packaging APTI 02</valueLiteral>\n            <itemEntityType>Task</itemEntityType>\n            </actionPlanTemplateItemValue>\n            <actionPlanTemplateItemValue>\n                <name>Priority</name>\n                <valueLiteral>Normal</valueLiteral>\n                <itemEntityType>Task</itemEntityType>\n            </actionPlanTemplateItemValue>\n            <actionPlanTemplateItemValue>\n                <name>ActivityDate</name>\n                <valueFormula>StartDate + 10</valueFormula>\n                <itemEntityType>Task</itemEntityType>\n            </actionPlanTemplateItemValue>\n            <displayOrder>1</displayOrder>\n            <isRequired>true</isRequired>\n            <itemEntityType>Task</itemEntityType>\n            <name>APT 01 Account Packaging APTI 02</name>\n            <uniqueName>APT_01_Account_Packaging_APTI_02_3430da7b_9dbc_11e9_920a_b5d3292906c3</uniqueName>\n        </templateItem>\n    </actionPlanTemplateItemDependencies>\n    <description>APT 01 Account Packaging Description</description>\n    <name>APT 01 Account Packaging</name>\n    <targetEntityType>Account</targetEntityType>\n    <actionPlanType>Industries</actionPlanType>\n    <uniqueName>APT_01_Account_Packaging_0c9e8b15_9dbc_11e9_920a_8d6ecf990219</uniqueName>\n    <isAdHocItemCreationEnabled>false</isAdHocItemCreationEnabled>\n    <category>Onboarding</category>\n    <subcategory>OnBoarding Product</subcategory>\n    <estimatedCompletionDays>4</estimatedCompletionDays>\n    <sourceType>Migrated From SandBox</sourceType>\n    <fileBasedTemplatePath>Action Plan Template</fileBasedTemplatePath>\n    <status>Draft</status>\n</ActionPlanTemplate>"
    }
  ]
}