Introduction
Welcome to my SharePoint 2013 REST Series. In my previous article Creating a Document Library using SharePoint 2013 REST API, we saw how to create a Document Library using the REST API.
In this article, we will discuss how to create a SharePoint List using the REST API.
The SharePoint 2013 environment adds the ability for you 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 a list of access points that provide 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 most commonly used on 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 |
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
- 'use strict';
- var hostweburl;
- var appweburl;
-
-
-
- $(document).ready(function () {
-
-
- hostweburl =
- decodeURIComponent(
- getQueryStringParameter("SPHostUrl"));
- appweburl =
- decodeURIComponent(
- getQueryStringParameter("SPAppWebUrl"));
-
-
- var scriptbase = hostweburl + "/_layouts/15/";
-
-
-
-
-
- $.getScript(scriptbase + "SP.RequestExecutor.js", execCrossDomainRequest);
- });
-
-
-
- function execCrossDomainRequest() {
-
-
- var executor = new SP.RequestExecutor(appweburl);
- var listName="CustomList”
-
-
-
-
-
-
-
-
-
- executor.executeAsync(
- {
- url: appweburl + "/_api/SP.AppContextSite(@target)/web/Lists?@target='" + hostweburl + "'",
- method: "POST",
- body: "{ '__metadata': { 'type': 'SP.List' }, 'BaseTemplate': 100,'Description': '" + listName + "', 'Title':'" + listName + "'}",
- headers: {"content-type": "application/json; odata=verbose"},
- success: contextSuccessHandler,
- error: contextErrorHandler
- }
- );
- }
-
-
-
-
-
-
-
-
- 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 contextSuccessHandler(data) {
- alert("List Created Successfully");
Screenshot:
Code Walkthrough
A. Post Method in REST API
A SharePoint 2013 REST service supports sending POST commands that include object definitions to endpoints that represent collections. For example, you could send a POST command that includes a new list object definition in ATOM to the following URL, to create a SharePoint list:
- executor.executeAsync(
- {
- url: appweburl + "/_api/SP.AppContextSite(@target)/web/Lists?@target='" + hostweburl + "'",
- method: "POST",
- body: "{ '__metadata': { 'type': 'SP.List' }, 'BaseTemplate': 101,'Description': '" + listName + "', 'Title':'" + listName + "'}",
- headers: {"content-type": "application/json; odata=verbose"},
- success: contextSuccessHandler,
- error: contextErrorHandler
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.
- function execCrossDomainRequest() {
-
-
- var executor = new SP.RequestExecutor(appweburl);
- var listName="CustomLibrary";
Summary
I hope this article helps you. Happy SharePointing.