How to Delete a List in SharePoint 2013 Online Using REST API

Article

Introduction

SharePoint 2013 introduces a Representational State Transfer (REST) service that is comparable to the existing SharePoint client object models. This allows the developers to interact remotely with SharePoint data using any technology that supports REST web requests. This means that developers can perform Create, Read, Update and Delete (CRUD) operations from their apps for SharePoint, solutions and client applications, using REST web technologies and standard Open Data Protocol (OData) syntax. In this article you will see the following:

Create an app using NAPA Tool in SharePoint 2013 Online.
Cross-Domain Requests.
Delete a list using the REST API.

Endpoint URI

https://c986.sharepoint.com/_api/web/Lists/getbytitle(‘listname’)

Note: If you are making cross-domain requests then you need to add SP.AppContextSite(@target) and ?@target='<host web url>' to the endpoint URI.

Properties

The following properties must be used in a REST request for deleting the list:

IF-MATCH header: It is required when POST requests for DELETE operation. Description: 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":"*".
X-HTTP-Method header: It is required when POST requests for DELETE operations. Description: Used to specify that the request performs a delete operation. Example: "X-HTTP-Method":"DELETE".

Use the following procedure to create an app using the NAPA Tool:

Navigate to the SharePoint 2013 Online site.
Click on Site Contents in the quick launch bar.
Click on “Napa” Office 365 Development Tools.
Click on Add New Project.
Select App for SharePoint, enter the Project name and then click on Create.

Permissions

Ensure appropriate permission is provided to access the content. Click on Properties button, and then click on Permissions. Set the required permission to access the content.

Default.aspx

Replace the contenst of Default.aspx with the following:

<%-- The markup and script in the following Content element will be placed in the <head>of the page --%>

<asp:content contentplaceholderid="PlaceHolderAdditionalPageHead" runat="server">

</asp:content>

<%-- The markup in the following Content element will be placed in the TitleArea of the page --%>

<asp:content contentplaceholderid="PlaceHolderPageTitleInTitleArea" runat="server">Page Title</asp:content>

<%-- The markup and script in the following Content element will be placed in the <body>of the page --%>

<asp:content contentplaceholderid="PlaceHolderPageTitleInTitleArea" runat="server">REST API Examples</asp:content>

<%-- The markup and script in the following Content element will be placed in the <body>of the page --%>

<asp:content contentplaceholderid="PlaceHolderMain" runat="server">

<div>

<p>

<b>Delete List</b>

<br />

<button id="deletelistbutton">Delete List</button>

</p>

</div>

</asp:content>

App.js

Replace the contenst of App.js with the following:

'use strict';

var hostweburl;

var appweburl;

// Load the required SharePoint libraries.

$(document).ready(function () {

//Get the URI decoded URLs.

hostweburl = decodeURIComponent(

getQueryStringParameter("SPHostUrl"));

appweburl = decodeURIComponent(

getQueryStringParameter("SPAppWebUrl"));

//Assign events to buttons

$("#deletelistbutton").click(function (event) {

deletList();

event.preventDefault();

});

// Resources are in URLs in the form:

// web_url/_layouts/15/resource

var scriptbase = hostweburl + "/_layouts/15/";

// Load the js file and continue to load the page with information.

// SP.RequestExecutor.js to make cross-domain requests

$.getScript(scriptbase + "SP.RequestExecutor.js");

});

// Utilities

// Retrieve a query string value.

// For production purposes you may want to use a library to handle the query string.

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];

}

// Delete list

function deletList() {

var listName = document.getElementById("deletelistname").value;

var executor;

// Initialize the RequestExecutor with the app web URL.

executor = new SP.RequestExecutor(appweburl);

executor.executeAsync({

url: appweburl + "/_api/SP.AppContextSite(@target)/web/Lists/getbytitle('" + listName + "')?@target='" + hostweburl + "'",

method: "POST",

headers: {

"IF-MATCH": "*",

"X-HTTP-Method": "DELETE"

success: deleteListSuccessHandler,

error: deleteListErrorHandler

});

}

// Success Handler

function deleteListSuccessHandler(data) {

alert("List deleted successfully")

}

// Error Handler

function deleteListErrorHandler(data, errorCode, errorMessage) {

alert("Could not delete the list: " + errorMessage);

}

Deploy the App

Click on Run Project.
The app will be packaged, deployed and launched.
Click on "Click here to launch your app in a new window".
Click on Trust it.
Enter the list name and then click on Delete List button.
The List is deleted successfully in the host site.

Summary

Thus in this article you saw how to delete a list in the host site using the REST API in SharePoint 2013 Online.

Up Next

Ebook Download

View all

Configure MinRole Search and Cloud Hybrid Features in SharePoint Server 2016 and Office 365

Read by 363 people

Download Now!

Learn

View all