Post
Ask Question

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

In this article you will see how to get all the site groups 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 by 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:

  • How to create an app using the NAPA Tool in SharePoint 2013 Online.
  • Cross-Domain Requests.
  • Get all the site groups from the host site using REST API.

Endpoint URI

http://sitename/_api/web/sitegroups

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.

HTTP Request

GET: Read a Resource.

Create an 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.

    Office 365 Development Tools

  4. Click on Add New Project.



  5. Select App for SharePoint, enter the Project name and then click on Create.

    App for SharePoint

Permissions

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

Permissions

Default.aspx

Replace the contents 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">

<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>Site Groups</b>

<br />

<select style="height:300px; width:310px" multiple="multiple" id="selectSiteGroups"></select>

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

        // 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 groups.

        // 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() {

        getSiteGroups();

    }

    //Retrieve all of the site groups

    function getSiteGroups() {

        var executor;

        // Initialize the RequestExecutor with the app web URL.

        executor = new SP.RequestExecutor(appweburl);

        executor.executeAsync({

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

            method: "GET",

            headers: {

                "Accept": "application/json; odata=verbose"

            },

            success: getSiteGroupsSuccessHandler,

            error: getSiteGroupsErrorHandler

        });

    }

    //Populate the selectSiteGroups control after retrieving all of the site groups.

    function getSiteGroupsSuccessHandler(data) {

        var jsonObject = JSON.parse(data.body);

        var selectSiteGroups = document.getElementById("selectSiteGroups");

        if (selectSiteGroups.hasChildNodes()) {

            while (selectSiteGroups.childNodes.length >= 1) {

                selectSiteGroups.removeChild(selectSiteGroups.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;

            selectSiteGroups.appendChild(selectOption);

        }

    }

    function getSiteGroupsErrorHandler(data, errorCode, errorMessage) {

        alert("Could not get site groups: " + errorMessage);

    }

Deploy the App

  1. Click on Run Project.

    Run

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

    app

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

    window

  4. Click on Trust it.

    Trust it

  5. All site groups from host site are displayed.


Summary

Thus in this article you saw how to get all the site groups from the website using the REST API in SharePoint 2013 Online.


Similar Articles