Getting List Items From a List in SharePoint 2013 Using REST API

In this article, we will discuss how to retrieve list items from a SharePoint List using the REST API.

Introduction

Welcome to the SharePoint 2013 REST Series. In my previous article, Creating a SharePoint 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 retrieve list items from a SharePoint List using the REST API.

The SharePoint 2013 environment adds the ability 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 list of access points that allow you to gain 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

Permission 

In SharePoint 2013, use POST to create entities such as lists and sites.

Step 2: Navigate to the App.js file. Copy the following code and paste it in.

Code
  1. 'use strict';  
  2. var hostweburl;   
  3. var appweburl;   
  4.    
  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 () {  
  8.           
  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/";    
  19.    
  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  
  22.           
  23.          // Load the js files and continue to the successHandler  
  24.             $.getScript(scriptbase + "SP.RequestExecutor.js", execCrossDomainRequest);  
  25.              });  
  26.               
  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);             
  33.             var listName="CustomList”  
  34.   
  35.             // Issue the call against the app web.  
  36.             // To get the title using REST we can hit the endpoint:  
  37.   
  38.             //      appweburl/_api/web/lists/getbytitle('listname')/items  
  39.             // The response formats the data in the JSON format.  
  40.   
  41.             // The functions successHandler and errorHandler attend the  
  42.             //      sucess and error events respectively.  
  43.             executor.executeAsync(  
  44.                 {  
  45.                   
  46.              url:appweburl + "/_api/SP.AppContextSite(@target)/web/lists/getbyTitle('Master')/Items?$select=Title&@target='" + hostweburl + "'",  
  47.             
  48.             method: "GET",  
  49.             headers: { "Accept""application/json; odata=verbose" },  
  50.             success: function (data) {  
  51.                 alert("success: " + JSON.stringify(data));  
  52.             },  
  53.             error: function (err) {  
  54.                 alert("error: " + JSON.stringify(err));  
  55.             }  
  56.   
  57.              }           
  58.             );               
  59.           }                  
  60.     
  61.     // This function prepares, loads, and then executes a SharePoint query to get   
  62.     // the current users information  
  63.       
  64. //Utilities   
  65.    
  66. // Retrieve a query string value.   
  67. // For production purposes you may want to use   
  68. // a library to handle the query string.   
  69. function getQueryStringParameter(paramToRetrieve) {   
  70.     var params =   
  71.         document.URL.split("?")[1].split("&");     
  72.     for (var i = 0; i < params.length; i = i + 1) {   
  73.         var singleParam = params[i].split("=");   
  74.         if (singleParam[0] == paramToRetrieve)   
  75.             return singleParam[1];   
  76.     }   
  77. }  
Screenshot

Screenshot

Code

Code Walkthrough

A .GET Method in REST API

SharePoint 2013 REST service supports sending GET commands to retrieve information.

In this example, Master is a custom SharePoint list, where Title details are being displayed.
  1. url:appweburl + "/_api/SP.AppContextSite(@target)/web/lists/getbyTitle('Master')/Items?$select=Title&@target='" + hostweburl + "'",  
  2.     method: "GET",  
  3.     headers: { "Accept""application/json; odata=verbose" },  
  4.     success: function (data) {  
  5.     alert("success: " + JSON.stringify(data));  
  6.    },  
  7.     error: function (err) {  
  8.     alert("error: " + JSON.stringify(err));  
  9.     }  
  10.   }  
  11. ); 
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);  
  5. var listName="CustomLibrary"
Summary

I hope this article helps you.