Post
Ask Question

Identify Whether Search is Enabled for SharePoint Site Using REST API

Syntax

REST API Endpoint:

https://SharePointSiteURL/_api/web?$select=NoCrawl

REST API endpoint to use in Add-ins:

<appweburl>/_api/SP.AppContextSite(@target)/web?$select= NoCrawl&@target=<hostweburl>

Embed Code Snippet

The following code snippet can be embeded in SharePoint page or in content editor web part as a script. This example is used to check whether the search is enabled for the SharePoint website.

  1. <script type="text/javascript" src="/SiteAssets/Scripts/jquery.min.js"></script>    
  2. <script type="text/javascript">    
  3.     $.ajax(    
  4.     {    
  5.         url: _spPageContextInfo.webAbsoluteUrl + "/_api/web?$select=nocrawl", //THE ENDPOINT      
  6.         method: "GET",    
  7.         headers:    
  8.         {    
  9.             "Accept": "application/json; odata=verbose"    
  10.         },    
  11.         success: function(data)    
  12.         {    
  13.             //RESULTS HERE!!      
  14.             console.log(data.d.NoCrawl)    
  15.             if (!data.d.NoCrawl)    
  16.                 alert('Search enabled on this site.');    
  17.             else    
  18.                 alert('Search disabled on this site.');    
  19.         }    
  20.     });    
  21. </script>   

Add-in Code Snippet

The following code snippet is used in SharePoint Add-in to get the boolean property of NoCrawl for the SharePoint website.

  1. // Load the js files and continue to the successHandler      
  2. $.getScript(scriptbase + "SP.RequestExecutor.js", execCrossDomainRequest);    
  3. // Function to prepare and issue the request to get      
  4. // SharePoint data      
  5. function execCrossDomainRequest()    
  6. {    
  7.     // Initialize the RequestExecutor with the add-in web URL.      
  8.     var executor = new SP.RequestExecutor(appweburl);    
  9.     // Issue the call against the add-in web.      
  10.     // To get the NoCrawl property using REST we can hit the endpoint:      
  11.     // appweburl/_api/web?select=NoCrawl&@target=hostweburl      
  12.     // The response formats the data in the JSON format.      
  13.     executor.executeAsync(    
  14.     {    
  15.         url: appweburl + "/_api/SP.AppContextSite(@target)/web?$select=nocrawl&@target='" + hostweburl + "'",    
  16.         method: "GET",    
  17.         headers:    
  18.         {    
  19.             "Accept": "application/json; odata=verbose"    
  20.         },    
  21.         success: successHandler,    
  22.         error: errorHandler    
  23.     });    
  24. }    
  25. // Function to handle the success event.      
  26. function successHandler(data)    
  27. {    
  28.     var jsonObject = JSON.parse(data.body)    
  29.         //jsonObject.d.NoCrawl returns true if enabled otherwise it returns false      
  30.     console.log('Search disabled on this site: ' + jsonObject.d.NoCrawl);    
  31.     if (!jsonObject.d.NoCrawl)    
  32.         $('#message').html('Search enabled on this site.');    
  33.     else    
  34.         $('#message').html('Search disabled on this site.');    
  35. }    
  36.     
  37. function errorHandler(data, errorCode, errorMessage)    
  38. {    
  39.     console.log("Could not complete cross-domain call: " + errorMessage);    
  40. }