afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/AccountRelationshipShareRule.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "field_reference"
  ],
  "title": "AccountRelationshipShareRule - Data API",
  "description": "Represents the rule that determines which object records are shared, how they are shared, the account relationship type that shares the records, and the level of access granted to the records. This object is available in API version 45.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "AccessLevel": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Type of access granted by the share rule. Valid values are: Read (Read Only) Edit (Read/Write)"
    },
    "AccountToCriteriaField": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Criteria that must be met for the data to be shared. Possible values are: Account.OwnerId Account.ParentId Campaign.OwnerId Case.AccountId Case.OwnerId Contact.AccountId Contact.OwnerId Lead.ConvertedAccountId Lead.OwnerId Lead.PartnerAccountId Opportunity.PartnerAccountId Order.AccountId Order.ActivatedById Order.CompanyAuthorizedById Order.OwnerId PartnerFundAllocation.CreatedById PartnerFundAllocation.ChannelPartnerId PartnerFundAllocation.OwnerId PartnerFundClaim.CreatedById PartnerFundClaim.OwnerId PartnerFundRequest.ChannelPartnerId PartnerFundRequest.CreatedById PartnerFundRequest.OwnerId PartnerMarketingBudget.CreatedById PartnerMarketingBudget.ChannelPartnerId PartnerMarketingBudget.OwnerId"
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "A meaningful explanation of the sharing rule."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update"
    },
    "EntityType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The type of data shared by this rule. Values are: Account Campaign Case Contact Lead Order PartnerFundAllocation PartnerFundClaim PartnerFundRequest PartnerMarketingBudget"
    },
    "Language": {
      "type": "picklist",
      "properties": "Create, Defaulted on create. Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The language of the account relationship share rule."
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The label assigned to the sharing rule to identify it."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
    },
    "StaticFormulaCriteria": {
      "type": "string",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "A way to further filter what data gets shared. This must be a deterministic formula and spanning is not allowed."
    },
    "Type": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Must match the type of an account relationship for data to be shared according to the AccountToCriteriaField and the StaticForumulaCriteria."
    }
  },
  "field_reference": {
    "AccessLevel": {
      "field_label": "Access Level",
      "type": "picklist",
      "length": "255"
    },
    "AccountToCriteriaField": {
      "field_label": "Account To Criteria Field",
      "type": "picklist",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "1000"
    },
    "DeveloperName": {
      "field_label": "Developer Name",
      "type": "string",
      "length": "80"
    },
    "EntityType": {
      "field_label": "Object Type",
      "type": "picklist",
      "length": "255"
    },
    "Id": {
      "field_label": "Account Relationship Data Sharing Rule ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Master Language",
      "type": "picklist",
      "length": "40"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Label",
      "type": "string",
      "length": "80"
    },
    "NamespacePrefix": {
      "field_label": "Namespace Prefix",
      "type": "string",
      "length": "15"
    },
    "StaticFormulaCriteria": {
      "field_label": "Static Formula Criteria",
      "type": "string",
      "length": "1333"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Type": {
      "field_label": "Account Relationship Type",
      "type": "picklist",
      "length": "40"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}