In Focus

How to Get All the Lists in SharePoint 2013 Online Using REST API

In this article you will see how to get all the lists using the REST API in SharePoint 2013 Online.

In this article you will see how to get all the lists using the REST API in SharePoint 2013 Online.

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.
  • Get all the lists from the host site using REST API.

Endpoint URI:

http://sitename/_api/web/lists

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

HTTP Request:

GET: Read a Resource.

Use the following procedure to create a sample app using the NAPA Tool:

  1. Navigate to the SharePoint 2013 Online site.
  2. Click on Site Contents in the quick launch bar.
  3. Click on “Napa” Office 365 Development Tools.

  4. Click on Add New Project.

  5. 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 the Properties button and then click on Permissions. Set the required permission to access the content.


Default.aspx:

Replace 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">
<
script type="text/javascript" src="https://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.9.1.min.js"></script>
<
script type="text/javascript" src="/_layouts/15/sp.runtime.js"></script>
<
script type="text/javascript" src="/_layouts/15/sp.js"></script>
<!-- Add your CSS styles to the following file -->

<link rel="Stylesheet" type="text/css" href="../Content/App.css" />
<!-- Add your JavaScript to the following file -->

<script type="text/javascript" src="../Scripts/App.js"></script>
</
asp:Content>
<%
-- The markup in the following Content element will be placed in the TitleArea 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>Lists</b>
<
br />
<
select style="height:300px; width:250px" multiple="multiple" id="selectLists"></select>
</
p>
</
div>
</
asp:Content>

App.js:

Replace 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"));

// 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 about the site's Lists.
// SP.RequestExecutor.js to make cross-domain requests
$.getScript(scriptbase + "SP.RequestExecutor.js", loadPage);
});

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

function loadPage() {
getLists();
}

//Retrieve all of the site's Lists.
function getLists() {
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?@target='" + hostweburl + "'",
method: "GET",
headers: {
"Accept": "application/json; odata=verbose"
},
success: getListsSuccessHandler,
error: getListsErrorHandler
});
}
//Populate the selectLists control after retrieving all of the site's Lists.
function getListsSuccessHandler(data) {
var jsonObject = JSON.parse(data.body);
var selectLists = document.getElementById("selectLists");
if (selectLists.hasChildNodes()) {
while (selectLists.childNodes.length >= 1) {
selectLists.removeChild(selectLists.firstChild);
}
}
var results = jsonObject.d.results;
for (var i = 0; i < results.length; i++) {
var selectOption = document.createElement("option");
selectOption.value = results[i].Title;
selectOption.innerText = results[i].Title;
selectLists.appendChild(selectOption);
}
}

Deploy the App:

  1. Click on Run Project.

  2. The app will be packaged, deployed and launched.



  3. Click on “Click here to launch your app in a new window”.

  4. Click on Trust it.

  5. All the host site lists are displayed.


Summary:

Thus in this article you saw how to get all the lists using the REST API in SharePoint 2013 Online.