Post
Ask Question

Add a Field in the List in SharePoint 2013 Online Using REST API

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:

  • Create an app using the NAPA Tool in SharePoint 2013 Online.
  • Cross-Domain Requests.
  • Add a field in the list using the REST API.

Endpoint URI

https://c986.sharepoint.com/_api/web/Lists/getbytitle('Custom%20List')/fields

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

POST: Create or update a resource.

Use the following procedure to 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.

    Add New Project

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

    App for SharePoint

Permissions

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

Permissions

Default.aspx

Replace the contenst 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>Create List Field</b>

<br />

<input type="text" value="Field Name Here" id="createlistfieldname" />

<button id="createlistfieldbutton">Create Field</button>

</p>

</div>

</asp:content>  

App.js

Replace the contenst 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

    $("#createlistfieldbutton").click(function(event) {

    createField();

    event.preventDefault();

});

 

// Resources are in URLs in the form:

// web_url/_layouts/15/resource

var scriptbase = hostweburl + "/_layouts/15/";

 

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

    }

}

 

// Create a new list field

function createField() {

var fieldName = document.getElementById("createlistfieldname").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('Custom List')/fields?@target='" + hostweburl + "'",

    method: "POST",

    body: "{ '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 2, 'Title':'" + fieldName + "'}",

    headers: {

    "content-type": "application/json; odata=verbose",

    },

    success: createListFieldSuccessHandler,

    error: createListFieldErrorHandler

    });

}

 

// Success Handler

function createListFieldSuccessHandler(data) {

alert("List Field Created successfully")

}

 

// Error Handler

function createListFieldErrorHandler(data, errorCode, errorMessage) {

alert("Could not create a new field: " + errorMessage);

}  

Deploy the App

  1. Click on Run Project.

    Run Project

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

    app

    Installing

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

    new window

  4. Click on Trust it.

    Trust it

  5. Enter the title for the field and then click on Create Field button.

    Create Field button

  6. A new field is created successfully in the host site.

Note: Please refer to SP.FieldType Enumeration for field type.

Summary

Thus in this article you saw how to add a field in the host site using the REST API in SharePoint 2013 Online.


Similar Articles