Introduction
Welcome to the SharePoint 2013 REST Series. In my previous article, Getting List Items From a List in SharePoint 2013 Using REST API we saw how to create a Custom List using the REST API.
In this article, we will discuss how to delete 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 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 give you entry into granular access points.
- Site
http://server/site/_api/site
- Web
http://server/site/_api/web
- User Profile
http:// server/site/_api/SP.UserProfiles.PeopleManager
- Search
http:// server/site/_api/search
- Publishing
http:// server/site/_api/publishing
List of REST End Points
The following is a list of End points that are very commonly used in a SharePoint list.
- http://server/site/_api/web/lists
- http://server/site/_api/lists/getbytitle('listname')
- http://server/site/_api/web/lists(‘guid’)
- http://server/site/_api/web/lists/getbytitle(‘Title’)
Note: The following code is tested in my SP 2013 online environment.
Step 1: Before writing your code, please ensure that you have 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 |
Step 2:
Navigate to the App.js file. Copy the following code and paste it in.
Code
- 'use strict';
- var hostweburl;
- var appweburl;
-
-
- $(document).ready(function () {
-
- hostweburl =
- decodeURIComponent(
- getQueryStringParameter("SPHostUrl"));
- appweburl =
- decodeURIComponent(
- getQueryStringParameter("SPAppWebUrl"));
-
-
- var scriptbase = hostweburl + "/_layouts/15/";
-
-
-
-
-
- $.getScript(scriptbase + "SP.RequestExecutor.js", execCrossDomainRequest);
- });
-
-
-
- function execCrossDomainRequest() {
-
-
- var executor = new SP.RequestExecutor(appweburl);
- var listName="CustomList”
-
-
-
-
-
-
-
-
-
- executor.executeAsync(
- {
- url:appweburl + "/_api/SP.AppContextSite(@target)/web/lists/getbyTitle('Master')/Items?$select=Title&@target='" + hostweburl + "'",
-
- method: "GET",
- headers: { "Accept": "application/json; odata=verbose" },
- success: function (data) {
- alert("success: " + JSON.stringify(data));
- },
- error: function (err) {
- alert("error: " + JSON.stringify(err));
- }
- }
- );
- }
-
-
-
-
-
-
- function getQueryStringParameter(paramToRetrieve) {
- var params =
- document.URL.split("?")[1].split("&");
- for (var i = 0; i < params.length; i = i + 1) {
- var singleParam = params[i].split("=");
- if (singleParam[0] == paramToRetrieve)
- return singleParam[1];
- }
- }
Screenshot
Step 3:
While deploying, you will be prompted with the following screen. Press Trust it and proceed to with the deployment.
Code WalkthroughA . GET Method in REST API
A SharePoint 2013 REST service supports sending POST commands that include object definitions to endpoints that represent collections. In this example, Master is a custom SharePoint list that will be deleted..
- executor.executeAsync(
- {
- url: appweburl + "/_api/SP.AppContextSite(@target)/web/Lists/getbytitle('" + listName + "')?@target='" + hostweburl + "'",
- method: "POST",
- headers: {
- "IF-MATCH": "*",
- "X-HTTP-Method": "DELETE"
- },
- success: function (data) {
- alert("success: " + JSON.stringify(data));
- },
- error: function (err) {
- alert("error: " + JSON.stringify(err));
- }
IF-MATCH header
Provides a way to verify that the object being changed has not been changed since it was last retrieved. Or, lets you specify to overwrite any changes, as shown in the following example: "IF-MATCH":"*"
HTTP-Method:”Delete”
A HTTP DELETE command against the specific endpoint URL to delete the SharePoint object represented by that endpoint. For recyclable objects, such as lists, files, and list items, this results in a Recycle operation.
B. Request Executor.JSThe 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 SharePoint list from your APP domain.
- function execCrossDomainRequest() {
-
-
- var executor = new SP.RequestExecutor(appweburl);
- var listName="Master";
Summary
I hope this article helps you. Happy Share Pointing.