List Operations In SharePoint 2016 Using REST API

SharePoint 2016 general availability had been announced in the Future Of SharePoint conference in May 2016. The series that discusses the installation of SharePoint 2016 in Azure can be found at C# Corner from the below links:

• SharePoint 2016 installation in Azure-Part 1
• SharePoint 2016 installation in Azure-Part 2
• SharePoint 2016 installation in Azure-Part 3

In this article we will see how to interact with List in SharePoint 2016 using REST API.The scope of the article is :

• Create a new list
• Fetch the properties of the list
• Update the properties of the list
• Delete the list

All of these operations will be carried out by making use of the corresponding REST API endpoint.

Create List using REST

We can create the item by issuing a POST request. The REST URL endpoint, used for the operation is:

/_api/web/Lists

We will be creating a key value pair of information, which will be used to create a list. The list creation information is shown below. It will be sent as JSON in the data attribute of the REST call.

var metadata =
    {
    __metadata: {
        'type': 'SP.List'
    },
    BaseTemplate: 100,
    Description: 'This is a new SharePoint List created using REST',
    Title: 'REST List'
};

The header for the POST request is as follows. It signifies the data type for the data submitted, as well the data type for the returned value.

headers:

    "accept": "application/json;odata=verbose",
    "X-RequestDigest": $("#__REQUESTDIGEST").val(),
    "content-Type": "application/json;odata=verbose"
},

Output





Full Code

<script language="javascript" type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js"></script>
<script language="javascript" type="text/javascript">
    $(document).ready(function() {
        var newListUrl = "/_api/web/Lists";
        var metadata = {
            __metadata: {
                'type': 'SP.List'
            },
            BaseTemplate: 100,
            Description: 'This is a new SharePoint List created using REST',
            Title: 'REST List'
        };
        addNewItem(newListUrl, metadata)
    });

    function addNewItem(newListUrl, metadata) {
        $.ajax({
            url: _spPageContextInfo.webAbsoluteUrl + newListUrl,
            type: "POST",
            headers: {
                "accept": "application/json;odata=verbose",
                "X-RequestDigest": $("#__REQUESTDIGEST").val(),
                "content-Type": "application/json;odata=verbose"
            },
            data: JSON.stringify(metadata),
            success: function(data) {
                console.log(data);
                console.log("List created successfully.");
            },
            error: function(error) {
                alert(JSON.stringify(error));
            }
        });
    }
</script>

Get List Properties

The list properties can be retrieved by issuing the GET request, using the REST URL endpoint:

"/_api/Web/Lists/GetByTitle('REST List')

The header section for the GET request is plain and simple.

headers:

    "accept": "application/json;odata=verbose
},

In the success callback, we can read the list properties from the returned object ‘data.d’ by indexing into it.

Output



Full Code

<script language="javascript" type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js"></script>
<script language="javascript" type="text/javascript">
    $(document).ready(function() {
        var newListUrl = "/_api/Web/Lists/GetByTitle('REST List')";
        getListProperties(newListUrl)
    });

    function getListProperties(newListUrl) {
        $.ajax({
            url: _spPageContextInfo.webAbsoluteUrl + newListUrl,
            type: "GET",
            headers: {
                "accept": "application/json;odata=verbose",
            },
            success: function(data) {
                console.log("List Description :" + data.d["Description"]);
                console.log("EnableFolderCreation ? :" + data.d["EnableFolderCreation"]);
                console.log("ListItemEntityTypeFullName : " + data.d["ListItemEntityTypeFullName"]);
            },
            error: function(error) {
                alert(JSON.stringify(error));
            }
        });
    }
</script>

Update List Properties

The list properties can be updated by issuing the MERGE call with the REST URL endpoint:

"/_api/Web/Lists/GetByTitle('REST List')”

The information to update can be assigned to the metadata key and assigned to the ‘data’ attribute of the rest call.

var metadata =
    {
    __metadata: {
        'type': 'SP.Group'
    },
    Description: "This is an Updated Description"
};
updateList(newListUrl, metadata)
});

The header section resembles what is given below:

headers:

    "accept": "application/json;odata=verbose",
    "X-RequestDigest": $("#__REQUESTDIGEST").val(),
    "content-Type": "application/json;odata=verbose",
    "IF-MATCH": "*"
},

Output

The success message has come up in the console .



Checking the description of the list, we can see, that it has been updated.



Full Code

<script language="javascript" type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js"></script>
<script language="javascript" type="text/javascript">
    $(document).ready(function()
    {
        var newListUrl = "/_api/Web/Lists/GetByTitle('REST List')";
        var metadata =
            {
            __metadata:
              {
                'type': 'SP.Group'
            },
            Description: "This is an Updated Description"
        };
        updateList(newListUrl, metadata)
    });

    function updateList(newListUrl, metadata) {
        $.ajax({
            url: _spPageContextInfo.webAbsoluteUrl + newListUrl,
            type: "MERGE",
            data: JSON.stringify(metadata),
            headers: {
                "accept": "application/json;odata=verbose",
                "X-RequestDigest": $("#__REQUESTDIGEST").val(),
                "content-Type": "application/json;odata=verbose",
                "IF-MATCH": "*"
            },
            success: function(data) {
                console.log("List description updated.");
            },
            error: function(error) {
                alert(JSON.stringify(error));
            }
        });
    }
</script>

Delete List

In order to delete the list, we can issue a Delete request to the Server, using the REST URL endpoint:

"/_api/Web/Lists/GetByTitle('REST List')

‘GetByTitle’ method specifies the list to be deleted. In the header section, we can specify the ‘accept’ and ‘X-RequestDigest’ attribute , which specifies the return data type and the form digest value respectively.

The header section is shown below:

headers:

    "accept": "application/json;odata=verbose",
    "X-RequestDigest": $("#__REQUESTDIGEST").val(),
    "IF-MATCH": "*"
},

Full Code

<script language="javascript" type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js"></script>
<script language="javascript" type="text/javascript">
    $(document).ready(function()
    {
        var existingListUrl = "/_api/Web/Lists/GetByTitle('REST List')";
        deleteList(existingListUrl);
    });

    function deleteList(existingListUrl) {
        $.ajax({
            url: _spPageContextInfo.webAbsoluteUrl + existingListUrl,
            type: "DELETE",
            headers: {
                "accept": "application/json;odata=verbose",
                "X-RequestDigest": $("#__REQUESTDIGEST").val(),
                "IF-MATCH": "*"
            },
            success: function(data) {
                console.log("The list has been successfully deleted.");
            },
            error: function(error) {
                alert(JSON.stringify(error));
            }
        });
    }
</script>

Let’s see how we can implement it in SharePoint. Save the script as a text file and upload it to the site assets library.

SharePoint Implementation 

• Go to the edit settings of the SharePoint page and click Web part from the Insert tab.
  
  
  
  
• Add Content Editor Web part.
  
  
  
  
• Click Edit Web art from Content Edit Web part. Assign the URL of the script text file and click apply.
  
  
  
  
• Click Apply and we can see the successful list deletion message from the console.
  
  
  

Upon refreshing the earlier list page, we will get the list not found error, which indicates the deletion of the list.



Conclusion

Thus, we have seen how to work with the lists and perform List creation, fetching & updating of its properties and finally deletion of the created list, using REST API in SharePoint 2016.