Newer Version Available

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

Retrieve and Update Information (Beta)

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 and Unlimited 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.