Latest Posts

Break Role Inheritance On List in SharePoint using REST API

The example in this topic show how to use REST API to Break Role Inheritance On List in SharePoint
  • REST-API is based on OData (Open Data) Protocol and hence it doesn't require any dll or JS library to run the commands on the SharePoint objects.
  • REST-API calls require proper end-point URL and proper Header implementation in your REST call.

How to use SharePoint REST API?

  • Note: This is just a sample, you can go ahead with your implementation.
  • You can also use this method in your SPFx Component.
  • Open your Site. Create a webpart page.
  • Put a Content Editor Web part and a Script Editor Web part on it.
  • Webpart page content editor and scipt editor
  • I have added below Html in Content Editor webpart. You can replace MainFunction with your actual method name.

    <button onclick="MainFunction();" type="button">Click me​</button>

  • And below references in Script Editor Webpart. ScriptFile.js is a JavaScript file where you can keep below function i.e. your actual logic.

    <script src="https://MyServer/sites/SiteCollection/style library/js/ScriptFile.js"></script>

  • Once you are done with setting your page, click on the button and your method should get executed.

  • function BreakRoleInheritanceOnList()
  • {
  •        $.ajax
  •         ({
  •             // _spPageContextInfo.webAbsoluteUrl - will give absolute URL of the site where you are running the code.
  •             // You can replace this with other site URL where you want to apply the function
  •             // This method takes two parameteres.
  •                      // (1) copyRoleAssignments(Boolean) - Specifies whether to copy the role assignments from the parent or not.
  •                      // If the value is false, the collection of role assignments must contain only 1 role assignment containing the current user after the operation
  •                      // (2) clearSubscopes(Boolean) - clearsubscopes parameter is true, the role assignments for all child objects will be cleared and those objects will inherit role assignments from the current object after this call.
  •                      // If the clearsubscopes parameter is false, the role assignments for all child objects which do not inherit role assignments from their parent must remain unchanged.
  •               url: _spPageContextInfo.webAbsoluteUrl + "/_api/Web/lists/getByTitle('List%20Name')/BreakRoleInheritance(copyRoleAssignments=true, clearSubscopes=true)",
  •             type: "POST",
  •               headers:
  •             {
  •                 // Accept header: Specifies the format for response data from the server.
  •                 "Accept": "application/json;odata=verbose",
  •                 //Content-Type header: Specifies the format of the data that the client is sending to the server
  •                 "Content-Type": "application/json;odata=verbose",
  •                 // IF-MATCH header: Provides a way to verify that the object being changed has not been changed since it was last retrieved.
  •                 // "IF-MATCH":"*", will overwrite any modification in the object, since it was last retrieved.
  •                 "IF-MATCH": "*",
  •                 //X-HTTP-Method:  The MERGE method updates only the properties of the entity , while the PUT method replaces the existing entity with a new one that you supply in the body of the POST
  •                 "X-HTTP-Method": "PATCH",
  •                 // X-RequestDigest header: When you send a POST request, it must include the form digest value in X-RequestDigest header
  •                 "X-RequestDigest": $("#__REQUESTDIGEST").val()
  •             },
  •                success: function (data, status, xhr) {
  •                    console.log("Success");
  •                      },
  •                error: function (xhr, status, error) {
  •                    console.log("Failed");
  •                }
  •         });
  • }

Thank you for reading this article. This code was tested in SharePoint 2013

We value your Feedback:

Page URL:







© 2024 Code SharePoint