Scoping Rules Developer Guide

About This Guide
Scoping Rules
Quick Start: Display Records by Branch Location
Before You Start
Use the SOQL Operator in Scoping Rule Record Criteria
Create a Branch Management Scoping Rule Using the Tooling API
Create a Branch Management Scoping Rule Using the Metadata API
Retrieve and Update Information
Create a Wealth Management Scoping Rule Using the Tooling API
Create a Wealth Management Scoping Rule Using the Metadata API
Considerations for Scoping Rules
Example Scenarios
Tooling API Reference
Metadata API Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Retrieve and Update Information

Use the deploy() and retrieve() calls to move metadata (XML files) between Salesforce and a local file system. You can delete scoping rules by using the same procedure used to deploy components and including a delete manifest file.
Available in: Lightning Experience in Performance,Unlimited, and Developer editions.

For more information, see Deploying and Retrieving Metadata in the Metadata API Developer Guide.

If the userCriteria or recordCriteria field contains a Salesforce org ID and you’re deploying to a different org than the org you retrieved them from, modify the Salesforce ID first.

We recommend that you don’t update the value of targetEntity after a scoping rule is created. Instead, delete the scoping rule and create another one with the correct values.

Note

To delete components, use the same procedure as with deploying components, but include a delete manifest file that’s named destructiveChanges.xml and lists the components to delete. To learn more, see Deleting Components from an Organization.