Metadata API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
SharingBaseRule
This type extends the Metadata metadata type and inherits its fullName field.
Version
SharingBaseRule replaces BaseSharingRule and is available in API version 33.0 and later.
Fields
| Field | Field Type | Description |
|---|---|---|
| accessLevel | string | Required. The access level that the sharing rule grants. |
| accountSettings | AccountSharingRuleSettings[] | The access level for the account’s children (case, contact, and opportunity). |
| description | string | Describes the sharing rule. Maximum of 1000 characters. |
| label | string | Required. Label for the sharing rule. |
| sharedTo | SharedTo | Required. Specifies who the record is shared with. |
AccountSharingRuleSettings
Defines the access level for the case, contact, and opportunity associated with the account.
| Field | Field Type | Description |
|---|---|---|
| caseAccessLevel | string | Required. The access level that the user or group has to cases associated with the
account. Possible values are:
|
| contactAccessLevel | string | Required. The access level that the user or group has to contacts associated with the
account. Possible values are:
|
| opportunityAccessLevel | string | Required. The access level that the user or group has to opportunities associated with
the account. Possible values are:
|
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.