How to Display the List in the Quick Launch Bar in SharePoint Online Using REST API

<%-- 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">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>Display the list on Quick Launch</b>
            <br />
            <input type="text" value="List Name Here" id="listnametext" />
            <button id="onquicklaunchbutton">On Quick Launch</button>
        </p>
    </div>
</asp:Content>

App.js

Replace the contents 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
    $("#onquicklaunchbutton").click(function (event) {
        onQuickLaunch();
        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.
    // 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];
    }
}
// Display the list on quick launch
function onQuickLaunch() {
    var listnametext = document.getElementById("listnametext").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('" + listnametext + "')?@target='" + hostweburl + "'",
        method: "POST",
        body: "{ '__metadata': { 'type': 'SP.List' }, 'OnQuickLaunch': true}",
        headers: {
            "IF-MATCH": "*",
            "X-HTTP-Method": "MERGE",
            "content-type": "application/json;odata=verbose"
        },
        success: onQuickLaunchSuccessHandler,
        error: onQuickLaunchErrorHandler
    });
}
// Success Handler
function onQuickLaunchSuccessHandler(data) {
    alert("List is displayed on quick launch.")
}
// Error Handler
function onQuickLaunchErrorHandler(data, errorCode, errorMessage) {
    alert("Could not display the list on quick launch: " + errorMessage);
}

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. Enter the list name and then click on the On Quick Launch button.
   
   
   
6. The Custom list is displayed in the quick launch bar.

Summary

Thus in this article you saw how to display the list in the quick launch bar using the REST API in SharePoint 2013 Online.