SharingBaseRule

Represents sharing rule settings such as access level and to whom access is granted.

You can’t create a SharingBaseRule component directly. Use the components under SharingRules instead.

Note

Parent Type 

This type extends Metadata and inherits its fields.

Version 

SharingBaseRule replaces BaseSharingRule and is available in API version 33.0 and later.

Fields 

accessLevel 

• Type: string
• Required: Yes
• Description: Required. The access level that the sharing rule grants.

accountSettings 

• Type: AccountSharingRuleSettings
• Required: No
• Description: The access level for the account’s children (case, contact, and opportunity).

description 

• Type: string
• Required: No
• Description: Describes the sharing rule. Maximum of 1000 characters.

label 

• Type: string
• Required: Yes
• Description: Required. Label for the sharing rule.

sharedTo 

• Type: SharedTo
• Required: Yes
• Description: Required. Specifies who the record is shared with.

AccountSharingRuleSettings Type 

Defines the access level for the case, contact, and opportunity associated with the account.

Fields 

caseAccessLevel 

• Type: string

• Required: Yes

• Description: Required. The access level that the user or group has to cases associated with the account. Possible values are:

  • None
  • Read
  • Edit

contactAccessLevel 

• Type: string

• Required: Yes

• Description: Required. The access level that the user or group has to contacts associated with the account. Possible values are:

  • None
  • Read
  • Edit

opportunityAccessLevel 

• Type: string

• Required: Yes

• Description: Required. The access level that the user or group has to opportunities associated with the account. Possible values are:

  • None
  • Read
  • Edit

Wildcard Support in the Manifest File 

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.