Restriction Rules Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
About This Guide
Restriction Rules
Quick Start: Control Which Tasks the Sales Team Can Access
Before You Start
Create a Restriction Rule Using the Tooling API
Retrieve and Update Information
Create the Restriction Rule Using the Metadata API
Considerations
Example Scenarios
Tooling API Reference
Metadata API Reference
PDF

Create a Restriction Rule Using the Tooling API

Create a restriction rule that controls which tasks members of the Sales Team can access using the RestrictionRule Tooling API object.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Available in: Lightning Experience in Enterprise, Performance, Unlimited, and Developer Editions

User Permissions Needed
To create and manage restriction rules: Manage Sharing
To view restriction rules: View Setup & Configuration AND View Restriction and Scoping Rules

You can create up to two restriction rules per object in Enterprise and Developer Editions and up to five restriction rules per object in Performance and Unlimited Editions.

  1. Set a value for the FullName value (the full name of the associated metadata object in Metadata API). We don't support two consecutive underscores in the FullName field.
  2. Include all other required fields. For more information, see the reference topic RestrictionRule.

    For our example, we set the fields as follows:

    {
    "FullName": "restrictionrulesalesteam",
    "Metadata": {
        "active": true,
        "description": "Sales team can see only task records with specified record type",
        "enforcementType": "Restrict",
        "masterLabel": "Sales Team Record Type",
        "recordFilter": "recordTypeId = '011xxxxxxxxxxxx'",
        "targetEntity": "Task",
        "userCriteria": "$User.ProfileId = '00exxxxxxxxxxxx'",
        "version": 1
    }
}
  3. Use a POST request to create the restriction rule.
    POST /services/data/v55.0/tooling/sobjects/RestrictionRule
  4. Copy your restriction rule definition into the request body.
  5. Execute your request. Note the ID returned for the newly created restriction rule for later reference.