SharePoint Dynamic CRUD Operations using Rest API

By -

SharePoint Dynamic CRUD Operations using Rest API



Use the below code for dynamic CRUD operations. You can create CRUD.js file using the below code & call the crud operations from different places by passing different parameters.


//<<<<<<<<<<<<<<<<<<<<<<<< NOTE - Follow the below instructions to call the CURD Functions >>>>>>>>>>>>>>>>>>>>>>>>>
    //-----------------createItem('ListName',['ColumnName1','ColumnName2',...],['Value1','Value2',...]);-------------
        //Example: createItem('testlist',['Title','Name','Age'],['ABC','XYZ',10]);
    
    //-----------------updateItem('ListName',itemID,['ColumnName1','ColumnName2',...],['Value1','Value2',...]);------
        //Example: updateItem('testlist',31,['Title','Name','Age'],['ABC','XYZ',10]);
    
    //-----------------deleteItem('ListName',itemID);----------------------------------------------------------------
        //Example: deleteItem('testlist',1);
    
    ///----------------(Using ID) => readSingleItem('ListName',itemID,filterQuery);---------------------------------
    ///Example:Use done property to get data values
        //var query = "?$select=Title,Name,Age";
        //var succ = readSingleItem('testlist',34,query);
        //succ.done(function(data){alert(data.d.Title)});
        
    //-------------------(filter by column values) => readMultipleItems('ListName',filterQuery);-------------------
    //Example:Use done property to get data values
        //var query = "?$select=Title,Name,Age&$filter=Title eq 'ABC'"
        //var succ = readMultipleItems('testlist',query);
        //succ.done(function(data){ if(data.d.results[0] != null){alert(data.d.results[0].Title);}  });
//<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< NOTE >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>



//---------------------------------------------------------------CREATE NEW ITEM Function----------------------------------------------------------
function createItem(listName,columnNames,Values)
{
    var deferred = $.Deferred();
    var serverURL = _spPageContextInfo.webAbsoluteUrl;
    var listUrl = String.format("{0}/_api/web/lists/GetByTitle('"+listName+"')/items",serverURL);
    
    getItemTypeForListName(listName).done(
                    function(ListItemEntityTypeFullName)                    
                    {   
var items = { '__metadata': {'type': ListItemEntityTypeFullName} }; //here it will bind metadata and below we are binding coulumn values
                        if(columnNames.length == Values.length)
                        {
                            for(var i=0;i<columnNames.length;i++)
                            {
                                items[columnNames[i]] = (Values[i] != '')? Values[i]:null;              
                            }
                        }
                        else
                        {
                            alert("Please Provide Equal number of ColumnNames & Values for Create Item function!");
                            return;
                        }

                        $.ajax({
                        url: listUrl,
                        type: "POST",
                        data: JSON.stringify(items),
                        headers: {
                         "Accept": "application/json;odata=verbose",
                         "content-type": "application/json; odata=verbose",
                         "X-RequestDigest": $("#__REQUESTDIGEST").val()
                         },
                        success: function(data){
                         //alert("Item added successfully!");
                         deferred.resolve();
                         },
                        error: function(err){
                                         alert('error '+ err);
                                         deferred.reject();
                         }
                        
                        });
                        
                    }).fail(function(error)
                        {
                            alert('error '+ err);
                            deferred.reject();
                        });
    return deferred.promise();
}

//---------------------------------------------------------------UPDATE ITEMS Function----------------------------------------------------------
function updateItem(listName,itemID,columnNames,Values)
{
    var deferred = $.Deferred();
    var serverURL = _spPageContextInfo.webAbsoluteUrl;
    var listUrl = String.format("{0}/_api/web/lists/GetByTitle('"+listName+"')/getItemByStringId("+itemID+")",serverURL);
    
    getItemTypeForListName(listName).done(
                    function(ListItemEntityTypeFullName)                    
                    {   
var items = { '__metadata': {'type': ListItemEntityTypeFullName} }; //here it will bind metadata and below we are binding coulumn values
                        if(columnNames.length == Values.length)
                        {
                            for(var i=0;i<columnNames.length;i++)
                            {
                                items[columnNames[i]] = (Values[i] != '')? Values[i]:null;              
                            }
                        }
                        else
                        {
                            alert("Please Provide Equal number of ColumnNames & Values for Update Item function!");
                            return;
                        }

                        $.ajax({
                        url: listUrl,
                        type: "POST",
                        data: JSON.stringify(items),
                        headers: {
                                    "Content-Type": "application/json;odata=verbose",
                                    "Accept": "application/json;odata=verbose",
                                    "X-RequestDigest": $("#__REQUESTDIGEST").val(),
                                    "X-Http-Method": "PATCH",
                                    "IF-MATCH": "*"
                             },
                        success: function(data){
                         //alert("Data Added Successfully!");
                         deferred.resolve();
                         },
                        error: function(err){
                                         alert('error '+ err);
                                         deferred.reject();
                         }
                        
                        });
                        
                    }).fail(function(error)
                        {
                            alert('error '+ err);
                            deferred.reject();
                        });
    return deferred.promise();
}

