Introduction

Welcome to the SharePoint 2013 REST Series. In my previous article, we saw how to create a folder from a Document Library in SharePoint 2013 using the REST API.

In this article, we will discuss how to delete a folder in a Document Library in a SharePoint List using the REST API.

The SharePoint 2013 environment adds the ability for you to remotely interact with SharePoint sites using REST. So you can talk to SharePoint objects by using any technology that supports standard REST capabilities. In this way, SharePoint data can be accessed anywhere and everywhere.

List of REST Access Points

The following is a list of access points that gives you entry into granular access points.

  1. Site

    http://server/site/_api/site
  2. Web

    http://server/site/_api/web
  3. User Profile

    http:// server/site/_api/SP.UserProfiles.PeopleManager
  4. Search

    http:// server/site/_api/search
  5. Publishing

    http:// server/site/_api/publishing

List of REST End Points

The following is a list of end points that are the most commonly used in a SharePoint list.

Note: The following code is tested in my SP 2013 online environment.

Step 1: Before writing your code, please ensure you havev sufficient permission to access cross-domain requests. So I have given full permission to all the contents listed below.

Tenant

Full Permission

Site Collection

Full Permission

Web

Full Permission

List

Full Permission

permission

Step 2: Navigate to the App.js file and copy the following code and the Paste it in.

Code
  1. 'use strict';
  2. var hostweburl;
  3. var appweburl;
  5. // This code runs when the DOM is ready and creates a context object which is
  6. // needed to use the SharePoint object model
  7. $(document).ready(function () {
  9. //Get the URI decoded URLs.
  10. hostweburl =
  11. decodeURIComponent(
  12. getQueryStringParameter("SPHostUrl"));
  13. appweburl =
  14. decodeURIComponent(
  15. getQueryStringParameter("SPAppWebUrl"));
  16. // Resources are in URLs in the form:
  17. // web_url/_layouts/15/resource
  18. var scriptbase = hostweburl + "/_layouts/15/";
  20. // Load the js file and continue to load the page with information about the list top level folders.
  21. // SP.RequestExecutor.js to make cross-domain requests
  23. // Load the js files and continue to the successHandler
  24. $.getScript(scriptbase + "SP.RequestExecutor.js", execCrossDomainRequest);
  25. });
  27. // Function to prepare and issue the request to get
  28. // SharePoint data
  29. function execCrossDomainRequest() {
  30. // executor: The RequestExecutor object
  31. // Initialize the RequestExecutor with the app web URL.
  32. var executor = new SP.RequestExecutor(appweburl);
  34. var serverRelativeUrl = "/Lib/";
  35. executor.executeAsync(
  36. {
  37. url: appweburl + "/_api/SP.AppContextSite(@target)/web/GetFolderByServerRelativeUrl('" + serverRelativeUrl + "')?@target='" + hostweburl + "'",
  38. method: "POST",
  39. headers: {
  40. "IF-MATCH": "*",
  41. "X-HTTP-Method": "DELETE"
  42. },
  43. success: function (data) {
  44. alert("success: " + JSON.stringify(data));
  45. },
  46. error: function (err) {
  47. alert("error: " + JSON.stringify(err));
  48. }
  49. }
  50. );
  51. }
  52. }
  53. // This function prepares, loads, and then executes a SharePoint query to get
  54. // the current users information
  56. //Utilities
  58. // Retrieve a query string value.
  59. // For production purposes you may want to use
  60. // a library to handle the query string.
  61. function getQueryStringParameter(paramToRetrieve) {
  62. var params =
  63. document.URL.split("?")[1].split("&");
  64. for (var i = 0; i < params.length; i = i + 1) {
  65. var singleParam = params[i].split("=");
  66. if (singleParam[0] == paramToRetrieve)
  67. return singleParam[1];
  68. }
  69. }
  71. //Retrieve the form digest value.
  72. //Store the value of the form digest.
  73. function contextSuccessHandler(data) {
  74. alert("List Created Successfully");
  75. }
  77. function contextErrorHandler(data, errorCode, errorMessage) {
  78. alert(data);
  79. alert(errorCode);
  80. alert("Could not get context info: " + errorMessage);
  81. }

Screenshot

code

code

Step 3: When deploying, you will be prompted with the following screen. Press Trust it and proceed with the deployment.

deployment
Code Walkthrough

A. Post Method in REST API

The SharePoint 2013 REST service supports sending POST commands that include object definitions to endpoints that represent collections. In this example, Test List is a custom SharePoint list where list items are updated.

B. Request Executor.JS

The cross-domain library lets you interact with more than one domain in your remote app page through a proxy. SP.RequestExecutor.js acts as a cross-domain library to fetch or create a SharePoint list from your APP domain.

  1. function execCrossDomainRequest() {
  2. // executor: The RequestExecutor object
  3. // Initialize the RequestExecutor with the app web URL.
  4. var executor = new SP.RequestExecutor(appweburl);

Summary

I hope this article helps you. Happy SharePointing.