Friday, 27 May 2016

Working With SharePoint Site Collection Features Using REST API

Views

In this post, you will learn how retrieve, enable or disable the site collection features (site scoped) programmatically using REST API on SharePoint 2013 / SharePoint 2016 / SharePoint online. There are different ways that we use to work with site collection features. We will see how we can use REST APIs to achieve the functionalities.
  • Identify the site collection URL and build the REST API URL. 
  • In the URL, site denotes the site collection scope and set the necessary parameters to filter out the data. You need to provide select parameters to get the necessary feature properties in get request.
  • Use Ajax jQuery call to accomplish the necessary operation.
  • You can set the return value type in the ajax call request. In my case, I have specified JSON to be return value in the data parameter.
  • In these cases, You can check the result values in browser debugger console. You can change the logic to display results on pages.
  • Place these scripts on page using the web parts (content editor / script editor / any custom web part). 


Get Active Site Collection Features and Properties (Site scope):


The operation will fetch all the active site collection features present on the site.
  • In the URL, select parameters has necessary properties to be retrieved.
  • Using foreach loop, get and display the results.
    1. // Retrieves all the site collection features enabled (site scoped features)  
    2. function GetSiteCollectionFeatures(){  
    3.     var featuresURI = sitecollectionURL + "/_api/site/features?$select=DisplayName,DefinitionId";  
    4.     $.ajax({  
    5.         url: featuresURI,  
    6.         method: 'GET',  
    7.         headers: { "Accept""application/json; odata=verbose" },  
    8.         dataType: "json",  
    9.         success: function (data) {  
    10.             var siteCollectionFeatures = data.d.results;  
    11.             for(var i=0;i<siteCollectionFeatures.length;i++){  
    12.                 console.log(siteCollectionFeatures[i].DefinitionId + " - " + siteCollectionFeatures[i].DisplayName);  
    13.             }  
    14.         },  
    15.         error: function(data) {  
    16.         }  
    17.     });  
    18. }  



Get/Check Site Collection Feature Properties/Status (Site scope):


Here we will see how we can get the particular feature and check whether the site collection feature is active or not. You can identify whether the feature is activated at site scope or not.
  • Get the feature id from the Microsoft site. The scope of the feature should be site.
  • Get the feature using GetById method with feature id in the REST API.
    1. // Retrieves the site collection feature by id enabled (site scoped features)  
    2. function GetSiteCollectionFeatureByID(){  
    3.     var featuresURI = sitecollectionURL + "/_api/site/features/GetByID('151d22d9-95a8-4904-a0a3-22e4db85d1e0')?$select=DisplayName,DefinitionId";   
    4.     // Cross-Site Collection Publishing Feature ID  
    5.     $.ajax({  
    6.         url: featuresURI,  
    7.         method: 'GET',  
    8.         headers: { "Accept""application/json; odata=verbose" },  
    9.         dataType: "json",  
    10.         success: function (data) {  
    11.             if(data.d != null){  
    12.                 console.log(data.d.DefinitionId + " - " + data.d.DisplayName + " feature is active");  
    13.             }  
    14.             else{  
    15.                 console.log("Feature is not active");  
    16.             }  
    17.         },  
    18.         error: function(data) {  
    19.         }  
    20.     });  
    21. }  



Activate the site collection feature (Site scope):


In the above section, we have seen how we can check the status of the site collection feature. Here we will see how we can activate the feature which is already installed on the site.
  • To activate the site feature, use the add method to the features collection. The necessary parameter to be passed in the query is feature id.
  • POST method will be used to accomplish the task.
  • RequestDigest will be passed in the header to validate the page requests.
    1. // Enables site collection feature (Site scoped feature)  
    2. function EnableSiteCollectionFeature(){  
    3.     var featuresURI = sitecollectionURL + "/_api/site/features/add('151d22d9-95a8-4904-a0a3-22e4db85d1e0')"// Cross-Site Collection Publishing Feature ID  
    4.     $.ajax({  
    5.         url: featuresURI,  
    6.         method: 'POST',  
    7.         headers: {   
    8.             "Accept""application/json;odata=verbose",  
    9.             "X-RequestDigest": $("#__REQUESTDIGEST").val()   
    10.         },  
    11.         success: function (data) {  
    12.             console.log("Feature Activated");  
    13.         },  
    14.         error: function(data) {  
    15.             console.log(data.responseJSON.error.message.value);  
    16.         }  
    17.     });  
    18. }  



Deactivate the site collection feature (Site scope):


In the above section, we have seen how we can activate the site collection feature. Here we will see how we can deactivate the feature.
  • To deactivate the site feature, use the remove method on URL. The necessary parameters to be passed in the query is feature id.
  • POST method will be used to accomplish the task.
  • RequestDigest will be passed in the header to validate the page requests.
    1. // Disables site collection feature (Site scoped feature)  
    2. function DisableSiteCollectionFeature(){  
    3.     var featuresURI = sitecollectionURL + "/_api/site/features/remove('151d22d9-95a8-4904-a0a3-22e4db85d1e0')"// Cross-Site Collection Publishing Feature ID  
    4.     $.ajax({  
    5.         url: featuresURI,  
    6.         method: 'POST',  
    7.         headers: {   
    8.             "Accept""application/json;odata=verbose",  
    9.             "X-RequestDigest": $("#__REQUESTDIGEST").val()   
    10.         },  
    11.         success: function (data) {  
    12.             console.log("Feature De-Activated");  
    13.         },  
    14.         error: function(data) {  
    15.             console.log(data.responseJSON.error.message.value);  
    16.         }  
    17.     });  
    18. }  
Note: The above set of operations needs to be called to get it executed.
  1. $(document).ready(function(){  
  2.     GetSiteCollectionFeatures(); // Retrieves all the site collection features enabled (site scoped features)  
  3.     GetSiteCollectionFeatureByID(); // Retrieves the site collection feature by id enabled (site scoped features)  
  4.     EnableSiteCollectionFeature(); // Enables site collection feature (Site scoped feature)  
  5.     DisableSiteCollectionFeature(); // Disables site collection feature (Site scoped feature)  
  6. });