//---------------------------------------------------------------READ ITEMS Function----------------------------------------------------------
function readSingleItem(listName,itemID,query)
{
    var deferred = $.Deferred();
    var serverUrl = _spPageContextInfo.webAbsoluteUrl;
    //var filterValue = "YourFilterValue";
    var listURL = String.format("{0}/_api/web/lists/getbytitle('"+listName+"')/getItemByStringId("+itemID+")"+query,serverUrl);
    $.ajax({
url: listURL,
type: "GET",
headers: {"Accept": "application/json;odata=verbose"},
cache: false,
success: function(data){
                deferred.resolve(data);
},
error: function(err){
             alert('error '+ err);
             deferred.reject();
}
    });
    return deferred.promise();
}
//---------------------------------------------------------------READ ITEMS Function----------------------------------------------------------
function readMultipleItems(listName,query)
{
    var deferred = $.Deferred();
    var serverUrl = _spPageContextInfo.webAbsoluteUrl;
    //var filterValue = "YourFilterValue";
    var listURL = String.format("{0}/_api/web/lists/getbytitle('"+listName+"')/items"+query,serverUrl);
    
    $.ajax({
url: listURL,
type: "GET",
headers: {"Accept": "application/json;odata=verbose"},
cache: false,
success: function(data){
                deferred.resolve(data);
},
error: function(err){
             alert('error '+ err);
             deferred.reject();
}
    });
    return deferred.promise();
}

//---------------------------------------------------------------DELETE ITEM Function----------------------------------------------------------
function deleteItem(listName,itemID)
{
    var deferred = $.Deferred();
    if((itemID != null) && (itemID !=''))
    {
        //alert('Your are going to delete this ID : '+ itemID);
        
        //code for delete record
        var serverURL = _spPageContextInfo.webAbsoluteUrl;
var listUrl = String.format("{0}/_api/web/lists/GetByTitle('"+listName+"')/items("+itemID+")",serverURL);
$.ajax({
url: listUrl,
type: "POST",
headers: {
"Accept": "application/json;odata=verbose",
"content-type": "application/json; odata=verbose",
"X-RequestDigest": $("#__REQUESTDIGEST").val(),
"X-HTTP-Method": "DELETE",
"If-Match": "*"
},
success: function(data){
//alert("Item deleted successfully!");
deferred.resolve();
},
error: function(err){
                         alert('error '+ err);
                         deferred.reject();
}

    });
    }
    return deferred.promise();
}





//--------------Other Supporting funcitons for CURD Start----------------------
//below 2 functions used for getting ListItemEntityTypeFullName that is used in metta data
function getItemTypeForListName(listTitle)
{
return executeJson({
url: _spPageContextInfo.webAbsoluteUrl + "/_api/web/lists/getbytitle('" + listTitle + "')/?$select=ListItemEntityTypeFullName",
method: 'GET'
}).then(function(data){return data.d.ListItemEntityTypeFullName;});
}

function executeJson(options)
{
var headers = options.headers || {};
headers["Accept"] = "application/json;odata=verbose";
if(options.method == "POST") {
headers["X-RequestDigest"] = $("#__REQUESTDIGEST").val();
}

var ajaxOptions =
{
url: options.url,
type: options.method,
contentType: "application/json;odata=verbose",
headers: headers
};
if(options.method == "POST") {
ajaxOptions.data = JSON.stringify(options.payload);
}

return $.ajax(ajaxOptions);
}
//--------------Other Supporting funcitons for CURD End----------------------

Comments

Post a Comment

Popular posts from this blog

Upload Single/Multiple file by using the REST API and jQuery SharePoint 2013

By -
Image
Upload  Single/Multiple  file by using the REST API and jQuery SharePoint 2013 Here you can find how to upload single/multiple file in SharePoint 2013 Library using Rest API. We can use the Content Editor web part to call the script files. Include Script files in Content Editor: Go to content editor -> Edit Source -> enter the code like below (code for including the script files) For 'jquery.min.js' we can either use direct link from online or we can download to our SharePoint library & We can use that. <script src=" https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js" ></script> OR use the below code <script src="/ sites/<SiteName>/<Subsite>/SiteAssets/jquery-1.11.1.min.j s"></script> <script src="/ sites/ <SiteName>/<Subsite> /SiteAssets/taskpage.js " type="text/javascript"></script> <script src=" /sites/ <SiteName>/<Subs
Read more

A type named 'SP.Data. could not be resolved by the model error

By -
Image
When we are trying to update task list we will get this error " A type named 'SP.Data. could not be resolved by the model error. When a model is available, each type name must resolve to a valid name must resolve to a a valid type" This happens because there is a space in the list name. To resolve this issue we need to get the exact list name to be used in "SP.Data" 1.Use the below URL in chrome browser <SiteUrl>/_api/web/lists/GetByTitle('List Name')/ For Example:  https://SiteURL/_api/web/lists/GetByTitle('Workflow Tasks')/ Some times in Chrome browser you may get Authentication error. For that first open the list from your Chrome browser & then use the above URL. 2.Find "SP.Data" -> now you will get the list name that you can be used in SP.Data.ListNameListitem
Read more

Add content type to SharePoint List/Library using REST API

By -
Add content type to SharePoint List/Library using REST API Use this below code to add content type to SharePoint Library using REST API. For this you need to use the content type ID. Below function will get the content type ID from content type name & we will pass the content type id to next function which will update content type to list/library. var   varContentTypeName = " Your Content Type name "; var   Listname = " Your List name where you want to add content type "; //This will get the content type ID from content type Name function  getContentTypeID() { var deferred = $.Deferred();     var  isCurrentUserIsApprover = false ; var  serverURL = _spPageContextInfo.webAbsoluteUrl; var  listURL = String.format(" {0}/_api/web/AvailableContentTypes?$select=Name,Id,StringId&$filter=Name eq '"+varContentTypeName+"' ",serverURL); $.ajax({ url: listURL, type: " GET ", async: false, headers:
Read more